diff --git a/doc/administration/configure.md b/doc/administration/configure.md index 40f03d25e8d3190102900471d7fbacc9dc370441..181dd4753d66e3f82753e2a73153619eb95ebfdb 100644 --- a/doc/administration/configure.md +++ b/doc/administration/configure.md @@ -30,7 +30,7 @@ The tables lists features on the left and provides their capabilities to the rig ## Geo Capabilities -If your availability needs to span multiple zones or multiple locations, please read about [Geo](geo/index.md). +If your availability needs to span multiple zones or multiple locations, read about [Geo](geo/index.md). | | Availability | Recoverability | Data Resiliency | Performance | Risks/Trade-offs| |-|--------------|----------------|-----------------|-------------|-----------------| diff --git a/doc/administration/geo/disaster_recovery/planned_failover.md b/doc/administration/geo/disaster_recovery/planned_failover.md index 60101f5af8e03cf956f980ec85fb2508dbd71d34..08b1a15522d00e95665a9f318760763e85a0f3ea 100644 --- a/doc/administration/geo/disaster_recovery/planned_failover.md +++ b/doc/administration/geo/disaster_recovery/planned_failover.md @@ -19,7 +19,7 @@ length of this window is determined by your replication capacity - once the data loss. This document assumes you already have a fully configured, working Geo setup. -Please read it and the [Disaster Recovery](index.md) failover +Read this document and the [Disaster Recovery](index.md) failover documentation in full before proceeding. Planned failover is a major operation, and if performed incorrectly, there is a high risk of data loss. Consider rehearsing the procedure until you are comfortable with the necessary steps and diff --git a/doc/administration/gitaly/index.md b/doc/administration/gitaly/index.md index 9644723911630a3f8e20e555211d137d129de77d..a1c381cabdef18816b2f49ce0468c4a8fe989e85 100644 --- a/doc/administration/gitaly/index.md +++ b/doc/administration/gitaly/index.md @@ -45,7 +45,7 @@ repository storage is either: ## Before deploying Gitaly Cluster Gitaly Cluster provides the benefits of fault tolerance, but comes with additional complexity of setup and management. -Before deploying Gitaly Cluster, please review: +Before deploying Gitaly Cluster, review: - Existing [known issues](#known-issues). - [Snapshot limitations](#snapshot-backup-and-recovery-limitations). @@ -66,7 +66,7 @@ Contact your Technical Account Manager or customer support if you have any quest ### Known issues The following table outlines current known issues impacting the use of Gitaly Cluster. For -the current status of these issues, please refer to the referenced issues and epics. +the current status of these issues, refer to the referenced issues and epics. | Issue | Summary | How to avoid | |:--------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------| @@ -83,11 +83,11 @@ during a restore, we recommend using the [official backup and restore Rake tasks The [incremental backup method](../../raketasks/backup_gitlab.md#incremental-repository-backups) can be used to speed up Gitaly Cluster backups. -If you are unable to use either method, please contact customer support for restoration help. +If you are unable to use either method, contact customer support for restoration help. ### What to do if you are on Gitaly Cluster experiencing an issue or limitation -Please contact customer support for immediate help in restoration or recovery. +Contact customer support for immediate help in restoration or recovery. ## Directly accessing repositories @@ -410,7 +410,7 @@ relative path of the repository in the metadata store. ### Moving beyond NFS Engineering support for NFS for Git repositories is deprecated. Technical support is planned to be unavailable starting -November 22, 2022. Please see our [statement of support](https://about.gitlab.com/support/statement-of-support/#gitaly-and-nfs) +November 22, 2022. See our [statement of support](https://about.gitlab.com/support/statement-of-support/#gitaly-and-nfs) for more details. [Network File System (NFS)](https://en.wikipedia.org/wiki/Network_File_System) @@ -718,4 +718,4 @@ The second facet presents the only real solution. For this, we developed ## NFS deprecation notice Engineering support for NFS for Git repositories is deprecated. Technical support is planned to be -unavailable beginning November 22, 2022. For further information, please see our [NFS Deprecation](../nfs.md#gitaly-and-nfs-deprecation) documentation. +unavailable beginning November 22, 2022. For further information, see our [NFS Deprecation](../nfs.md#gitaly-and-nfs-deprecation) documentation. diff --git a/doc/administration/gitaly/troubleshooting.md b/doc/administration/gitaly/troubleshooting.md index 1c5f0d438646cd8fb15281ac77c77a5fb22e742d..b8cbc9855c4e2839b6a38c68cec267185f278558 100644 --- a/doc/administration/gitaly/troubleshooting.md +++ b/doc/administration/gitaly/troubleshooting.md @@ -359,7 +359,7 @@ necessary because [this issue](https://gitlab.com/gitlab-org/gitaly/-/issues/252 If this error occurs even though file permissions are correct, it's likely that the Gitaly node is experiencing [clock drift](https://en.wikipedia.org/wiki/Clock_drift). -Please ensure that the GitLab and Gitaly nodes are synchronized and use an NTP time +Ensure that the GitLab and Gitaly nodes are synchronized and use an NTP time server to keep them synchronized if possible. ### Health check warnings diff --git a/doc/administration/monitoring/performance/grafana_configuration.md b/doc/administration/monitoring/performance/grafana_configuration.md index a003a3f25bc7242629dcd847ccdee8ae5a3ac776..49f92572cc545c26bc8e3f53ba59954bb541a007 100644 --- a/doc/administration/monitoring/performance/grafana_configuration.md +++ b/doc/administration/monitoring/performance/grafana_configuration.md @@ -141,7 +141,7 @@ These actions pose a temporary vulnerability while your old Grafana data is in u Deciding to take any of these actions should be weighed carefully with your need to access existing data and dashboards. -For more information and further mitigation details, please refer to our +For more information and further mitigation details, refer to our [blog post on the security release](https://about.gitlab.com/releases/2019/08/12/critical-security-release-gitlab-12-dot-1-dot-6-released/). Read more on: diff --git a/doc/administration/nfs.md b/doc/administration/nfs.md index a4acafd16da6e9f439ed298f6a954db7c493815c..b72bc57fd604bef5fb413fe932cda783de425985 100644 --- a/doc/administration/nfs.md +++ b/doc/administration/nfs.md @@ -52,7 +52,7 @@ If the issue is reproducible, or if it happens intermittently but regularly, Git NFS is not well-suited to a workload consisting of many small files, like Git repositories. NFS does provide a number of configuration options designed to improve performance. However, over time, a number of these mount options have proven to result in inconsistencies across multiple nodes mounting the NFS volume, up to and including data loss. Addressing these inconsistencies consume extraordinary development and support engineer time that hamper our ability to develop [Gitaly Cluster](gitaly/praefect.md), our purpose-built solution to addressing the deficiencies of NFS in this environment. -Please note that Gitaly Cluster provides highly-available Git repository storage. If this is not a requirement, single-node Gitaly backed by block storage is a suitable substitute. +Gitaly Cluster provides highly-available Git repository storage. If this is not a requirement, single-node Gitaly backed by block storage is a suitable substitute. Engineering support for NFS for Git repositories is deprecated. Technical support is planned to be unavailable from GitLab 15.0. No further enhancements are planned for this feature. diff --git a/doc/administration/package_information/defaults.md b/doc/administration/package_information/defaults.md index c6a33ed7ba970838e0e2fc1402bc21852ad32d62..381f35d7c1252b6691bfe3f0f121cc936f562117 100644 --- a/doc/administration/package_information/defaults.md +++ b/doc/administration/package_information/defaults.md @@ -68,7 +68,7 @@ over a network which will require, based on implementation, ports `111` and `2049` to be open. NOTE: -In some cases, the GitLab Registry will be automatically enabled by default. Please see [our documentation](../packages/container_registry.md) for more details +In some cases, the GitLab Registry will be automatically enabled by default. See [our documentation](../packages/container_registry.md) for more details. [^Consul-notes]: If using additional Consul functionality, more ports may need to be opened. See the [official documentation](https://www.consul.io/docs/install/ports#ports-table) for the list. diff --git a/doc/administration/package_information/signed_packages.md b/doc/administration/package_information/signed_packages.md index 34c8148e8074c095571041ba1a297803d1fd7a1f..e4566be75349a866923729e788eeec30d021416a 100644 --- a/doc/administration/package_information/signed_packages.md +++ b/doc/administration/package_information/signed_packages.md @@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Package Signatures **(FREE SELF)** -As of the release of GitLab 9.5 on August 22, 2017, GitLab provides signed Omnibus GitLab packages for RPM and DEB based distributions. This means that all packages provided on <https://packages.gitlab.com> are signed, starting with `9.5.0`, and all future versions of supported branches (for example `9.3.x` and `9.4.x` after August 22, 2017). Any package version prior to August 22, 2017, will not be signed. Please pass the appropriate argument to your package manager. (Example: `yum --nogpgcheck`) +As of the release of GitLab 9.5 on August 22, 2017, GitLab provides signed Omnibus GitLab packages for RPM and DEB based distributions. This means that all packages provided on <https://packages.gitlab.com> are signed, starting with `9.5.0`, and all future versions of supported branches (for example `9.3.x` and `9.4.x` after August 22, 2017). Any package version prior to August 22, 2017, will not be signed. Pass the appropriate argument to your package manager. (Example: `yum --nogpgcheck`) Omnibus GitLab packages produced by GitLab are created via the [Omnibus](https://github.com/chef/omnibus) tool, for which GitLab has added DEB signing via `debsigs` in [our own fork](https://gitlab.com/gitlab-org/omnibus). This addition, combined with the existing functionality of RPM signing, allows GitLab to provide signed packages for all supported distributions using DEB or RPM. diff --git a/doc/administration/postgresql/replication_and_failover.md b/doc/administration/postgresql/replication_and_failover.md index 0ee48047944d8dc22134fcbc4790922db699d272..ee90b120d0536439119b7b4ca9e95d6882c0642b 100644 --- a/doc/administration/postgresql/replication_and_failover.md +++ b/doc/administration/postgresql/replication_and_failover.md @@ -606,7 +606,7 @@ Here is a list and description of each machine and the assigned IP: - `10.6.0.33`: PostgreSQL 3 - `10.6.0.41`: GitLab application -All passwords are set to `toomanysecrets`. Please do not use this password or derived hashes and the `external_url` for GitLab is `http://gitlab.example.com`. +All passwords are set to `toomanysecrets`. Do not use this password or derived hashes and the `external_url` for GitLab is `http://gitlab.example.com`. After the initial configuration, if a failover occurs, the PostgresSQL leader node changes to one of the available secondaries until it is failed back. @@ -957,7 +957,7 @@ For further details, see [Patroni documentation on this subject](https://patroni ### Switching from repmgr to Patroni WARNING: -Switching from repmgr to Patroni is straightforward, the other way around is *not*. Rolling back from Patroni to repmgr can be complicated and may involve deletion of data directory. If you need to do that, please contact GitLab support. +Switching from repmgr to Patroni is straightforward, the other way around is *not*. Rolling back from Patroni to repmgr can be complicated and may involve deletion of data directory. If you need to do that, contact GitLab support. You can switch an exiting database cluster to use Patroni instead of repmgr with the following steps: diff --git a/doc/administration/redis/replication_and_failover.md b/doc/administration/redis/replication_and_failover.md index 1c2515099fe2cfc3fd2c123417405e046f6095d5..2ba19aa6f0a28b69a00db2306fba50927134fcfa 100644 --- a/doc/administration/redis/replication_and_failover.md +++ b/doc/administration/redis/replication_and_failover.md @@ -66,7 +66,7 @@ When a **Primary** fails to respond, it's the application's responsibility (in our case GitLab) to handle timeout and reconnect (querying a **Sentinel** for a new **Primary**). -To get a better understanding on how to correctly set up Sentinel, please read +To get a better understanding on how to correctly set up Sentinel, read the [Redis Sentinel](https://redis.io/docs/manual/sentinel/) documentation first, as failing to configure it correctly can lead to data loss or can bring your whole cluster down, invalidating the failover effort. @@ -350,7 +350,7 @@ Now that the Redis servers are all set up, let's configure the Sentinel servers. If you are not sure if your Redis servers are working and replicating -correctly, please read the [Troubleshooting Replication](troubleshooting.md#troubleshooting-redis-replication) +correctly, read the [Troubleshooting Replication](troubleshooting.md#troubleshooting-redis-replication) and fix it before proceeding with Sentinel setup. You must have at least `3` Redis Sentinel servers, and they need to diff --git a/doc/administration/redis/replication_and_failover_external.md b/doc/administration/redis/replication_and_failover_external.md index 7904fb1ded883a4a35afc8939103ebbec018c83a..23c9ce33c2d111ae0c72e636c7d249b68e42e9cb 100644 --- a/doc/administration/redis/replication_and_failover_external.md +++ b/doc/administration/redis/replication_and_failover_external.md @@ -64,7 +64,7 @@ settings outlined in We cannot stress enough the importance of reading the [replication and failover](replication_and_failover.md) documentation of the Omnibus Redis HA as it provides some invaluable information to the configuration -of Redis. Please proceed to read it before going forward with this guide. +of Redis. Read it before going forward with this guide. Before proceeding on setting up the new Redis instances, here are some requirements: diff --git a/doc/administration/system_hooks.md b/doc/administration/system_hooks.md index 56e73150616d22df49803b6e039c00c402be6696..7a36ff2e5bb908619998aefb92531b98343be125 100644 --- a/doc/administration/system_hooks.md +++ b/doc/administration/system_hooks.md @@ -136,7 +136,7 @@ X-Gitlab-Event: System Hook ``` Note that `project_rename` is not triggered if the namespace changes. -Please refer to `group_rename` and `user_rename` for that case. +Refer to `group_rename` and `user_rename` for that case. **Project transferred:** diff --git a/doc/administration/troubleshooting/test_environments.md b/doc/administration/troubleshooting/test_environments.md index a249d5bd1336a290f5430fa29eaabb885a25a11c..c4d191f8c0f0367b688a1b2a1d3f9f47dc6aff01 100644 --- a/doc/administration/troubleshooting/test_environments.md +++ b/doc/administration/troubleshooting/test_environments.md @@ -20,13 +20,13 @@ are only available internally at GitLab. ## Docker The following were tested on Docker containers running in the cloud. Support Engineers, -please see [these docs](https://gitlab.com/gitlab-com/dev-resources/tree/master/dev-resources#running-docker-containers) +see [these docs](https://gitlab.com/gitlab-com/dev-resources/tree/master/dev-resources#running-docker-containers) on how to run Docker containers on `dev-resources`. Other setups haven't been tested, but contributions are welcome. ### GitLab -Please see [our official Docker installation method](../../install/docker.md) +See [our official Docker installation method](../../install/docker.md) for how to run GitLab on Docker. ### SAML diff --git a/doc/api/deployments.md b/doc/api/deployments.md index 2c5161c44f51f2ab1dc9b3872a596ff3cf36549c..3984bfe0eeb0173b93ef533c081b7886132c48d9 100644 --- a/doc/api/deployments.md +++ b/doc/api/deployments.md @@ -503,8 +503,7 @@ Example responses: > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/35739) in GitLab 12.7. NOTE: -Not all deployments can be associated with merge requests. -Please see +Not all deployments can be associated with merge requests. See [Track what merge requests were deployed to an environment](../ci/environments/index.md#track-newly-included-merge-requests-per-deployment) for more information. diff --git a/doc/api/feature_flag_specs.md b/doc/api/feature_flag_specs.md index b549c790aaa7f5d78e491b8afdc63bf11fe55bf9..d34fd0718c3d1c4ced0779cc28117a4d5ad96c9a 100644 --- a/doc/api/feature_flag_specs.md +++ b/doc/api/feature_flag_specs.md @@ -9,4 +9,4 @@ info: To determine the technical writer assigned to the Stage/Group associated w > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/9566) in GitLab 12.5. This API was removed in [GitLab 14.0](https://gitlab.com/gitlab-org/gitlab/-/issues/213369). -Please use [the new API](feature_flags.md) instead. +Use [the new API](feature_flags.md) instead. diff --git a/doc/api/groups.md b/doc/api/groups.md index c1effc78a4d1b3b7cf56efac3f92bbd1778fcd0c..6e9bd5ada8f40cf54fc0c2429085e85ed66cc898 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -1413,7 +1413,7 @@ Parameters: ## Group members -Please consult the [Group Members](members.md) documentation. +See the [Group Members](members.md) documentation. ## LDAP Group Links