Merge branch 'integration-vale-substitution-fixes' into 'master'

Vale sub fixes, refactors

See merge request gitlab-org/gitlab!68885

doc/downgrade_ee_to_ce/index.md

@@ -6,10 +6,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w
 
 # Downgrading from EE to CE
 
-If you ever decide to downgrade your Enterprise Edition back to the Community
-Edition, there are a few steps you need take before installing the CE package
-on top of the current EE package, or, if you are in an installation from source,
-before you change remotes and fetch the latest CE code.
+If you ever decide to downgrade your Enterprise Edition back to the
+Community Edition, there are a few steps you need take beforehand. On Omnibus GitLab
+installations, these steps are made before installing the CE package on top of
+the current EE package. On installations from source, they are done before
+you change remotes and fetch the latest CE code.
 
 ## Disable Enterprise-only features
 
@@ -17,8 +18,8 @@ First thing to do is to disable the following features.
 
 ### Authentication mechanisms
 
-Kerberos and Atlassian Crowd are only available on the Enterprise Edition, so
-you should disable these mechanisms before downgrading and you should provide
+Kerberos and Atlassian Crowd are only available on the Enterprise Edition. You
+should disable these mechanisms before downgrading. Be sure to provide
 alternative authentication methods to your users.
 
 ### Remove Service Integration entries from the database
@@ -35,63 +36,63 @@ column if you didn't intend it to be used for storing the inheritance class or o
 use another column for that information.)
 ```
 
-All integrations are created automatically for every project you have, so in order
-to avoid getting this error, you need to remove all records with the type set to
+All integrations are created automatically for every project you have.
+To avoid getting this error, you must remove all records with the type set to
 `GithubService` from your database:
 
-**Omnibus Installation**
+- **Omnibus Installation**
 
-```shell
-sudo gitlab-rails runner "Integration.where(type: ['GithubService']).delete_all"
-```
+  ```shell
+  sudo gitlab-rails runner "Integration.where(type: ['GithubService']).delete_all"
+  ```
 
-**Source Installation**
+- **Source Installation**
 
-```shell
-bundle exec rails runner "Integration.where(type: ['GithubService']).delete_all" production
-```
+  ```shell
+  bundle exec rails runner "Integration.where(type: ['GithubService']).delete_all" production
+  ```
 
 NOTE:
-If you are running `GitLab =< v13.0` you need to also remove `JenkinsDeprecatedService` records
-and if you are running `GitLab =< v13.6` you need to also remove `JenkinsService` records.
+If you are running `GitLab =< v13.0` you must also remove `JenkinsDeprecatedService` records
+and if you are running `GitLab =< v13.6` you must remove `JenkinsService` records.
 
 ### Variables environment scopes
 
-If you're using this feature and there are variables sharing the same
-key, but they have different scopes in a project, then you might want to
-revisit the environment scope setting for those variables.
+In GitLab Community Edition, [environment scopes](../user/group/clusters/index.md#environment-scopes)
+are completely ignored, so if you are using this feature there may be some
+necessary adjustments to your configuration. This is especially true if
+configuration variables share the same key, but have different
+scopes in a project. In cases like these you could accidentally get a variable
+which you're not expecting for a particular environment. Make sure that you have
+the right variables in this case.
 
-In CE, environment scopes are completely ignored, therefore you could
-accidentally get a variable which you're not expecting for a particular
-environment. Make sure that you have the right variables in this case.
-
-Data is completely preserved, so you could always upgrade back to EE and
-restore the behavior if you leave it alone.
+Your data is completely preserved in the transition, so you could always upgrade
+back to EE and restore the behavior if you leave it alone.
 
 ## Downgrade to CE
 
 After performing the above mentioned steps, you are now ready to downgrade your
 GitLab installation to the Community Edition.
 
-**Omnibus Installation**
-
-To downgrade an Omnibus installation, it is sufficient to install the Community
-Edition package on top of the currently installed one. You can do this manually,
-by directly [downloading the package](https://packages.gitlab.com/gitlab/gitlab-ce)
-you need, or by adding our CE package repository and following the
-[CE installation instructions](https://about.gitlab.com/install/?version=ce).
-
-**Source Installation**
-
-To downgrade a source installation, you need to replace the current remote of
-your GitLab installation with the Community Edition's remote, fetch the latest
-changes, and checkout the latest stable branch:
-
-```shell
-git remote set-url origin git@gitlab.com:gitlab-org/gitlab-foss.git
-git fetch --all
-git checkout 8-x-stable
-```
+- **Omnibus Installation**
+
+  To downgrade an Omnibus installation, it is sufficient to install the Community
+  Edition package on top of the currently installed one. You can do this manually,
+  by directly [downloading the package](https://packages.gitlab.com/gitlab/gitlab-ce)
+  you need, or by adding our CE package repository and following the
+  [CE installation instructions](https://about.gitlab.com/install/?version=ce).
+
+- **Source Installation**
+
+  To downgrade a source installation, you must replace the current remote of
+  your GitLab installation with the Community Edition's remote. After that, you
+  can fetch the latest changes, and checkout the latest stable branch:
+  
+  ```shell
+  git remote set-url origin git@gitlab.com:gitlab-org/gitlab-foss.git
+  git fetch --all
+  git checkout 8-x-stable
+  ```
 
 Remember to follow the correct [update guides](../update/index.md) to make
 sure all dependencies are up to date.

doc/integration/auth0.md

@@ -9,8 +9,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w
 To enable the Auth0 OmniAuth provider, you must create an Auth0 account, and an
 application.
 
-1. Sign in to the [Auth0 Console](https://auth0.com/auth/login). If you need to
-   create an account, you can do so at the same link.
+1. Sign in to the [Auth0 Console](https://auth0.com/auth/login). You can also
+   create an account using the same link.
 
 1. Select **New App/API**.
 

doc/integration/cas.md

@@ -6,7 +6,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w
 
 # CAS OmniAuth Provider **(FREE)**
 
-To enable the CAS OmniAuth provider you must register your application with your CAS instance. This requires the service URL GitLab supplies to CAS. It should be something like: `https://gitlab.example.com:443/users/auth/cas3/callback?url`. By default handling for SLO is enabled, you only need to configure CAS for back-channel logout.
+To enable the CAS OmniAuth provider you must register your application with your
+CAS instance. This requires the service URL GitLab supplies to CAS. It should be
+something like: `https://gitlab.example.com:443/users/auth/cas3/callback?url`.
+Handling for Single Logout (SLO) is enabled by default, so you only have to
+configure CAS for back-channel logout.
 
 1. On your GitLab server, open the configuration file.
 

doc/integration/facebook.md

@@ -4,9 +4,10 @@ group: Integrations
 info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
 ---
 
-# Facebook OAuth2 OmniAuth Provider **(FREE)**
+# Facebook OAuth 2.0 OmniAuth Provider **(FREE)**
 
-To enable the Facebook OmniAuth provider you must register your application with Facebook. Facebook generates an app ID and secret key for you to use.
+To enable the Facebook OmniAuth provider you must register your application with
+Facebook. Facebook generates an app ID and secret key for you to use.
 
 1. Sign in to the [Facebook Developer Platform](https://developers.facebook.com/).
 
@@ -14,8 +15,9 @@ To enable the Facebook OmniAuth provider you must register your application with
 
 1. Select the type "Website"
 
-1. Enter a name for your app. This can be anything. Consider something like "<Organization>'s GitLab" or "<Your Name>'s GitLab" or
-   something else descriptive.
+1. Enter a name for your app. This can be anything. Consider something like
+   "<Organization>'s GitLab" or "<Your Name>'s GitLab" or something
+   else descriptive.
 
 1. Choose "Create New Facebook App ID"
 
@@ -49,7 +51,8 @@ To enable the Facebook OmniAuth provider you must register your application with
 
 1. Choose "Show" next to the hidden "App Secret"
 
-1. You should now see an app key and app secret (see screenshot). Keep this page open as you continue configuration.
+1. You should now see an app key and app secret (see screenshot). Keep this page
+   open as you continue configuration.
 
    ![Facebook API Keys](img/facebook_api_keys.png)
 
@@ -101,4 +104,7 @@ To enable the Facebook OmniAuth provider you must register your application with
 1. [Reconfigure](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) or [restart GitLab](../administration/restart_gitlab.md#installations-from-source) for the changes to take effect if you
    installed GitLab via Omnibus or from source respectively.
 
-On the sign in page there should now be a Facebook icon below the regular sign in form. Click the icon to begin the authentication process. Facebook asks the user to sign in and authorize the GitLab application. If everything goes well the user is returned to GitLab and signed in.
+On the sign in page there should now be a Facebook icon below the regular sign
+in form. Click the icon to begin the authentication process. Facebook asks the
+user to sign in and authorize the GitLab application. If everything goes well
+the user is returned to GitLab and signed in.

doc/integration/gmail_action_buttons_for_gitlab.md

@@ -12,10 +12,11 @@ If correctly set up, emails that require an action are marked in Gmail.
 
 ![GMail actions button](img/gmail_action_buttons_for_gitlab.png)
 
-To get this functioning, you need to be registered with Google. For instructions, see
+To get this functioning, you must be registered with Google. For instructions, see
 [Register with Google](https://developers.google.com/gmail/markup/registering-with-google).
 
-This process has many steps. Make sure that you fulfill all requirements set by Google to avoid your application being rejected by Google.
+This process has many steps. Make sure that you fulfill all requirements set by
+Google to avoid your application being rejected by Google.
 
 In particular, note:
 

doc/integration/google.md

@@ -4,12 +4,12 @@ group: Integrations
 info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
 ---
 
-# Google OAuth2 OmniAuth Provider **(FREE)**
+# Google OAuth 2.0 OmniAuth Provider **(FREE)**
 
-To enable the Google OAuth2 OmniAuth provider you must register your application
+To enable the Google OAuth 2.0 OmniAuth provider you must register your application
 with Google. Google generates a client ID and secret key for you to use.
 
-## Enabling Google OAuth
+## Enable Google OAuth
 
 In Google's side:
 
@@ -47,7 +47,7 @@ In Google's side:
    - Cloud Resource Manager API
    - Cloud Billing API
 
-   To do so you need to:
+   To do so you should:
 
    1. Go to the [Google API Console](https://console.developers.google.com/apis/dashboard).
    1. Click on **ENABLE APIS AND SERVICES** button at the top of the page.
@@ -98,8 +98,8 @@ On your GitLab server:
 
 1. Change `YOUR_APP_ID` to the client ID from the Google Developer page
 1. Similarly, change `YOUR_APP_SECRET` to the client secret
-1. Make sure that you configure GitLab to use a fully-qualified domain name, as Google doesn't accept
-   raw IP addresses.
+1. Make sure that you configure GitLab to use a fully-qualified domain name, as
+   Google doesn't accept raw IP addresses.
 
    For Omnibus packages:
 
@@ -115,8 +115,10 @@ On your GitLab server:
    ```
 
 1. Save the configuration file.
-1. [Reconfigure](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) or [restart GitLab](../administration/restart_gitlab.md#installations-from-source) for the changes to take effect if you
-   installed GitLab via Omnibus or from source respectively.
+1. [Reconfigure](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure)
+   or [restart GitLab](../administration/restart_gitlab.md#installations-from-source) for
+   the changes to take effect if you installed GitLab via Omnibus or from source
+   respectively.
 
 On the sign in page there should now be a Google icon below the regular sign in
 form. Click the icon to begin the authentication process. Google asks the

doc/integration/jenkins_deprecated.md

@@ -40,7 +40,7 @@ In GitLab, perform the following steps.
 ### Read access to repository
 
 Jenkins needs read access to the GitLab repository. We already specified a
-private key to use in Jenkins, now we need to add a public one to the GitLab
+private key to use in Jenkins, now we must add a public one to the GitLab
 project. For that case we need a Deploy key. Read the documentation on
 [how to set up a Deploy key](../user/project/deploy_keys/index.md).
 
@@ -50,7 +50,8 @@ Now navigate to GitLab services page and activate Jenkins
 
 ![screen](img/jenkins_gitlab_service.png)
 
-Done! When you push to GitLab, it creates a build for Jenkins. You can view the merge request build status with a link to the Jenkins build.
+Done! When you push to GitLab, it creates a build for Jenkins. You can view the
+merge request build status with a link to the Jenkins build.
 
 ### Multi-project Configuration
 

doc/integration/jira/connect-app.md

@@ -73,10 +73,10 @@ self-managed GitLab instances with Jira Cloud, you can either:
 You can configure your Atlassian Cloud instance to allow you to install applications
 from outside the Marketplace, which allows you to install the application:
 
-1. Sign in to your Jira instance as a user with administrator permissions.
+1. Sign in to your Jira instance as a user with an Administrator role.
 1. Place your Jira instance into
    [development mode](https://developer.atlassian.com/cloud/jira/platform/getting-started-with-connect/#step-2--enable-development-mode).
-1. Sign in to your GitLab application as a user with [Administrator](../../user/permissions.md) permissions.
+1. Sign in to your GitLab application as a user with an [Administrator](../../user/permissions.md) role.
 1. Install the GitLab application from your self-managed GitLab instance, as
    described in the [Atlassian developer guides](https://developer.atlassian.com/cloud/jira/platform/getting-started-with-connect/#step-3--install-and-test-your-app):
    1. In your Jira instance, go to **Apps > Manage Apps** and click **Upload app**:
@@ -104,7 +104,7 @@ application.
 ### Create a Marketplace listing **(FREE SELF)**
 
 If you prefer to not use development mode on your Jira instance, you can create
-your own Marketplace listing for your instance, which enables your application
+your own Marketplace listing for your instance. This enables your application
 to be installed from the Atlassian Marketplace.
 
 For full instructions, review the Atlassian [guide to creating a marketplace listing](https://developer.atlassian.com/platform/marketplace/installing-cloud-apps/#creating-the-marketplace-listing). To create a
@@ -124,9 +124,12 @@ for details.
 NOTE:
 DVCS means distributed version control system.
 
-## Troubleshooting GitLab.com for Jira Cloud app
+## Troubleshoot GitLab.com for Jira Cloud app
 
-The GitLab.com for Jira Cloud app uses an iframe to add namespaces on the settings page. Some browsers block cross-site cookies, which can lead to a message saying that the user needs to log in on GitLab.com even though the user is already logged in.
+The GitLab.com for Jira Cloud app uses an iframe to add namespaces on the
+settings page. Some browsers block cross-site cookies, which can lead to a
+message saying that the user needs to log in on GitLab.com even though the user
+is already logged in.
 
 > "You need to sign in or sign up before continuing."
 

doc/integration/jira/dvcs.md

@@ -9,7 +9,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w
 Use the Jira DVCS (distributed version control system) connector if you self-host
 your Jira instance, and you want to sync information
 between GitLab and Jira. If you use Jira Cloud and GitLab.com, you should use the
-[GitLab.com for Jira Cloud app](connect-app.md) unless you specifically need the DVCS connector.
+[GitLab.com for Jira Cloud app](connect-app.md) unless you specifically need the
+DVCS connector.
 
 When you configure the Jira DVCS connector, make sure your GitLab and Jira instances
 are accessible.
@@ -61,14 +62,13 @@ you can still perform multiple actions in a single commit:
 
 ## Configure a GitLab application for DVCS
 
-We recommend you create and use a `jira` user in GitLab, and use the account only
-for integration work. A separate account ensures regular account maintenance does not affect
-your integration.
+We recommend you create and use a `jira` user in GitLab, and use the account
+only for integration work. A separate account ensures regular account
+maintenance does not affect your integration.
 
 1. In GitLab, [create a user](../../user/profile/account/create_accounts.md) for Jira to
    use to connect to GitLab. For Jira to access all projects,
-   a user with [administrator](../../user/permissions.md) permissions must
-   create the user with administrator permissions.
+   this user must have an [Administrator](../../user/permissions.md) role.
 1. Sign in as the `jira` user.
 1. In the top right corner, click the account's avatar, and select **Edit profile**.
 1. In the left sidebar, select **Applications**.
@@ -141,7 +141,7 @@ can refresh the data manually from the Jira interface:
    column, select the icon:
    ![Refresh GitLab information in Jira](img/jira_dev_panel_manual_refresh.png)
 
-## Troubleshooting your DVCS connection
+## Troubleshoot your DVCS connection
 
 Refer to the items in this section if you're having problems with your DVCS connector.
 
@@ -174,7 +174,8 @@ Error obtaining access token. Cannot access https://gitlab.example.com from Jira
   must have the appropriate certificate (such as your organization's
   root certificate) added to it .
 
-Refer to Atlassian's documentation and Atlassian Support for assistance setting up Jira correctly:
+Refer to Atlassian's documentation and Atlassian Support for assistance setting
+up Jira correctly:
 
 - [Add a certificate](https://confluence.atlassian.com/kb/how-to-import-a-public-ssl-certificate-into-a-jvm-867025849.html)
   to the trust store.
@@ -234,7 +235,7 @@ To resolve this issue:
 
 ### Fix synchronization issues
 
-If Jira displays incorrect information, such as deleted branches, you may need to
+If Jira displays incorrect information, such as deleted branches, you may have to
 resynchronize the information. To do so:
 
 1. In Jira, go to **Jira Administration > Applications > DVCS accounts**.

doc/integration/jira/jira_server_configuration.md

@@ -25,7 +25,7 @@ This process creates a user named `gitlab` and adds it to a new group named `git
 1. Create a new user account (`gitlab`) with write access to
    projects in Jira.
    - **Email address**: Jira requires a valid email address, and sends a verification
-     email, which you need to set up the password.
+     email, which is required to set up the password.
    - **Username**: Jira creates the username by using the email prefix. You can change
      this username later.
    - **Password**: You must create a password, because the GitLab integration doesn't