diff --git a/doc/administration/packages/container_registry.md b/doc/administration/packages/container_registry.md index f1f41e9b8b7d98562b9ffbe21824f62266fb9a6f..fd3cbb2ad05d007090ca911bb59fa8a689c64f8f 100644 --- a/doc/administration/packages/container_registry.md +++ b/doc/administration/packages/container_registry.md @@ -108,11 +108,12 @@ for the first time. ### Configure Container Registry under an existing GitLab domain -If the Registry is configured to use the existing GitLab domain, you can -expose the Registry on a port. This way you can reuse the existing GitLab TLS +If the Container Registry is configured to use the existing GitLab domain, you can +expose the Container Registry on a port. This way you can reuse the existing GitLab TLS certificate. -If the GitLab domain is `https://gitlab.example.com` and the port to the outside world is `5050` you need to configure the Registry: +If the GitLab domain is `https://gitlab.example.com` and the port to the outside world is `5050`, +to configure the Container Registry: - Edit `gitlab.rb` if you are using Omnibus GitLab. - Edit `gitlab.yml` if you installed GitLab from source. diff --git a/doc/administration/pages/source.md b/doc/administration/pages/source.md index 7027feadb59a3e5deab1e0664d4d040541e62c7d..b36b87f3b1d475a15400aaab325ec15af1546eb8 100644 --- a/doc/administration/pages/source.md +++ b/doc/administration/pages/source.md @@ -295,10 +295,9 @@ world. Custom domains are supported, but no TLS. external_http: 192.0.2.2:80 ``` -1. Edit `/etc/default/gitlab` and set `gitlab_pages_enabled` to `true` in - order to enable the pages daemon. In `gitlab_pages_options`, the - `-pages-domain` must match the `host` setting that you set above and - `-listen-http` must match the `external_http` setting: +1. To enable the daemon, edit `/etc/default/gitlab` and set `gitlab_pages_enabled` to `true`. + In `gitlab_pages_options`, the value for `-pages-domain` must match the `host` and `-listen-http` must match + the `external_http`: ```ini gitlab_pages_enabled=true diff --git a/doc/administration/redis/replication_and_failover_external.md b/doc/administration/redis/replication_and_failover_external.md index 16383db6c2a7259c2188a8c34854475a943f4f9e..98909dfc00120a5a5b4b2f6ced0de3def6af0cc3 100644 --- a/doc/administration/redis/replication_and_failover_external.md +++ b/doc/administration/redis/replication_and_failover_external.md @@ -250,8 +250,8 @@ unauthorized access from other machines, and block traffic from the outside ([Internet](https://gitlab.com/gitlab-org/gitlab-foss/uploads/c4cc8cd353604bd80315f9384035ff9e/The_Internet_IT_Crowd.png)). For this example, **Sentinel 1** is configured in the same machine as the -**Redis Primary**, **Sentinel 2** and **Sentinel 3** in the same machines as the -**Replica 1** and **Replica 2** respectively. +**Redis Primary**, **Sentinel 2** in the same machine as **Replica 1**, and +**Sentinel 3** in the same machine as **Replica 2**. Here is a list and description of each **machine** and the assigned **IP**: diff --git a/doc/api/branches.md b/doc/api/branches.md index 9518a8d50327b66779a691bda986a8e1c5eae68a..fa508292e5cd2053eb7c20c32030cc9769efb1d3 100644 --- a/doc/api/branches.md +++ b/doc/api/branches.md @@ -27,7 +27,7 @@ Parameters: | Attribute | Type | Required | Description | |:----------|:---------------|:---------|:------------| | `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) owned by the authenticated user.| -| `search` | string | no | Return list of branches containing the search string. You can use `^term` and `term$` to find branches that begin and end with `term` respectively. | +| `search` | string | no | Return list of branches containing the search string. You can use `^term` to find branches that begin with `term`, and `term$` to find branches that end with `term`. | | `regex` | string | no | Return list of branches with names matching a [re2](https://github.com/google/re2/wiki/Syntax) regular expression. | Example request: diff --git a/doc/api/members.md b/doc/api/members.md index 950289effd2bf7fff6068b813c888539eec83222..02fa4be3d64a9a90977c961e0d92e7a0e6f0a1c2 100644 --- a/doc/api/members.md +++ b/doc/api/members.md @@ -316,9 +316,8 @@ This API endpoint works on top-level groups only. It does not work on subgroups. This function takes [pagination](rest/index.md#pagination) parameters `page` and `per_page` to restrict the list of users. -[Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/262875) in GitLab 13.7, the `search` and -`sort` parameters allow you to search for billable group members by name and sort the results, -respectively. +[In GitLab 13.7 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/262875), use the `search` parameter +to search for billable group members by name and `sort` to sort the results. ```plaintext GET /groups/:id/billable_members diff --git a/doc/api/namespaces.md b/doc/api/namespaces.md index 25c26ee93393e2425e951be2df1f58fc3d80399a..15ce73fdbc3a5da18b5f1805bcec8262446455fb 100644 --- a/doc/api/namespaces.md +++ b/doc/api/namespaces.md @@ -9,8 +9,10 @@ info: To determine the technical writer assigned to the Stage/Group associated w Usernames and group names fall under a special category called [namespaces](../user/namespace/index.md). -For users and groups supported API calls see the [users](users.md) and -[groups](groups.md) documentation respectively. +You might also want to view documentation for: + +- [Users](users.md) +- [Groups](groups.md) [Pagination](rest/index.md#pagination) is used. diff --git a/doc/development/geo.md b/doc/development/geo.md index 710d0eec3b0071240d55b9e5e9895e61afb1a97e..5d09532afcb0b4e4f765c691423c9457f2c89dca 100644 --- a/doc/development/geo.md +++ b/doc/development/geo.md @@ -48,8 +48,8 @@ for new events and creates background jobs for each specific event type. For example when a repository is updated, the Geo **primary** site creates a Geo event with an associated repository updated event. The Geo Log Cursor daemon picks the event up and schedules a `Geo::ProjectSyncWorker` job which -uses the `Geo::RepositorySyncService` and `Geo::WikiSyncService` classes -to update the repository and the wiki respectively. +uses the `Geo::RepositorySyncService` to update the repository +and `Geo::WikiSyncService` classes to update the wiki. The Geo Log Cursor daemon can operate in High Availability mode automatically. The daemon tries to acquire a lock from time to time and once acquired, it diff --git a/doc/development/gitaly.md b/doc/development/gitaly.md index 408f3d5fa3c2656713d4724911b4000b21efb483..d2232d750b2d2a1d7cb3dc30453813e89fe1969c 100644 --- a/doc/development/gitaly.md +++ b/doc/development/gitaly.md @@ -168,7 +168,8 @@ can replace `tmp/tests/gitaly` with a symlink. This is much faster because it avoids a Gitaly re-install each time you run `rspec`. Make sure this directory contains the files `config.toml` and `praefect.config.toml`. -You can copy them from `config.toml.example` and `config.praefect.toml.example` respectively. +You can copy `config.toml` from `config.toml.example`, and `praefect.config.toml` +from `config.praefect.toml.example`. After copying, make sure to edit them so everything points to the correct paths. ```shell diff --git a/doc/development/integrations/secure.md b/doc/development/integrations/secure.md index bc0a490f555ccfca27e15e5c94510de93efb3817..55cc9ddb00631f72868c44770ad2196532d3a20f 100644 --- a/doc/development/integrations/secure.md +++ b/doc/development/integrations/secure.md @@ -198,7 +198,7 @@ SAST and Dependency Scanning scanners must scan the files in the project directo To be consistent with the official Container Scanning for GitLab, scanners must scan the Docker image whose name and tag are given by -`CI_APPLICATION_REPOSITORY` and `CI_APPLICATION_TAG`, respectively. If the `DOCKER_IMAGE` +`CI_APPLICATION_REPOSITORY` and `CI_APPLICATION_TAG`. If the `DOCKER_IMAGE` CI/CD variable is provided, then the `CI_APPLICATION_REPOSITORY` and `CI_APPLICATION_TAG` variables are ignored, and the image specified in the `DOCKER_IMAGE` variable is scanned instead. diff --git a/doc/development/testing_guide/end_to_end/resources.md b/doc/development/testing_guide/end_to_end/resources.md index f3e072ffa21d5f3d379c6fbdaa89db66967ec882..f9e136a86df7ae1a3ec1836545a196efa56e2fd5 100644 --- a/doc/development/testing_guide/end_to_end/resources.md +++ b/doc/development/testing_guide/end_to_end/resources.md @@ -249,7 +249,7 @@ end ``` The `populate` method iterates through its arguments and call each -attribute respectively. Here `populate(:brand)` has the same effect as +attribute. Here `populate(:brand)` has the same effect as just `brand`. Using the populate method makes the intention clearer. With this, it ensures we construct the data right after we create the diff --git a/doc/install/aws/manual_install_aws.md b/doc/install/aws/manual_install_aws.md index 70fd000a4a65dcf3815e64f20ade740c6436027c..bd81e0583b58b6c833571d350133ad4b0b5f8250 100644 --- a/doc/install/aws/manual_install_aws.md +++ b/doc/install/aws/manual_install_aws.md @@ -237,7 +237,7 @@ Next, we must associate the **public** subnets to the route table: We also must create two private route tables so that instances in each private subnet can reach the internet via the NAT gateway in the corresponding public subnet in the same availability zone. -1. Follow the same steps as above to create two private route tables. Name them `gitlab-private-a` and `gitlab-private-b` respectively. +1. Follow the same steps as above to create two private route tables. Name them `gitlab-private-a` and `gitlab-private-b`. 1. Next, add a new route to each of the private route tables where the destination is `0.0.0.0/0` and the target is one of the NAT gateways we created earlier. 1. Add the NAT gateway we created in `gitlab-public-10.0.0.0` as the target for the new route in the `gitlab-private-a` route table. 1. Similarly, add the NAT gateway in `gitlab-public-10.0.2.0` as the target for the new route in the `gitlab-private-b`. @@ -336,7 +336,13 @@ Now, it's time to create the database: 1. Select **Standard Create** for the database creation method. 1. Select **PostgreSQL** as the database engine and select the minimum PostgreSQL version as defined for your GitLab version in our [database requirements](../../install/requirements.md#postgresql-requirements). 1. Because this is a production server, let's choose **Production** from the **Templates** section. -1. Under **Settings**, set a DB instance identifier, a master username, and a master password. We use `gitlab-db-ha`, `gitlab`, and a very secure password respectively. Make a note of these as we need them later. +1. Under **Settings**, use: + - `gitlab-db-ha` for the DB instance identifier. + - `gitlab` for a master username. + - A very secure password for the master password. + + Make a note of these as we need them later. + 1. For the DB instance size, select **Standard classes** and select an instance size that meets your requirements from the dropdown list. We use a `db.m4.large` instance. 1. Under **Storage**, configure the following: 1. Select **Provisioned IOPS (SSD)** from the storage type dropdown list. Provisioned IOPS (SSD) storage is best suited for this use (though you can choose General Purpose (SSD) to reduce the costs). Read more about it at [Storage for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html). diff --git a/doc/install/installation.md b/doc/install/installation.md index 61147c1e2e4337dc0b323148dff0b91b54f183af..bb0bffd967a95236457956e177851965187219ee 100644 --- a/doc/install/installation.md +++ b/doc/install/installation.md @@ -868,7 +868,7 @@ sudo -u git -H bundle exec rake gitlab:setup RAILS_ENV=production force=yes # When done, you see 'Administrator account created:' ``` -You can set the Administrator/root password and email by supplying them in environmental variables, `GITLAB_ROOT_PASSWORD` and `GITLAB_ROOT_EMAIL` respectively, as seen below. If you don't set the password (and it is set to the default one), wait to expose GitLab to the public internet until the installation is done and you've logged into the server the first time. During the first login, you are forced to change the default password. An Enterprise Edition subscription may also be activated at this time by supplying the activation code in the `GITLAB_ACTIVATION_CODE` environment variable. +You can set the Administrator/root password and email by supplying them in environmental variables, `GITLAB_ROOT_PASSWORD` and `GITLAB_ROOT_EMAIL`, as seen below. If you don't set the password (and it is set to the default one), wait to expose GitLab to the public internet until the installation is done and you've logged into the server the first time. During the first login, you are forced to change the default password. An Enterprise Edition subscription may also be activated at this time by supplying the activation code in the `GITLAB_ACTIVATION_CODE` environment variable. ```shell sudo -u git -H bundle exec rake gitlab:setup RAILS_ENV=production GITLAB_ROOT_PASSWORD=yourpassword GITLAB_ROOT_EMAIL=youremail GITLAB_ACTIVATION_CODE=yourcode diff --git a/doc/operations/metrics/dashboards/panel_types.md b/doc/operations/metrics/dashboards/panel_types.md index 5d52691eed892ea070010935310f35ead19bc058..0ab78dc0228c556916ad4823007ebf08d4039f6e 100644 --- a/doc/operations/metrics/dashboards/panel_types.md +++ b/doc/operations/metrics/dashboards/panel_types.md @@ -53,7 +53,7 @@ Starting in [version 12.8](https://gitlab.com/gitlab-org/gitlab/-/issues/202696) To add an anomaly chart panel type to a dashboard, add a panel with *exactly* 3 metrics. -The first metric represents the current state, and the second and third metrics represent the upper and lower limit respectively: +The first metric represents the current state, and the second and third metrics represent the upper and lower limit: ```yaml dashboard: 'Dashboard Title' diff --git a/doc/topics/autodevops/stages.md b/doc/topics/autodevops/stages.md index aca8c99b180bd8e00ec647eb3cbccd34af3626de..af0ccc514de1b21757741dce6989e1a225d9b783 100644 --- a/doc/topics/autodevops/stages.md +++ b/doc/topics/autodevops/stages.md @@ -491,7 +491,7 @@ deletion). You can configure database initialization and migrations for PostgreSQL to run within the application pod by setting the project CI/CD variables `DB_INITIALIZE` and -`DB_MIGRATE` respectively. +`DB_MIGRATE`. If present, `DB_INITIALIZE` is run as a shell command within an application pod as a Helm post-install hook. As some applications can't run without a successful diff --git a/doc/user/project/releases/index.md b/doc/user/project/releases/index.md index f15a3299108a2ce305e387e5129a4575b9f10ce6..59155f6307520bce6eb0e20d493da8a8cb54c013 100644 --- a/doc/user/project/releases/index.md +++ b/doc/user/project/releases/index.md @@ -249,7 +249,7 @@ section, along with statistics about the issues in the milestones. Releases are also visible on the **Issues > Milestones** page, and when you select a milestone on this page. -Here is an example of milestones with no releases, one release, and two releases, respectively. +Here is an example of milestones with no releases, one release, and two releases.  diff --git a/doc/user/search/exact_code_search.md b/doc/user/search/exact_code_search.md index 674b2813985ffefd7c169b148d531285bc978cf6..469d91b519416d4e32450ddebeb707954366f6c1 100644 --- a/doc/user/search/exact_code_search.md +++ b/doc/user/search/exact_code_search.md @@ -7,7 +7,7 @@ type: reference # Exact Code Search **(PREMIUM)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/105049) in GitLab 15.9 [with a flag](../../administration/feature_flags.md) named `index_code_with_zoekt` and `search_code_with_zoekt` which enables indexing and searching respectively. Both are disabled by default. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/105049) in GitLab 15.9 [with a flag](../../administration/feature_flags.md) named `index_code_with_zoekt` for indexing and `search_code_with_zoekt` for searching. Both are disabled by default. WARNING: We are still actively making changes to the Exact Code Search feature. GitLab will dogfood it first, and roll it out only to specific customers on GitLab.com who request access to it. We will make an announcement when it's available for GitLab.com customers to tryout. You can follow our development progress by checking [the Exact Code Search feature roadmap](https://gitlab.com/groups/gitlab-org/-/epics/9404).