Commit 8ebaf883 authored by Craig Norris's avatar Craig Norris

Merge branch 'docs-external-link-fixes' into 'master'

External link fixes in docs

See merge request gitlab-org/gitlab!54599
parents 775aa92d d3b2aa82
...@@ -67,7 +67,7 @@ We have the following documentation to rapidly uplift your GitLab knowledge: ...@@ -67,7 +67,7 @@ We have the following documentation to rapidly uplift your GitLab knowledge:
| Topic | Description | | Topic | Description |
|:--------------------------------------------------------------------------------------------------|:------------| |:--------------------------------------------------------------------------------------------------|:------------|
| [GitLab basics guides](gitlab-basics/index.md) | Start working on the command line and with GitLab. | | [GitLab basics guides](gitlab-basics/index.md) | Start working on the command line and with GitLab. |
| [GitLab workflow overview](https://about.gitlab.com/blog/2016/10/25/gitlab-workflow-an-overview/) | Enhance your workflow with the best of GitLab Workflow. | | [GitLab workflow overview](https://about.gitlab.com/topics/version-control/what-is-gitlab-workflow/) | Enhance your workflow with the best of GitLab Workflow. |
| [Get started with GitLab CI/CD](ci/quick_start/index.md) | Quickly implement GitLab CI/CD. | | [Get started with GitLab CI/CD](ci/quick_start/index.md) | Quickly implement GitLab CI/CD. |
| [Auto DevOps](topics/autodevops/index.md) | Learn more about Auto DevOps in GitLab. | | [Auto DevOps](topics/autodevops/index.md) | Learn more about Auto DevOps in GitLab. |
| [GitLab Markdown](user/markdown.md) | Advanced formatting system (GitLab Flavored Markdown). | | [GitLab Markdown](user/markdown.md) | Advanced formatting system (GitLab Flavored Markdown). |
......
...@@ -146,7 +146,7 @@ sudo gitlab-ctl restart consul ...@@ -146,7 +146,7 @@ sudo gitlab-ctl restart consul
### Consul nodes unable to communicate ### Consul nodes unable to communicate
By default, Consul will attempt to By default, Consul will attempt to
[bind](https://www.consul.io/docs/agent/options.html#_bind) to `0.0.0.0`, but [bind](https://www.consul.io/docs/agent/options#_bind) to `0.0.0.0`, but
it will advertise the first private IP address on the node for other Consul nodes it will advertise the first private IP address on the node for other Consul nodes
to communicate with it. If the other nodes cannot communicate with a node on to communicate with it. If the other nodes cannot communicate with a node on
this address, then the cluster will have a failed status. this address, then the cluster will have a failed status.
......
...@@ -19,8 +19,8 @@ before/after the brackets. Also, some shells (for example, `zsh`) can interpret ...@@ -19,8 +19,8 @@ before/after the brackets. Also, some shells (for example, `zsh`) can interpret
## Caveats ## Caveats
If the GitHub [rate limit](https://docs.github.com/v3/#rate-limiting) is reached while importing, If the GitHub [rate limit](https://docs.github.com/en/rest/reference/rate-limit) is reached while
the importing process waits (`sleep()`) until it can continue importing. importing, the importing process waits (`sleep()`) until it can continue importing.
## Importing multiple projects ## Importing multiple projects
......
...@@ -22,7 +22,7 @@ cannot be used to authenticate with GitHub as an external CI/CD repository. ...@@ -22,7 +22,7 @@ cannot be used to authenticate with GitHub as an external CI/CD repository.
## Connect with Personal Access Token ## Connect with Personal Access Token
Personal access tokens can only be used to connect GitHub.com Personal access tokens can only be used to connect GitHub.com
repositories to GitLab, and the GitHub user must have the [owner role](https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/access-permissions-on-github). repositories to GitLab, and the GitHub user must have the [owner role](https://docs.github.com/en/github/getting-started-with-github/access-permissions-on-github).
To perform a one-off authorization with GitHub to grant GitLab access your To perform a one-off authorization with GitHub to grant GitLab access your
repositories: repositories:
......
...@@ -319,4 +319,4 @@ For a video walkthrough of this configuration process, see [Auto Deploy to EC2]( ...@@ -319,4 +319,4 @@ For a video walkthrough of this configuration process, see [Auto Deploy to EC2](
## Deploy to Google Cloud ## Deploy to Google Cloud
- [Deploying with GitLab on Google Cloud](https://about.gitlab.com/solutions/google-cloud-platform/) - [Deploying with GitLab on Google Cloud](https://about.gitlab.com/partners/technology-partners/google-cloud-platform/)
...@@ -872,4 +872,4 @@ If: ...@@ -872,4 +872,4 @@ If:
- This is the first time setting it up, carefully read - This is the first time setting it up, carefully read
[using Docker in Docker workflow](#use-the-docker-executor-with-the-docker-image-docker-in-docker). [using Docker in Docker workflow](#use-the-docker-executor-with-the-docker-image-docker-in-docker).
- You are upgrading from v18.09 or earlier, read our - You are upgrading from v18.09 or earlier, read our
[upgrade guide](https://about.gitlab.com/releases/2019/07/31/docker-in-docker-with-docker-19-dot-03/). [upgrade guide](https://about.gitlab.com/blog/2019/07/31/docker-in-docker-with-docker-19-dot-03/).
...@@ -1069,7 +1069,7 @@ Re-using variables defined inside `script` as part of the environment name doesn ...@@ -1069,7 +1069,7 @@ Re-using variables defined inside `script` as part of the environment name doesn
Below are some links you may find interesting: Below are some links you may find interesting:
- [The `.gitlab-ci.yml` definition of environments](../yaml/README.md#environment) - [The `.gitlab-ci.yml` definition of environments](../yaml/README.md#environment)
- [A blog post on Deployments & Environments](https://about.gitlab.com/blog/2016/08/26/ci-deployment-and-environments/) - [A blog post on Deployments & Environments](https://about.gitlab.com/blog/2021/02/05/ci-deployment-and-environments/)
- [Review Apps - Use dynamic environments to deploy your code for every branch](../review_apps/index.md) - [Review Apps - Use dynamic environments to deploy your code for every branch](../review_apps/index.md)
- [Deploy Boards for your applications running on Kubernetes](../../user/project/deploy_boards.md) - [Deploy Boards for your applications running on Kubernetes](../../user/project/deploy_boards.md)
......
...@@ -10,6 +10,7 @@ description: 'Confidence checking your entire app every time a new feature is ad ...@@ -10,6 +10,7 @@ description: 'Confidence checking your entire app every time a new feature is ad
--- ---
<!-- vale off --> <!-- vale off -->
<!-- Needs review for fixing the broken Webdriver links, which link to a deprecated version of Webdriver. -->
# End-to-end testing with GitLab CI/CD and WebdriverIO # End-to-end testing with GitLab CI/CD and WebdriverIO
...@@ -83,7 +84,7 @@ multiple tests, such as making sure you are logged in. ...@@ -83,7 +84,7 @@ multiple tests, such as making sure you are logged in.
The function `it` defines an individual test. The function `it` defines an individual test.
[The `browser` object](https://webdriver.io/guide/testrunner/browserobject.html) is WebdriverIO's [The `browser` object](https://webdriver.io/guide/testrunner/browserobject.html) is WebdriverIO's
special sauce. It provides most of [the WebdriverIO API methods](https://webdriver.io/api.html) that are the key to special sauce. It provides most of [the WebdriverIO API methods](https://webdriver.io/docs/api/) that are the key to
steering the browser. In this case, we can use steering the browser. In this case, we can use
[`browser.url`](https://webdriver.io/api/protocol/url.html) to visit `/page-that-does-not-exist` to [`browser.url`](https://webdriver.io/api/protocol/url.html) to visit `/page-that-does-not-exist` to
hit our 404 page. We can then use [`browser.getUrl`](https://webdriver.io/api/property/getUrl.html) hit our 404 page. We can then use [`browser.getUrl`](https://webdriver.io/api/property/getUrl.html)
......
...@@ -619,7 +619,7 @@ deploy_production: ...@@ -619,7 +619,7 @@ deploy_production:
- master - master
``` ```
You may also want to add another job for [staging environment](https://about.gitlab.com/blog/2016/08/26/ci-deployment-and-environments/), to final test your application before deploying to production. You may also want to add another job for [staging environment](https://about.gitlab.com/blog/2021/02/05/ci-deployment-and-environments/), to final test your application before deploying to production.
### Turn on GitLab CI/CD ### Turn on GitLab CI/CD
......
...@@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Kubernetes Agent user stories **(PREMIUM SELF)** # Kubernetes Agent user stories **(PREMIUM SELF)**
The [personas in action](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#user-personas) The [personas in action](https://about.gitlab.com/handbook/marketing/strategic-marketing/roles-personas/#user-personas)
for the Kubernetes Agent are: for the Kubernetes Agent are:
- [Sasha, the Software Developer](https://about.gitlab.com/handbook/marketing/strategic-marketing/roles-personas/#sasha-software-developer). - [Sasha, the Software Developer](https://about.gitlab.com/handbook/marketing/strategic-marketing/roles-personas/#sasha-software-developer).
......
...@@ -13,7 +13,7 @@ This document outlines the style guide for the GitLab [GraphQL API](../api/graph ...@@ -13,7 +13,7 @@ This document outlines the style guide for the GitLab [GraphQL API](../api/graph
<!-- vale gitlab.Spelling = NO --> <!-- vale gitlab.Spelling = NO -->
We use the [GraphQL Ruby gem](https://graphql-ruby.org/) written by [Robert Mosolgo](https://github.com/rmosolgo/). We use the [GraphQL Ruby gem](https://graphql-ruby.org/) written by [Robert Mosolgo](https://github.com/rmosolgo/).
<!-- vale gitlab.Spelling = YES --> <!-- vale gitlab.Spelling = YES -->
In addition, we have a subscription to [GraphQL Pro](https://www.graphql.pro). For details see [GraphQL Pro subscription](graphql_guide/graphql_pro.md). In addition, we have a subscription to [GraphQL Pro](https://graphql.pro/). For details see [GraphQL Pro subscription](graphql_guide/graphql_pro.md).
All GraphQL queries are directed to a single endpoint All GraphQL queries are directed to a single endpoint
([`app/controllers/graphql_controller.rb#execute`](https://gitlab.com/gitlab-org/gitlab/blob/master/app%2Fcontrollers%2Fgraphql_controller.rb)), ([`app/controllers/graphql_controller.rb#execute`](https://gitlab.com/gitlab-org/gitlab/blob/master/app%2Fcontrollers%2Fgraphql_controller.rb)),
......
...@@ -88,7 +88,7 @@ for example `Jobs/Deploy.gitlab-ci.yml`. ...@@ -88,7 +88,7 @@ for example `Jobs/Deploy.gitlab-ci.yml`.
You can make a new stable template by copying [the latest template](#latest-version) You can make a new stable template by copying [the latest template](#latest-version)
available in a major milestone release of GitLab like `13.0`. All breaking changes available in a major milestone release of GitLab like `13.0`. All breaking changes
must be announced in a blog post before the official release, for example must be announced in a blog post before the official release, for example
[GitLab.com is moving to 13.0, with narrow breaking changes](https://about.gitlab.com/releases/2020/05/06/gitlab-com-13-0-breaking-changes/) [GitLab.com is moving to 13.0, with narrow breaking changes](https://about.gitlab.com/blog/2020/05/06/gitlab-com-13-0-breaking-changes/)
You can change a stable template version in a minor GitLab release like `13.1` if: You can change a stable template version in a minor GitLab release like `13.1` if:
......
...@@ -181,7 +181,7 @@ For instance, the "DevOps Report" category is represented by the ...@@ -181,7 +181,7 @@ For instance, the "DevOps Report" category is represented by the
`devops_reports.name` value is "DevOps Reports". `devops_reports.name` value is "DevOps Reports".
If a category's label doesn't respect this naming convention, it should be specified If a category's label doesn't respect this naming convention, it should be specified
with [the `label` attribute](https://about.gitlab.com/handbook/marketing/website/#category-attributes) with [the `label` attribute](https://about.gitlab.com/handbook/marketing/inbound-marketing/digital-experience/website/#category-attributes)
in <https://gitlab.com/gitlab-com/www-gitlab-com/blob/master/data/categories.yml>. in <https://gitlab.com/gitlab-com/www-gitlab-com/blob/master/data/categories.yml>.
### Feature labels ### Feature labels
......
...@@ -206,7 +206,7 @@ If `GITLAB_TRACING` is not configured correctly, this issue is logged: ...@@ -206,7 +206,7 @@ If `GITLAB_TRACING` is not configured correctly, this issue is logged:
By default, GitLab ships with the Jaeger tracer, but other tracers can be included at compile time. By default, GitLab ships with the Jaeger tracer, but other tracers can be included at compile time.
Details of how this can be done are included in the [LabKit tracing Details of how this can be done are included in the [LabKit tracing
documentation](https://godoc.org/gitlab.com/gitlab-org/labkit/tracing). documentation](https://pkg.go.dev/gitlab.com/gitlab-org/labkit/tracing).
If no log messages about tracing are emitted, the `GITLAB_TRACING` environment variable is likely If no log messages about tracing are emitted, the `GITLAB_TRACING` environment variable is likely
not set. not set.
......
...@@ -202,9 +202,9 @@ code readability and test output. ...@@ -202,9 +202,9 @@ code readability and test output.
### Better output in tests ### Better output in tests
When comparing expected and actual values in tests, use When comparing expected and actual values in tests, use
[`testify/require.Equal`](https://godoc.org/github.com/stretchr/testify/require#Equal), [`testify/require.Equal`](https://pkg.go.dev/github.com/stretchr/testify/require#Equal),
[`testify/require.EqualError`](https://godoc.org/github.com/stretchr/testify/require#EqualError), [`testify/require.EqualError`](https://pkg.go.dev/github.com/stretchr/testify/require#EqualError),
[`testify/require.EqualValues`](https://godoc.org/github.com/stretchr/testify/require#EqualValues), [`testify/require.EqualValues`](https://pkg.go.dev/github.com/stretchr/testify/require#EqualValues),
and others to improve readability when comparing structs, errors, and others to improve readability when comparing structs, errors,
large portions of text, or JSON documents: large portions of text, or JSON documents:
...@@ -363,12 +363,12 @@ There are a few guidelines one should follow when using the ...@@ -363,12 +363,12 @@ There are a few guidelines one should follow when using the
[Logrus](https://github.com/sirupsen/logrus) package: [Logrus](https://github.com/sirupsen/logrus) package:
- When printing an error use - When printing an error use
[WithError](https://godoc.org/github.com/sirupsen/logrus#WithError). For [WithError](https://pkg.go.dev/github.com/sirupsen/logrus#WithError). For
example, `logrus.WithError(err).Error("Failed to do something")`. example, `logrus.WithError(err).Error("Failed to do something")`.
- Since we use [structured logging](#structured-json-logging) we can log - Since we use [structured logging](#structured-json-logging) we can log
fields in the context of that code path, such as the URI of the request using fields in the context of that code path, such as the URI of the request using
[`WithField`](https://godoc.org/github.com/sirupsen/logrus#WithField) or [`WithField`](https://pkg.go.dev/github.com/sirupsen/logrus#WithField) or
[`WithFields`](https://godoc.org/github.com/sirupsen/logrus#WithFields). For [`WithFields`](https://pkg.go.dev/github.com/sirupsen/logrus#WithFields). For
example, `logrus.WithField("file", "/app/go").Info("Opening dir")`. If you example, `logrus.WithField("file", "/app/go").Info("Opening dir")`. If you
have to log multiple keys, always use `WithFields` instead of calling have to log multiple keys, always use `WithFields` instead of calling
`WithField` more than once. `WithField` more than once.
...@@ -488,7 +488,7 @@ The following are some style guidelines that are specific to the Secure Team. ...@@ -488,7 +488,7 @@ The following are some style guidelines that are specific to the Secure Team.
### Code style and format ### Code style and format
Use `goimports -local gitlab.com/gitlab-org` before committing. Use `goimports -local gitlab.com/gitlab-org` before committing.
[`goimports`](https://godoc.org/golang.org/x/tools/cmd/goimports) [`goimports`](https://pkg.go.dev/golang.org/x/tools/cmd/goimports)
is a tool that automatically formats Go source code using is a tool that automatically formats Go source code using
[`Gofmt`](https://golang.org/cmd/gofmt/), in addition to formatting import lines, [`Gofmt`](https://golang.org/cmd/gofmt/), in addition to formatting import lines,
adding missing ones and removing unreferenced ones. adding missing ones and removing unreferenced ones.
......
...@@ -13,7 +13,7 @@ guidelines so you can build an integration that fits with the workflow GitLab ...@@ -13,7 +13,7 @@ guidelines so you can build an integration that fits with the workflow GitLab
users are already familiar with. users are already familiar with.
This page also provides resources for the technical work associated This page also provides resources for the technical work associated
with [onboarding as a partner](https://about.gitlab.com/partners/integrate/). with [onboarding as a partner](https://about.gitlab.com/partners/technology-partners/integrate/).
The steps below are a high-level view of what needs to be done to complete an The steps below are a high-level view of what needs to be done to complete an
integration as well as linking to more detailed resources for how to do so. integration as well as linking to more detailed resources for how to do so.
......
...@@ -426,7 +426,7 @@ We are using a custom mapping between source file to test files, maintained in t ...@@ -426,7 +426,7 @@ We are using a custom mapping between source file to test files, maintained in t
### PostgreSQL versions testing ### PostgreSQL versions testing
Even though [Omnibus defaults to PG12 for new installs and upgrades](https://docs.gitlab.com/omnibus/package-information/postgresql_versions.md), Even though [Omnibus defaults to PG12 for new installs and upgrades](https://docs.gitlab.com/omnibus/package-information/postgresql_versions.html),
our test suite is currently running against PG11, since GitLab.com still runs on PG11. our test suite is currently running against PG11, since GitLab.com still runs on PG11.
We do run our test suite against PG12 on nightly scheduled pipelines as well as upon specific We do run our test suite against PG12 on nightly scheduled pipelines as well as upon specific
......
...@@ -193,7 +193,7 @@ When it comes to querying DOM elements in your tests, it is best to uniquely and ...@@ -193,7 +193,7 @@ When it comes to querying DOM elements in your tests, it is best to uniquely and
the element. the element.
Preferentially, this is done by targeting what the user actually sees using [DOM Testing Library](https://testing-library.com/docs/dom-testing-library/intro/). Preferentially, this is done by targeting what the user actually sees using [DOM Testing Library](https://testing-library.com/docs/dom-testing-library/intro/).
When selecting by text it is best to use [`getByRole` or `findByRole`](https://testing-library.com/docs/dom-testing-library/api-queries/#byrole) When selecting by text it is best to use [`getByRole` or `findByRole`](https://testing-library.com/docs/queries/byrole)
as these enforce accessibility best practices as well. The examples below demonstrate the order of preference. as these enforce accessibility best practices as well. The examples below demonstrate the order of preference.
When writing Vue component unit tests, it can be wise to query children by component, so that the unit test can focus on comprehensive value coverage When writing Vue component unit tests, it can be wise to query children by component, so that the unit test can focus on comprehensive value coverage
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment