Commit b4dd141d authored by Craig Norris's avatar Craig Norris Committed by Nick Gaskill

Doc: Remove instances of "in order to" in docs

parent 2ac488ff
...@@ -84,8 +84,8 @@ must disable the **primary** node. ...@@ -84,8 +84,8 @@ must disable the **primary** node.
single recommendation. You may need to: single recommendation. You may need to:
- Reconfigure the load balancers. - Reconfigure the load balancers.
- Change DNS records (for example, point the primary DNS record to the **secondary** - Change DNS records (for example, point the primary DNS record to the
node in order to stop usage of the **primary** node). **secondary** node to stop usage of the **primary** node).
- Stop the virtual servers. - Stop the virtual servers.
- Block traffic through a firewall. - Block traffic through a firewall.
- Revoke object storage permissions from the **primary** node. - Revoke object storage permissions from the **primary** node.
......
...@@ -192,8 +192,8 @@ follow these steps to avoid unnecessary data loss: ...@@ -192,8 +192,8 @@ follow these steps to avoid unnecessary data loss:
this, we will avoid a single recommendation. You may need to: this, we will avoid a single recommendation. You may need to:
- Reconfigure the load balancers. - Reconfigure the load balancers.
- Change DNS records (for example, point the **primary** DNS record to the **secondary** - Change DNS records (for example, point the **primary** DNS record to the
node in order to stop usage of the **primary** node). **secondary** node to stop usage of the **primary** node).
- Stop the virtual servers. - Stop the virtual servers.
- Block traffic through a firewall. - Block traffic through a firewall.
- Revoke object storage permissions from the **primary** node. - Revoke object storage permissions from the **primary** node.
......
...@@ -29,7 +29,7 @@ anymore on these nodes. You can follow our docs to [remove your secondary Geo no ...@@ -29,7 +29,7 @@ anymore on these nodes. You can follow our docs to [remove your secondary Geo no
If the current node that you want to keep using is a secondary node, you need to first promote it to primary. If the current node that you want to keep using is a secondary node, you need to first promote it to primary.
You can use our steps on [how to promote a secondary node](../disaster_recovery/#step-3-promoting-a-secondary-node) You can use our steps on [how to promote a secondary node](../disaster_recovery/#step-3-promoting-a-secondary-node)
in order to do that. to do that.
## Remove the primary node from the UI ## Remove the primary node from the UI
......
...@@ -492,8 +492,8 @@ to start again from scratch, there are a few steps that can help you: ...@@ -492,8 +492,8 @@ to start again from scratch, there are a few steps that can help you:
gitlab-ctl start geo-postgresql gitlab-ctl start geo-postgresql
``` ```
Reconfigure in order to recreate the folders and make sure permissions and ownership Reconfigure to recreate the folders and make sure permissions and ownership
are correctly are correct:
```shell ```shell
gitlab-ctl reconfigure gitlab-ctl reconfigure
......
...@@ -447,8 +447,8 @@ Omnibus is the following: ...@@ -447,8 +447,8 @@ Omnibus is the following:
> **IMPORTANT**: > **IMPORTANT**:
With GitLab 9.0, the PostgreSQL version is updated to 9.6 and manual steps are With GitLab 9.0, the PostgreSQL version is updated to 9.6 and manual steps are
required in order to update the **secondary** nodes and keep the Streaming required to update the **secondary** nodes and keep the Streaming Replication
Replication working. Downtime is required, so plan ahead. working. Downtime is required, so plan ahead.
The following steps apply only if you update from a 8.17 GitLab version to The following steps apply only if you update from a 8.17 GitLab version to
9.0+. For previous versions, update to GitLab 8.17 first before attempting to 9.0+. For previous versions, update to GitLab 8.17 first before attempting to
......
...@@ -17,9 +17,10 @@ NOTE: **Note:** ...@@ -17,9 +17,10 @@ NOTE: **Note:**
The stages of the setup process must be completed in the documented order. The stages of the setup process must be completed in the documented order.
Before attempting the steps in this stage, [complete all prior stages](../setup/index.md#using-omnibus-gitlab). Before attempting the steps in this stage, [complete all prior stages](../setup/index.md#using-omnibus-gitlab).
This document describes the minimal steps you have to take in order to This document describes the minimal steps you have to take to replicate your
replicate your **primary** GitLab database to a **secondary** node's database. You may **primary** GitLab database to a **secondary** node's database. You may have to
have to change some values according to your database setup, how big it is, etc. change some values, based on attributes including your database's setup and
size.
You are encouraged to first read through all the steps before executing them You are encouraged to first read through all the steps before executing them
in your testing/production environment. in your testing/production environment.
......
...@@ -90,7 +90,7 @@ When running Gitaly on its own server, note the following regarding GitLab versi ...@@ -90,7 +90,7 @@ When running Gitaly on its own server, note the following regarding GitLab versi
leveraged for redundancy on block-level Git data, but only has to be mounted on the Gitaly leveraged for redundancy on block-level Git data, but only has to be mounted on the Gitaly
servers. servers.
- From GitLab 11.8 to 12.2, it is possible to use Elasticsearch in a Gitaly setup that doesn't use - From GitLab 11.8 to 12.2, it is possible to use Elasticsearch in a Gitaly setup that doesn't use
NFS. In order to use Elasticsearch in these versions, the NFS. To use Elasticsearch in these versions, the
[repository indexer](../../integration/elasticsearch.md#elasticsearch-repository-indexer) [repository indexer](../../integration/elasticsearch.md#elasticsearch-repository-indexer)
must be enabled in your GitLab configuration. must be enabled in your GitLab configuration.
- [Since GitLab 12.3](https://gitlab.com/gitlab-org/gitlab/-/issues/6481), the new indexer is - [Since GitLab 12.3](https://gitlab.com/gitlab-org/gitlab/-/issues/6481), the new indexer is
......
...@@ -138,8 +138,8 @@ Most of the time we use `git cat-file --batch` processes for that. For ...@@ -138,8 +138,8 @@ Most of the time we use `git cat-file --batch` processes for that. For
better performance, Gitaly can re-use these `git cat-file` processes better performance, Gitaly can re-use these `git cat-file` processes
across RPC calls. Previously used processes are kept around in a across RPC calls. Previously used processes are kept around in a
["Git cat-file cache"](https://about.gitlab.com/blog/2019/07/08/git-performance-on-nfs/#enter-cat-file-cache). ["Git cat-file cache"](https://about.gitlab.com/blog/2019/07/08/git-performance-on-nfs/#enter-cat-file-cache).
In order to control how much system resources this uses, we have a maximum number To control how much system resources this uses, we have a maximum number of
of cat-file processes that can go into the cache. cat-file processes that can go into the cache.
The default limit is 100 `cat-file`s, which constitute a pair of The default limit is 100 `cat-file`s, which constitute a pair of
`git cat-file --batch` and `git cat-file --batch-check` processes. If `git cat-file --batch` and `git cat-file --batch-check` processes. If
......
...@@ -90,7 +90,7 @@ Be careful when choosing the domain used for receiving incoming email. ...@@ -90,7 +90,7 @@ Be careful when choosing the domain used for receiving incoming email.
For the sake of example, suppose your top-level company domain is `hooli.com`. For the sake of example, suppose your top-level company domain is `hooli.com`.
All employees in your company have an email address at that domain via Google All employees in your company have an email address at that domain via Google
Apps, and your company's private Slack instance requires a valid `@hooli.com` Apps, and your company's private Slack instance requires a valid `@hooli.com`
email address in order to sign up. email address to sign up.
If you also host a public-facing GitLab instance at `hooli.com` and set your If you also host a public-facing GitLab instance at `hooli.com` and set your
incoming email domain to `hooli.com`, an attacker could abuse the "Create new incoming email domain to `hooli.com`, an attacker could abuse the "Create new
......
...@@ -52,7 +52,9 @@ Learn how to install, configure, update, and maintain your GitLab instance. ...@@ -52,7 +52,9 @@ Learn how to install, configure, update, and maintain your GitLab instance.
- [GitLab Pages configuration](pages/index.md): Enable and configure GitLab Pages. - [GitLab Pages configuration](pages/index.md): Enable and configure GitLab Pages.
- [GitLab Pages configuration for GitLab source installations](pages/source.md): Enable and configure GitLab Pages on [source installations](../install/installation.md#installation-from-source). - [GitLab Pages configuration for GitLab source installations](pages/source.md): Enable and configure GitLab Pages on [source installations](../install/installation.md#installation-from-source).
- [Uploads administration](uploads.md): Configure GitLab uploads storage. - [Uploads administration](uploads.md): Configure GitLab uploads storage.
- [Environment variables](environment_variables.md): Supported environment variables that can be used to override their defaults values in order to configure GitLab. - [Environment variables](environment_variables.md): Supported environment
variables that can be used to override their default values to configure
GitLab.
- [Plugins](plugins.md): With custom plugins, GitLab administrators can introduce custom integrations without modifying GitLab's source code. - [Plugins](plugins.md): With custom plugins, GitLab administrators can introduce custom integrations without modifying GitLab's source code.
- [Enforcing Terms of Service](../user/admin_area/settings/terms.md) - [Enforcing Terms of Service](../user/admin_area/settings/terms.md)
- [Third party offers](../user/admin_area/settings/third_party_offers.md) - [Third party offers](../user/admin_area/settings/third_party_offers.md)
......
...@@ -321,7 +321,7 @@ _The uploads are stored by default in ...@@ -321,7 +321,7 @@ _The uploads are stored by default in
**In Omnibus installations:** **In Omnibus installations:**
In order to migrate back to local storage: To migrate back to local storage:
1. Set both `direct_upload` and `background_upload` to `false` in `gitlab.rb`, under the artifacts object storage settings. 1. Set both `direct_upload` and `background_upload` to `false` in `gitlab.rb`, under the artifacts object storage settings.
1. [Reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure). 1. [Reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure).
...@@ -424,10 +424,10 @@ generated by [GitLab Workhorse](https://gitlab.com/gitlab-org/gitlab-workhorse). ...@@ -424,10 +424,10 @@ generated by [GitLab Workhorse](https://gitlab.com/gitlab-org/gitlab-workhorse).
that are located in the artifacts archive itself. that are located in the artifacts archive itself.
The metadata file is in a binary format, with additional Gzip compression. The metadata file is in a binary format, with additional Gzip compression.
GitLab does not extract the artifacts archive in order to save space, memory GitLab doesn't extract the artifacts archive to save space, memory, and disk
and disk I/O. It instead inspects the metadata file which contains all the I/O. It instead inspects the metadata file which contains all the relevant
relevant information. This is especially important when there is a lot of information. This is especially important when there is a lot of artifacts, or
artifacts, or an archive is a very large file. an archive is a very large file.
When clicking on a specific file, [GitLab Workhorse](https://gitlab.com/gitlab-org/gitlab-workhorse) extracts it When clicking on a specific file, [GitLab Workhorse](https://gitlab.com/gitlab-org/gitlab-workhorse) extracts it
from the archive and the download begins. This implementation saves space, from the archive and the download begins. This implementation saves space,
......
...@@ -72,10 +72,9 @@ Then run `sudo gitlab-ctl reconfigure` for the changes to take effect. ...@@ -72,10 +72,9 @@ Then run `sudo gitlab-ctl reconfigure` for the changes to take effect.
missing images for user email addresses that are not found on the Libravatar missing images for user email addresses that are not found on the Libravatar
service. service.
In order to use a set other than `identicon`, replace the `&d=identicon` To use a set other than `identicon`, replace the `&d=identicon` portion of the
portion of the URL with another supported set. URL with another supported set. For example, you can use the `retro` set, in
For example, you can use the `retro` set, in which case the URL would look like: which case the URL would look like: `plain_url: "http://cdn.libravatar.org/avatar/%{hash}?s=%{size}&d=retro"`
`plain_url: "http://cdn.libravatar.org/avatar/%{hash}?s=%{size}&d=retro"`
## Usage examples for Microsoft Office 365 ## Usage examples for Microsoft Office 365
......
...@@ -9,17 +9,18 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -9,17 +9,18 @@ info: To determine the technical writer assigned to the Stage/Group associated w
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/32351) in GitLab 12.7, behind a disabled feature flag (`self_monitoring_project`). > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/32351) in GitLab 12.7, behind a disabled feature flag (`self_monitoring_project`).
> - The feature flag was removed and the Self Monitoring Project was [made generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/198511) in GitLab 12.8. > - The feature flag was removed and the Self Monitoring Project was [made generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/198511) in GitLab 12.8.
GitLab has been adding the ability for administrators to see insights into the health of GitLab has been adding the ability for administrators to see insights into the
their GitLab instance. In order to surface this experience in a native way, similar to how health of their GitLab instance. To surface this experience in a native way
you would interact with an application deployed via GitLab, a base project called (similar to how you would interact with an application deployed using GitLab),
"GitLab self monitoring" with a base project called "GitLab self monitoring" with
[internal visibility](../../../public_access/public_access.md#internal-projects) will be [internal visibility](../../../public_access/public_access.md#internal-projects)
added under a group called "GitLab Instance Administrators" specifically created for will be added under a group called "GitLab Instance Administrators"
visualizing and configuring the monitoring of your GitLab instance. specifically created for visualizing and configuring the monitoring of your
GitLab instance.
All administrators at the time of creation of the project and group will be added
as maintainers of the group and project, and as an admin, you'll be able to add new All administrators at the time of creation of the project and group will be
members to the group in order to give them maintainer access to the project. added as maintainers of the group and project, and as an admin, you'll be able
to add new members to the group to give them maintainer access to the project.
This project is used to self monitor your GitLab instance. The metrics dashboard This project is used to self monitor your GitLab instance. The metrics dashboard
of the project shows some basic resource usage charts, such as CPU and memory usage of the project shows some basic resource usage charts, such as CPU and memory usage
...@@ -74,7 +75,8 @@ you should ...@@ -74,7 +75,8 @@ you should
## Taking action on Prometheus alerts **(ULTIMATE)** ## Taking action on Prometheus alerts **(ULTIMATE)**
You can [add a webhook](../../../operations/metrics/alerts.md#external-prometheus-instances) You can [add a webhook](../../../operations/metrics/alerts.md#external-prometheus-instances)
to the Prometheus configuration in order for GitLab to receive notifications of any alerts. to the Prometheus configuration for GitLab to receive notifications of any
alerts.
Once the webhook is setup, you can Once the webhook is setup, you can
[take action on incoming alerts](../../../operations/metrics/alerts.md#trigger-actions-from-alerts). [take action on incoming alerts](../../../operations/metrics/alerts.md#trigger-actions-from-alerts).
......
...@@ -11,7 +11,7 @@ GitLab comes with its own application performance measuring system as of GitLab ...@@ -11,7 +11,7 @@ GitLab comes with its own application performance measuring system as of GitLab
Community and Enterprise editions. Community and Enterprise editions.
Apart from this introduction, you are advised to read through the following Apart from this introduction, you are advised to read through the following
documents in order to understand and properly configure GitLab Performance Monitoring: documents to understand and properly configure GitLab Performance Monitoring:
- [GitLab Configuration](gitlab_configuration.md) - [GitLab Configuration](gitlab_configuration.md)
- [Prometheus documentation](../prometheus/index.md) - [Prometheus documentation](../prometheus/index.md)
......
...@@ -75,8 +75,8 @@ extensions), which contain the following in a single encrypted file: ...@@ -75,8 +75,8 @@ extensions), which contain the following in a single encrypted file:
- Intermediate certificates (if any) - Intermediate certificates (if any)
- Private key - Private key
In order to export the required files in PEM encoding from the PKCS#12 file, To export the required files in PEM encoding from the PKCS#12 file, the
the `openssl` command can be used: `openssl` command can be used:
```shell ```shell
#-- Extract private key in PEM encoding (no password, unencrypted) #-- Extract private key in PEM encoding (no password, unencrypted)
......
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