Merge branch 'docs-note-style-2' into 'master'

Update more notes to use alert boxes

See merge request gitlab-org/gitlab!37298

doc/.vale/gitlab/AlertBoxStyle.yml

@@ -5,7 +5,7 @@
 #
 # For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
 extends: existence
-message: 'Alert box "%s" must use the formatting detailed in the documentation style guide.'
+message: 'Alert box "%s" must use the formatting in the style guide.'
 link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#alert-boxes
 level: error
 scope: raw
@@ -13,4 +13,4 @@ raw:
   - '((NOTE|TIP|CAUTION|DANGER): \*\*[^:]*\*\*)|'
   - '((NOTE: \*\*(NOTE|note):\*\*)|(TIP: \*\*(TIP|tip):\*\*)|(CAUTION: \*\*(CAUTION|caution):\*\*)|(DANGER: \*\*(DANGER|danger):\*\*))|'
   - '((NOTE|TIP|CAUTION|DANGER): \*\*.*\*\*.+)|'
-  - '((\n[ ]*(\*){1,2}(NOTE|Note|note|TIP|Tip|tip|CAUTION|Caution|caution|DANGER|Danger|danger):(\*){1,2})'
+  - '((\n[> ]*(\*){1,2}(NOTE|Note|note|TIP|Tip|tip|CAUTION|Caution|caution|DANGER|Danger|danger):(\*){1,2}))'

doc/administration/auth/okta.md

@@ -156,7 +156,7 @@ You might want to try this out on an incognito browser window.
 
 ## Configuring groups
 
->**Note:**
+NOTE: **Note:**
 Make sure the groups exist and are assigned to the Okta app.
 
 You can take a look of the [SAML documentation](../../integration/saml.md#saml-groups) on configuring groups.

doc/administration/git_annex.md

@@ -90,8 +90,8 @@ one is located in `config.yml` of GitLab Shell.
 
 ## Using GitLab git-annex
 
-> **Note:**
-> Your Git remotes must be using the SSH protocol, not HTTP(S).
+NOTE: **Note:**
+Your Git remotes must be using the SSH protocol, not HTTP(S).
 
 Here is an example workflow of uploading a very large file and then checking it
 into your Git repository:

doc/administration/issue_closing_pattern.md

 # Issue closing pattern **(CORE ONLY)**
 
->**Note:**
+NOTE: **Note:**
 This is the administration documentation. There is a separate [user documentation](../user/project/issues/managing_issues.md#closing-issues-automatically)
 on issue closing pattern.
 
@@ -16,7 +16,7 @@ is installed on.
 The default pattern can be located in [`gitlab.yml.example`](https://gitlab.com/gitlab-org/gitlab/blob/master/config/gitlab.yml.example)
 under the "Automatic issue closing" section.
 
-> **Tip:**
+TIP: **Tip:**
 You are advised to use <https://rubular.com> to test the issue closing pattern.
 Because Rubular doesn't understand `%{issue_ref}`, you can replace this by
 `#\d+` when testing your patterns, which matches only local issue references like `#123`.

doc/administration/monitoring/github_imports.md

@@ -6,8 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
 
 # Monitoring GitHub imports
 
->**Note:**
-Available since [GitLab 10.2](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/14731).
+> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/14731) in GitLab 10.2.
 
 The GitHub importer exposes various Prometheus metrics that you can use to
 monitor the health and progress of the importer.

doc/administration/monitoring/prometheus/index.md

@@ -227,7 +227,7 @@ To use an external Prometheus server:
 
 You can visit `http://localhost:9090` for the dashboard that Prometheus offers by default.
 
->**Note:**
+NOTE: **Note:**
 If SSL has been enabled on your GitLab instance, you may not be able to access
 Prometheus on the same browser as GitLab if using the same FQDN due to [HSTS](https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security). We plan to
 [provide access via GitLab](https://gitlab.com/gitlab-org/multi-user-prometheus), but in the interim there are

doc/administration/pages/source.md

@@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
 
 # GitLab Pages administration for source installations
 
->**Note:**
+NOTE: **Note:**
 Before attempting to enable GitLab Pages, first make sure you have
 [installed GitLab](../../install/installation.md) successfully.
 
@@ -77,7 +77,7 @@ host that GitLab runs. For example, an entry would look like this:
 where `example.io` is the domain under which GitLab Pages will be served
 and `192.0.2.1` is the IP address of your GitLab instance.
 
-> **Note:**
+NOTE: **Note:**
 You should not use the GitLab domain to serve user pages. For more information
 see the [security section](#security).
 
@@ -349,7 +349,7 @@ world. Custom domains and TLS are supported.
 
 ## NGINX caveats
 
->**Note:**
+NOTE: **Note:**
 The following information applies only for installations from source.
 
 Be extra careful when setting up the domain name in the NGINX configuration. You must

doc/administration/repository_storage_paths.md

@@ -89,7 +89,7 @@ This example uses NFS. We do not recommend using EFS for storage as it may impac
 
 1. [Restart GitLab](restart_gitlab.md#installations-from-source) for the changes to take effect.
 
->**Note:**
+NOTE: **Note:**
 The [`gitlab_shell: repos_path` entry](https://gitlab.com/gitlab-org/gitlab-foss/-/blob/8-9-stable/config/gitlab.yml.example#L457) in `gitlab.yml` will be
 deprecated and replaced by `repositories: storages` in the future, so if you
 are upgrading from a version prior to 8.10, make sure to add the configuration

doc/administration/smime_signing_email.md

@@ -3,7 +3,7 @@
 Notification emails sent by GitLab can be signed with S/MIME for improved
 security.
 
-> **Note:**
+NOTE: **Note:**
 Please be aware that S/MIME certificates and TLS/SSL certificates are not the
 same and are used for different purposes: TLS creates a secure channel, whereas
 S/MIME signs and/or encrypts the message itself

doc/administration/troubleshooting/sidekiq.md

@@ -7,16 +7,18 @@ may be filling up. Users will notice when this happens because new branches
 may not show up and merge requests may not be updated. The following are some
 troubleshooting steps that will help you diagnose the bottleneck.
 
-> **Note:** GitLab administrators/users should consider working through these
-> debug steps with GitLab Support so the backtraces can be analyzed by our team.
-> It may reveal a bug or necessary improvement in GitLab.
->
-> **Note:** In any of the backtraces, be wary of suspecting cases where every
-> thread appears to be waiting in the database, Redis, or waiting to acquire
-> a mutex. This **may** mean there's contention in the database, for example,
-> but look for one thread that is different than the rest. This other thread
-> may be using all available CPU, or have a Ruby Global Interpreter Lock,
-> preventing other threads from continuing.
+NOTE **Note:**
+GitLab administrators/users should consider working through these
+debug steps with GitLab Support so the backtraces can be analyzed by our team.
+It may reveal a bug or necessary improvement in GitLab.
+
+NOTE: **Note:**
+In any of the backtraces, be wary of suspecting cases where every
+thread appears to be waiting in the database, Redis, or waiting to acquire
+a mutex. This **may** mean there's contention in the database, for example,
+but look for one thread that is different than the rest. This other thread
+may be using all available CPU, or have a Ruby Global Interpreter Lock,
+preventing other threads from continuing.
 
 ## Log arguments to Sidekiq jobs
 

doc/api/access_requests.md

 # Group and project access requests API
 
- >**Note:** This feature was introduced in GitLab 8.11
+> Introduced in GitLab 8.11.
 
 ## Valid access levels
 

doc/api/admin_sidekiq_queues.md

 # Admin Sidekiq queues API
 
-> **Note:** This feature was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/25998) in GitLab 12.9
+> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/25998) in GitLab 12.9
 
 Delete jobs from a Sidekiq queue that match the given
 [metadata](../development/logging.md#logging-context-metadata-through-rails-or-grape-requests).

doc/api/epic_links.md

 # Epic Links API **(ULTIMATE)**
 
->**Note:**
-> This endpoint was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/9188) in GitLab 11.8.
+> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/9188) in GitLab 11.8.
 
 Manages parent-child [epic relationships](../user/group/epics/index.md#multi-level-child-epics-ultimate).
 

doc/api/events.md

@@ -255,7 +255,8 @@ Example response:
 
 ## List a Project's visible events
 
->**Note:** This endpoint has been around longer than the others. Documentation was formerly located in the [Projects API pages](projects.md).
+NOTE: **Note:**
+This endpoint has been around longer than the others. Documentation was formerly located in the [Projects API pages](projects.md).
 
 Get a list of visible events for a particular project.
 

doc/api/group_activity_analytics.md

 # Group Activity Analytics API
 
-> **Note:** This feature was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/26460) in GitLab 12.9.
+> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/26460) in GitLab 12.9.
 
 ## Get count of recently created issues for group
 

doc/api/merge_request_approvals.md

@@ -392,9 +392,11 @@ DELETE /projects/:id/approval_rules/:approval_rule_id
 
 ### Change allowed approvers
 
->**Note:** This API endpoint has been deprecated. Please use Approval Rule API instead.
 > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/183) in [GitLab Starter](https://about.gitlab.com/pricing/) 10.6.
 
+NOTE: **Note:**
+This API endpoint has been deprecated. Please use Approval Rule API instead.
+
 If you are allowed to, you can change approvers and approver groups using
 the following endpoint:
 
@@ -541,9 +543,11 @@ POST /projects/:id/merge_requests/:merge_request_iid/approvals
 
 ### Change allowed approvers for Merge Request
 
->**Note:** This API endpoint has been deprecated. Please use Approval Rule API instead.
 > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/183) in [GitLab Starter](https://about.gitlab.com/pricing/) 10.6.
 
+NOTE: **Note:**
+This API endpoint has been deprecated. Please use Approval Rule API instead.
+
 If you are allowed to, you can change approvers and approver groups using
 the following endpoint:
 

doc/api/projects.md

@@ -1258,7 +1258,7 @@ POST /projects/:id/fork
 
 ## List Forks of a project
 
->**Note:** This feature was introduced in GitLab 10.1
+> Introduced in GitLab 10.1.
 
 List the projects accessible to the calling user that have an established, forked relationship with the specified project
 

doc/api/protected_branches.md

 # Protected branches API
 
->**Note:** This feature was introduced in GitLab 9.5
+> Introduced in GitLab 9.5.
 
 **Valid access levels**
 

doc/api/protected_tags.md

 # Protected tags API
 
->**Note:** This feature was introduced in GitLab 11.3
+> Introduced in GitLab 11.3.
 
 **Valid access levels**
 

doc/api/services.md

 # Services API
 
->**Note:** This API requires an access token with Maintainer or Owner permissions
+NOTE: **Note:**
+This API requires an access token with Maintainer or Owner permissions
 
 ## List all active services
 
@@ -636,9 +637,9 @@ GET /projects/:id/services/github
 
 ## Hangouts Chat
 
-Google GSuite team collaboration tool.
+> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/20290) in GitLab 11.2.
 
->**Note:** This service was [introduced in v11.2](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/20290)
+Google GSuite team collaboration tool.
 
 ### Create/Edit Hangouts Chat service
 
@@ -648,7 +649,8 @@ Set Hangouts Chat service for a project.
 PUT /projects/:id/services/hangouts-chat
 ```
 
->**Note:** Specific event parameters (for example, `push_events` flag) were [introduced in v10.4](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/11435)
+NOTE: **Note:**
+Specific event parameters (for example, `push_events` flag) were [introduced in v10.4](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/11435)
 
 Parameters:
 
@@ -1151,7 +1153,8 @@ Set Slack service for a project.
 PUT /projects/:id/services/slack
 ```
 
->**Note:** Specific event parameters (for example, `push_events` flag and `push_channel`) were [introduced in v10.4](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/11435)
+NOTE: **Note:**
+Specific event parameters (for example, `push_events` flag and `push_channel`) were [introduced in v10.4](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/11435)
 
 Parameters:
 
@@ -1260,7 +1263,8 @@ Set Mattermost service for a project.
 PUT /projects/:id/services/mattermost
 ```
 
->**Note:** Specific event parameters (for example, `push_events` flag and `push_channel`) were [introduced in v10.4](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/11435)
+NOTE: **Note:**
+Specific event parameters (for example, `push_events` flag and `push_channel`) were [introduced in v10.4](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/11435)
 
 Parameters:
 

doc/api/sidekiq_metrics.md

 # Sidekiq Metrics API
 
->**Note:** This endpoint is only available on GitLab 8.9 and above.
+> Introduced in GitLab 8.9.
 
 This API endpoint allows you to retrieve some information about the current state
 of Sidekiq, its jobs, queues, and processes.

doc/api/templates/licenses.md

@@ -120,7 +120,7 @@ GET /templates/licenses/:key
 | `project`  | string | no       | The copyrighted project name |
 | `fullname` | string | no       | The full-name of the copyright holder |
 
->**Note:**
+NOTE: **Note:**
 If you omit the `fullname` parameter but authenticate your request, the name of
 the authenticated user will be used to replace the copyright holder placeholder.
 

doc/api/version.md

 # Version API
 
->**Note:** This feature was introduced in GitLab 8.13
+> Introduced in GitLab 8.13.
 
 Retrieve version information for this GitLab instance. Responds `200 OK` for
 authenticated users.

doc/ci/examples/laravel_with_gitlab_and_envoy/index.md

@@ -150,7 +150,7 @@ Now, let's clone our repository on the server just to make sure the `deployer` u
 git clone git@gitlab.example.com:<USERNAME>/laravel-sample.git
 ```
 
->**Note:**
+NOTE: **Note:**
 Answer **yes** if asked `Are you sure you want to continue connecting (yes/no)?`.
 It adds GitLab.com to the known hosts.
 
@@ -174,7 +174,7 @@ server {
 }
 ```
 
->**Note:**
+NOTE: **Note:**
 You may replace the app's name in `/var/www/app/current/public` with the folder name of your application.
 
 ## Setting up Envoy
@@ -464,14 +464,14 @@ docker build -t registry.gitlab.com/<USERNAME>/laravel-sample .
 docker push registry.gitlab.com/<USERNAME>/laravel-sample
 ```
 
->**Note:**
+NOTE: **Note:**
 To run the above commands, we first need to have [Docker](https://docs.docker.com/engine/installation/) installed on our machine.
 
 Congratulations! You just pushed the first Docker image to the GitLab Registry, and if you refresh the page you should be able to see it:
 
 ![container registry page with image](img/container_registry_page_with_image.jpg)
 
->**Note:**
+NOTE: **Note:**
 You can also [use GitLab CI/CD](https://about.gitlab.com/blog/2016/05/23/gitlab-container-registry/#use-with-gitlab-ci) to build and push your Docker images, rather than doing that on your machine.
 
 We'll use this image further down in the `.gitlab-ci.yml` configuration file to handle the process of testing and deploying our app.
@@ -551,7 +551,7 @@ services:
 ...
 ```
 
->**Note:**
+NOTE: **Note:**
 If you wish to test your app with different PHP versions and [database management systems](../../services/README.md), you can define different `image` and `services` keywords for each test job.
 
 #### Variables

doc/ci/examples/test_phoenix_app_with_gitlab_ci_cd/index.md

@@ -123,7 +123,7 @@ Generated hello_gitlab_ci app
 The database for HelloGitlabCi.Repo has been created
 ```
 
-> **Note:**
+NOTE: **Note:**
 Phoenix assumes that our PostgreSQL database will have a `postgres` user account with the correct
 permissions and a password of `postgres`. If it's not your case, check
 [Ecto's instructions](https://hexdocs.pm/ecto/Ecto.html#module-repositories).
@@ -211,7 +211,8 @@ when running our Phoenix in our `localhost`.
   Without `.gitkeep`, Git will not upload this empty directory and we'll got an error when running our
   test on GitLab.
 
-  > **Note:** If we add a folder via the GitLab UI, GitLab itself will add the `.gitkeep` to that new dir.
+  NOTE: **Note:**
+  If we add a folder via the GitLab UI, GitLab itself will add the `.gitkeep` to that new dir.
 
 Now, let's run a local test and see if everything we did didn't break anything.
 

doc/ci/quick_start/README.md

@@ -82,7 +82,7 @@ blog about it](https://about.gitlab.com/blog/2015/05/06/why-were-replacing-gitla
 
 ### Creating a simple `.gitlab-ci.yml` file
 
->**Note:**
+NOTE: **Note:**
 `.gitlab-ci.yml` is a [YAML](https://en.wikipedia.org/wiki/YAML) file
 so you have to pay extra attention to indentation. Always use spaces, not tabs.
 

doc/ci/triggers/README.md

@@ -271,7 +271,7 @@ of all types of variables.
 
 ## Using cron to trigger nightly pipelines
 
->**Note:**
+NOTE: **Note:**
 The following behavior can also be achieved through GitLab's UI with
 [pipeline schedules](../pipelines/schedules.md).
 

doc/development/api_styleguide.md

@@ -85,7 +85,7 @@ User.create(params) # imagine the user submitted `admin=1`... :)
 User.create(declared(params, include_parent_namespaces: false).to_h)
 ```
 
->**Note:**
+NOTE: **Note:**
 `declared(params)` return a `Hashie::Mash` object, on which you will have to
 call `.to_h`.
 

doc/development/background_migrations.md

@@ -29,10 +29,10 @@ Some examples where background migrations can be useful:
 - Populating one column based on JSON stored in another column.
 - Migrating data that depends on the output of external services (e.g. an API).
 
-> **Note:**
-> If the background migration is part of an important upgrade, make sure it's announced
-> in the release post. Discuss with your Project Manager if you're not sure the migration falls
-> into this category.
+NOTE: **Note:**
+If the background migration is part of an important upgrade, make sure it's announced
+in the release post. Discuss with your Project Manager if you're not sure the migration falls
+into this category.
 
 ## Isolation
 
@@ -123,7 +123,7 @@ once.
 
 ## Cleaning Up
 
->**Note:**
+NOTE: **Note:**
 Cleaning up any remaining background migrations _must_ be done in either a major
 or minor release, you _must not_ do this in a patch release.
 

doc/development/documentation/styleguide.md

@@ -1767,7 +1767,8 @@ curl --data "name=foo" --header "PRIVATE-TOKEN: <your_access_token>" "https://gi
 
 #### Post data using JSON content
 
-> **Note:** In this example we create a new group. Watch carefully the single
+NOTE: **Note:**
+In this example we create a new group. Watch carefully the single
 and double quotes.
 
 ```shell

doc/development/fe_guide/style/javascript.md

@@ -10,7 +10,7 @@ linter to manage most of our JavaScript style guidelines.
 In addition to the style guidelines set by Airbnb, we also have a few specific rules
 listed below.
 
-> **Tip:**
+TIP: **Tip:**
 You can run eslint locally by running `yarn eslint`
 
 ## Avoid forEach

doc/development/i18n/proofreader.md

@@ -115,9 +115,10 @@ are very appreciative of the work done by translators and proofreaders!
 
 ## Become a proofreader
 
-> **Note:** Before requesting Proofreader permissions in CrowdIn please make
-> sure that you have a history of contributing translations to the GitLab
-> project.
+NOTE: **Note:**
+Before requesting Proofreader permissions in CrowdIn please make
+sure that you have a history of contributing translations to the GitLab
+project.
 
 1. Contribute translations to GitLab. See instructions for
    [translating GitLab](translation.md).

doc/development/query_recorder.md

@@ -20,7 +20,8 @@ end
 
 As an example you might create 5 issues in between counts, which would cause the query count to increase by 5 if an N+1 problem exists.
 
-> **Note:** In some cases the query count might change slightly between runs for unrelated reasons. In this case you might need to test `exceed_query_limit(control_count + acceptable_change)`, but this should be avoided if possible.
+NOTE: **Note:**
+In some cases the query count might change slightly between runs for unrelated reasons. In this case you might need to test `exceed_query_limit(control_count + acceptable_change)`, but this should be avoided if possible.
 
 ## Cached queries
 

doc/development/testing_guide/frontend_testing.md

@@ -24,9 +24,8 @@ We have started to migrate frontend tests to the [Jest](https://jestjs.io) testi
 
 Jest tests can be found in `/spec/frontend` and `/ee/spec/frontend` in EE.
 
-> **Note:**
->
-> Most examples have a Jest and Karma example. See the Karma examples only as explanation to what's going on in the code, should you stumble over some use cases during your discovery. The Jest examples are the one you should follow.
+NOTE: **Note:**
+Most examples have a Jest and Karma example. See the Karma examples only as explanation to what's going on in the code, should you stumble over some use cases during your discovery. The Jest examples are the one you should follow.
 
 ## Karma test suite
 

doc/install/azure/index.md

@@ -67,7 +67,8 @@ The first items we need to configure are the basic settings of the underlying vi
 1. Enter a `User name` - e.g. `gitlab-admin`
 1. Select an `Authentication type`, either **SSH public key** or **Password**:
 
-   > **Note:** if you're unsure which authentication type to use, select **Password**
+   NOTE: **Note:**
+   If you're unsure which authentication type to use, select **Password**
 
    1. If you chose **SSH public key** - enter your `SSH public key` into the field provided
    _(read the [SSH documentation](../../ssh/README.md) to learn more about how to set up SSH
@@ -78,8 +79,9 @@ The first items we need to configure are the basic settings of the underlying vi
 1. Choose the appropriate `Subscription` tier for your Azure account
 1. Choose an existing `Resource Group` or create a new one - e.g. **"GitLab-CE-Azure"**
 
-   > **Note:** a "Resource group" is a way to group related resources together for easier administration.
-   > We chose "GitLab-CE-Azure", but your resource group can have the same name as your VM.
+   NOTE **Note:**
+   A "Resource group" is a way to group related resources together for easier administration.
+   We chose "GitLab-CE-Azure", but your resource group can have the same name as your VM.
 
 1. Choose a `Location` - if you're unsure, select the default location
 
@@ -94,7 +96,8 @@ Check the settings you have entered, and then click **"OK"** when you're ready t
 Next, you need to choose the size of your VM - selecting features such as the number of CPU cores,
 the amount of RAM, the size of storage (and its speed), etc.
 
-> **Note:** in common with other cloud vendors, Azure operates a resource/usage pricing model, i.e.
+NOTE: **Note:**
+In common with other cloud vendors, Azure operates a resource/usage pricing model, i.e.
 the more resources your VM consumes the more it will cost you to run, so make your selection
 carefully. You'll see that Azure provides an _estimated_ monthly cost beneath each VM Size to help
 guide your selection.
@@ -105,7 +108,8 @@ ahead and select this one, but please choose the size which best meets your own
 
 ![Azure - Create Virtual Machine - Size](img/azure-create-virtual-machine-size.png)
 
-> **Note:** be aware that while your VM is active (known as "allocated"), it will incur
+NOTE: **Note:**
+Be aware that while your VM is active (known as "allocated"), it will incur
 "compute charges" which, ultimately, you will be billed for. So, even if you're using the
 free trial credits, you'll likely want to learn
 [how to properly shutdown an Azure VM to save money](https://build5nines.com/properly-shutdown-azure-vm-to-save-money/).
@@ -131,7 +135,8 @@ new VM. You'll be billed only for the VM itself (e.g. "Standard DS1 v2") because
 
 ![Azure - Create Virtual Machine - Purchase](img/azure-create-virtual-machine-purchase.png)
 
-> **Note:** at this stage, you can review and modify the any of the settings you have made during all
+NOTE: **Note:**
+At this stage, you can review and modify the any of the settings you have made during all
 previous steps, just click on any of the four steps to re-open them.
 
 When you have read and agreed to the terms of use and are ready to proceed, click **"Purchase"**.
@@ -173,7 +178,8 @@ _(the full domain name of your own VM will be different, of course)_.
 
 Click **"Save"** for the changes to take effect.
 
-> **Note:** if you want to use your own domain name, you will need to add a DNS `A` record at your
+NOTE **Note:**
+If you want to use your own domain name, you will need to add a DNS `A` record at your
 domain registrar which points to the public IP address of your Azure VM. If you do this, you'll need
 to make sure your VM is configured to use a _static_ public IP address (i.e. not a _dynamic_ one)
 or you will have to reconfigure the DNS `A` record each time Azure reassigns your VM a new public IP
@@ -189,7 +195,8 @@ Ports are opened by adding _security rules_ to the **"Network security group"**
 has been assigned to. If you followed the process above, then Azure will have automatically created
 an NSG named `GitLab-CE-nsg` and assigned the `GitLab-CE` VM to it.
 
-> **Note:** if you gave your VM a different name then the NSG automatically created by Azure will
+NOTE: **Note:**
+If you gave your VM a different name then the NSG automatically created by Azure will
 also have a different name - the name you have your VM, with `-nsg` appended to it.
 
 You can navigate to the NSG settings via many different routes in the Azure Portal, but one of the
@@ -320,7 +327,8 @@ Under the **"Components"** section, we can see that our VM is currently running
 GitLab. This is the version of GitLab which was contained in the Azure Marketplace
 **"GitLab Community Edition"** offering we used to build the VM when we wrote this tutorial.
 
-> **Note:** The version of GitLab in your own VM instance may well be different, but the update
+NOTE **Note:**
+The version of GitLab in your own VM instance may well be different, but the update
 process will still be the same.
 
 ### Connect via SSH
@@ -332,12 +340,11 @@ connect to it using SSH ([Secure Shell](https://en.wikipedia.org/wiki/Secure_She
 If you're running Windows, you'll need to connect using [PuTTY](https://www.putty.org) or an equivalent Windows SSH client.
 If you're running Linux or macOS, then you already have an SSH client installed.
 
-> **Note:**
->
-> - Remember that you will need to login with the username and password you specified
->   [when you created](#basics) your Azure VM
-> - If you need to reset your VM password, read
->   [how to reset SSH credentials for a user on an Azure VM](https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshoot-ssh-connection).
+Remember that you will need to login with the username and password you specified
+[when you created](#basics) your Azure VM.
+
+If you need to reset your VM password, read
+[how to reset SSH credentials for a user on an Azure VM](https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshoot-ssh-connection).
 
 #### SSH from the command-line
 

doc/install/openshift_and_gitlab/index.md

@@ -46,7 +46,7 @@ latest Origin release is used:
 - **OpenShift** `v1.3.0` (is pre-installed in the [VM image](https://app.vagrantup.com/openshift/boxes/origin-all-in-one))
 - **Kubernetes** `v1.3.0` (is pre-installed in the [VM image](https://app.vagrantup.com/openshift/boxes/origin-all-in-one))
 
->**Note:**
+NOTE: **Note:**
 If you intend to deploy GitLab on a production OpenShift cluster, there are some
 limitations to bare in mind. Read on the [limitations](#current-limitations)
 section for more information and follow the linked links for the relevant
@@ -266,7 +266,7 @@ And then let's import it in OpenShift:
 oc create -f openshift-template.json -n openshift
 ```
 
->**Note:**
+NOTE: **Note:**
 The `-n openshift` namespace flag is a trick to make the template available to all
 projects. If you recall from when we created the `gitlab` project, `oc` switched
 to it automatically, and that can be verified by the `oc status` command. If
@@ -313,7 +313,7 @@ If you are deploying to production you will want to change the **GitLab instance
 hostname** and use greater values for the volume sizes. If you don't provide a
 password for PostgreSQL, it will be created automatically.
 
->**Note:**
+NOTE: **Note:**
 The `gitlab.apps.10.2.2.2.nip.io` hostname that is used by default will
 resolve to the host with IP `10.2.2.2` which is the IP our VM uses. It is a
 trick to have distinct FQDNs pointing to services that are on our local network.

doc/integration/bitbucket.md

@@ -21,7 +21,7 @@ Bitbucket.org.
 
 ## Bitbucket OmniAuth provider
 
-> **Note:**
+NOTE: **Note:**
 GitLab 8.15 significantly simplified the way to integrate Bitbucket.org with
 GitLab. You are encouraged to upgrade your GitLab instance if you haven't done so
 already. If you're using GitLab 8.14 or below, [use the previous integration

doc/integration/jenkins_deprecated.md

 # Jenkins CI (deprecated) service
 
->**Note:** In GitLab 8.3, Jenkins integration using the
+NOTE: **Note:**
+In GitLab 8.3, Jenkins integration using the
 [GitLab Hook Plugin](https://wiki.jenkins.io/display/JENKINS/GitLab+Hook+Plugin)
 was deprecated in favor of the
 [GitLab Plugin](https://wiki.jenkins.io/display/JENKINS/GitLab+Plugin).

doc/integration/jira_development_panel.md

@@ -105,12 +105,11 @@ There are no special requirements if you are using GitLab.com.
    for all the projects in the GitLab group you specified in the previous step. These are refreshed
    every 60 minutes.
 
-   > **Note:**
-   > In the future, we plan on implementing real-time integration. If you need
-   > to refresh the data manually, you can do this from the `Applications -> DVCS
-   > accounts` screen where you initially set up the integration:
-   >
-   > ![Refresh GitLab information in Jira](img/jira_dev_panel_manual_refresh.png)
+   In the future, we plan on implementing real-time integration. If you need
+   to refresh the data manually, you can do this from the `Applications -> DVCS
+   accounts` screen where you initially set up the integration:
+
+   ![Refresh GitLab information in Jira](img/jira_dev_panel_manual_refresh.png)
 
 To connect additional GitLab projects from other GitLab top-level groups (or personal namespaces), repeat the above
 steps with additional Jira DVCS accounts.

doc/integration/kerberos.md

@@ -42,7 +42,7 @@ sudo chmod 0600 /etc/http.keytab
 
 **Installations from source**
 
->**Note:**
+NOTE: **Note:**
 For source installations, make sure the `kerberos` gem group
 [has been installed](../install/installation.md#install-gems).
 

doc/integration/omniauth.md

@@ -43,9 +43,9 @@ contains some settings that are common for all providers.
 Before configuring individual OmniAuth providers there are a few global settings
 that are in common for all providers that we need to consider.
 
-> **NOTE:**
-> Starting from GitLab 11.4, OmniAuth is enabled by default. If you're using an
-> earlier version, you'll need to explicitly enable it.
+NOTE: **Note:**
+Starting from GitLab 11.4, OmniAuth is enabled by default. If you're using an
+earlier version, you'll need to explicitly enable it.
 
 - `allow_single_sign_on` allows you to specify the providers you want to allow to
   automatically create an account. It defaults to `false`. If `false` users must
@@ -57,16 +57,16 @@ that are in common for all providers that we need to consider.
   be blocked by default and will have to be unblocked by an administrator before
   they are able to sign in.
 
-> **Note:**
-> If you set `block_auto_created_users` to `false`, make sure to only
-> define providers under `allow_single_sign_on` that you are able to control, like
-> SAML, Shibboleth, Crowd or Google, or set it to `false` otherwise any user on
-> the Internet will be able to successfully sign in to your GitLab without
-> administrative approval.
->
-> **Note:**
-> `auto_link_ldap_user` requires the `uid` of the user to be the same in both LDAP
-> and the OmniAuth provider.
+NOTE: **Note:**
+If you set `block_auto_created_users` to `false`, make sure to only
+define providers under `allow_single_sign_on` that you are able to control, like
+SAML, Shibboleth, Crowd or Google, or set it to `false` otherwise any user on
+the Internet will be able to successfully sign in to your GitLab without
+administrative approval.
+
+NOTE: **Note:**
+`auto_link_ldap_user` requires the `uid` of the user to be the same in both LDAP
+and the OmniAuth provider.
 
 To change these settings:
 
@@ -142,8 +142,7 @@ The chosen OmniAuth provider is now active and can be used to sign in to GitLab
 
 ## Configure OmniAuth Providers as External
 
->**Note:**
-This setting was introduced with version 8.7 of GitLab
+> Introduced in GitLab 8.7.
 
 You can define which OmniAuth providers you want to be `external` so that all users
 **creating accounts, or logging in via these providers** will not be able to have
@@ -151,7 +150,7 @@ access to internal projects. You will need to use the full name of the provider,
 like `google_oauth2` for Google. Refer to the examples for the full names of the
 supported providers.
 
->**Note:**
+NOTE: **Note:**
 If you decide to remove an OmniAuth provider from the external providers list
 you will need to manually update the users that use this method to login, if you
 want their accounts to be upgraded to full internal accounts.
@@ -171,7 +170,7 @@ omniauth:
 
 ## Using Custom OmniAuth Providers
 
->**Note:**
+NOTE: **Note:**
 The following information only applies for installations from source.
 
 GitLab uses [OmniAuth](https://github.com/omniauth/omniauth) for authentication and already ships
@@ -224,12 +223,11 @@ we'd like to at least help those with specific needs.
 
 ## Enable or disable Sign In with an OmniAuth provider without disabling import sources
 
->**Note:**
-This setting was introduced with version 8.8 of GitLab.
+> Introduced in GitLab 8.8.
 
 Administrators are able to enable or disable Sign In via some OmniAuth providers.
 
->**Note:**
+NOTE: **Note:**
 By default Sign In is enabled via all the OAuth Providers that have been configured in `config/gitlab.yml`.
 
 In order to enable/disable an OmniAuth provider, go to Admin Area -> Settings -> Sign-in Restrictions section -> Enabled OAuth Sign-In sources and select the providers you want to enable or disable.

doc/integration/saml.md

@@ -253,8 +253,7 @@ considered admin users.
 
 ### Auditor Groups **(STARTER ONLY)**
 
->**Note:**
-This setting is only available on GitLab 11.4 EE and above.
+> Introduced in [GitLab Starter](https://about.gitlab.com/pricing/) 11.4.
 
 The requirements are the same as the previous settings, your IdP needs to pass Group information to GitLab, you need to tell
 GitLab where to look for the groups in the SAML response, and which group(s) should be
@@ -379,7 +378,7 @@ You may also bypass the auto signin feature by browsing to
 
 ### `attribute_statements`
 
->**Note:**
+NOTE: **Note:**
 This setting should only be used to map attributes that are part of the
 OmniAuth `info` hash schema.
 

doc/security/user_file_uploads.md

@@ -18,7 +18,7 @@ notification emails, which are often read from email clients that are not
 authenticated with GitLab, such as Outlook, Apple Mail, or the Mail app on your
 mobile device.
 
->**Note:**
+NOTE: **Note:**
 Non-image attachments do require authentication to be viewed.
 
 <!-- ## Troubleshooting

doc/topics/git/lfs/migrate_from_git_annex_to_git_lfs.md

 # Migration guide from Git Annex to Git LFS
 
->**Note:**
+NOTE: **Note:**
 Git Annex support [has been removed](https://gitlab.com/gitlab-org/gitlab/-/issues/1648) in GitLab Enterprise
 Edition 9.0 (2017/03/22).
 
@@ -30,7 +30,7 @@ ones that GitLab developed.
 
 ## Migration steps
 
->**Note:**
+NOTE: **Note:**
 Since Git Annex files are stored in a sub-directory of the normal repositories
 (`.git/annex/objects`) and LFS files are stored outside of the repositories,
 they are not compatible as they are using a different scheme. Therefore, the

doc/topics/gitlab_flow.md

@@ -266,11 +266,11 @@ One option is to use continuous integration (CI) to merge in `master` at the sta
 Another option is to only merge in from well-defined points in time, for example, a tagged release.
 You could also use [feature toggles](https://martinfowler.com/bliki/FeatureToggle.html) to hide incomplete features so you can still merge back into `master` every day.
 
-> **Note:** Don't confuse automatic branch testing with continuous integration.
-> Martin Fowler makes this distinction in [his article about feature branches](https://martinfowler.com/bliki/FeatureBranch.html):
->
-> "I've heard people say they are doing CI because they are running builds, perhaps using a CI server, on every branch with every commit.
-> That's continuous building, and a Good Thing, but there's no *integration*, so it's not CI."
+NOTE: **Note:**
+Don't confuse automatic branch testing with continuous integration.
+Martin Fowler makes this distinction in [his article about feature branches](https://martinfowler.com/bliki/FeatureBranch.html):
+"I've heard people say they are doing CI because they are running builds, perhaps using a CI server, on every branch with every commit.
+That's continuous building, and a Good Thing, but there's no *integration*, so it's not CI."
 
 In conclusion, you should try to prevent merge commits, but not eliminate them.
 Your codebase should be clean, but your history should represent what actually happened.

doc/topics/index.md

@@ -16,4 +16,5 @@ tutorials, technical overviews, blog posts) and videos.
 - [GitLab Pages](../user/project/pages/index.md)
 - [Offline GitLab](offline/index.md)
 
->**Note:** More topics will be available soon.
+NOTE: **Note:**
+More topics will be available soon.

doc/update/README.md

@@ -200,7 +200,7 @@ Below you can find some guides to help you change editions easily.
 
 ### Community to Enterprise Edition
 
->**Note:**
+NOTE: **Note:**
 The following guides are for subscribers of the Enterprise Edition only.
 
 If you wish to upgrade your GitLab installation from Community to Enterprise

doc/user/discussions/index.md

@@ -242,7 +242,7 @@ After you click on the image, a comment form will be displayed that would be the
 of your thread. Once you save your comment, you will see a new badge displayed on
 top of your image. This badge represents your thread.
 
->**Note:**
+NOTE: **Note:**
 This thread badge is typically associated with a number that is only used as a visual
 reference for each thread. In the merge request thread tab,
 this badge will be indicated with a comment icon since each thread will render a new

doc/user/markdown.md

@@ -258,7 +258,8 @@ If you're new to this, don't be <img src="https://gitlab.com/gitlab-org/gitlab-f
 
 Consult the [Emoji Cheat Sheet](https://www.webfx.com/tools/emoji-cheat-sheet/) for a list of all supported emoji codes. <img src="https://gitlab.com/gitlab-org/gitlab-foss/raw/master/app/assets/images/emoji/thumbsup.png" width="20px" height="20px" style="display:inline;margin:0">
 
-> **Note:** The emoji example above uses hard-coded images for this documentation. The emoji,
+NOTE: **Note:**
+The emoji example above uses hard-coded images for this documentation. The emoji,
 when rendered within GitLab, may appear different depending on the OS and browser used.
 
 Most emoji are natively supported on macOS, Windows, iOS, Android, and will fall back on image-based emoji where there is no support.

doc/user/permissions.md

@@ -432,7 +432,7 @@ instance and project. In addition, all admins can use the admin interface under
 NOTE: **Note:**
 In GitLab 11.0, the Master role was renamed to Maintainer.
 
->**Note:**
+NOTE: **Note:**
 GitLab 8.12 has a completely redesigned job permissions system.
 Read all about the [new model and its implications](project/new_ci_build_permissions_model.md).
 

doc/user/project/import/gitea.md

@@ -11,7 +11,7 @@ Import your projects from Gitea to GitLab with minimal effort.
 
 ## Overview
 
->**Note:**
+NOTE: **Note:**
 This requires Gitea `v1.0.0` or newer.
 
 - At its current state, Gitea importer can import:

doc/user/project/import/gitlab_com.md

@@ -13,7 +13,7 @@ mind that it is possible only if GitLab.com integration is enabled on your GitLa
 
 To get to the importer page you need to go to "New project" page.
 
->**Note:**
+NOTE: **Note:**
 If you are interested in importing Wiki and Merge Request data to your new instance,
 you'll need to follow the instructions for [exporting a project](../settings/import_export.md#exporting-a-project-and-its-data)
 

doc/user/project/integrations/webhooks.md

@@ -6,25 +6,6 @@ info: To determine the technical writer assigned to the Stage/Group associated w
 
 # Webhooks
 
-> **Note:**
-> Starting from GitLab 8.5:
->
-> - the `repository` key is deprecated in favor of the `project` key
-> - the `project.ssh_url` key is deprecated in favor of the `project.git_ssh_url` key
-> - the `project.http_url` key is deprecated in favor of the `project.git_http_url` key
->
-> **Note:**
-> Starting from GitLab 11.1, the logs of webhooks are automatically removed after
-> one month.
->
-> **Note:**
-> Starting from GitLab 11.2:
->
-> - The `description` field for issues, merge requests, comments, and wiki pages
->   is rewritten so that simple Markdown image references (like
->   `![](/uploads/...)`) have their target URL changed to an absolute URL. See
->   [image URL rewriting](#image-url-rewriting) for more details.
-
 Project webhooks allow you to trigger a URL if for example new code is pushed or
 a new issue is created. You can configure webhooks to listen for specific events
 like pushes, issues or merge requests. GitLab will send a POST request with data
@@ -56,6 +37,24 @@ Navigate to the webhooks page by going to your project's
 NOTE: **Note:**
 On GitLab.com, the [maximum number of webhooks](../../../user/gitlab_com/index.md#maximum-number-of-webhooks) per project, and per group, is limited.
 
+## Version history
+
+Starting from GitLab 8.5:
+
+- the `repository` key is deprecated in favor of the `project` key
+- the `project.ssh_url` key is deprecated in favor of the `project.git_ssh_url` key
+- the `project.http_url` key is deprecated in favor of the `project.git_http_url` key
+
+Starting from GitLab 11.1, the logs of webhooks are automatically removed after
+one month.
+
+Starting from GitLab 11.2:
+
+- The `description` field for issues, merge requests, comments, and wiki pages
+  is rewritten so that simple Markdown image references (like
+  `![](/uploads/...)`) have their target URL changed to an absolute URL. See
+  [image URL rewriting](#image-url-rewriting) for more details.
+
 ## Use-cases
 
 - You can set up a webhook in GitLab to send a notification to
@@ -1345,7 +1344,8 @@ On this page, you can see data that GitLab sends (request headers and body) and
 
 From this page, you can repeat delivery with the same data by clicking `Resend Request` button.
 
-> **Note:** If URL or secret token of the webhook were updated, data will be delivered to the new address.
+NOTE: **Note:**
+If URL or secret token of the webhook were updated, data will be delivered to the new address.
 
 ### Receiving duplicate or multiple webhook requests triggered by one event
 

doc/user/project/issues/confidential_issues.md

@@ -46,7 +46,8 @@ system note in the issue's comments.
 
 ## Indications of a confidential issue
 
->**Note:** If you don't have [enough permissions](#permissions-and-access-to-confidential-issues),
+NOTE: **Note:**
+If you don't have [enough permissions](#permissions-and-access-to-confidential-issues),
 you won't be able to see the confidential issues at all.
 
 There are a few things that visually separate a confidential issue from a

doc/user/project/merge_requests/reviewing_and_managing_merge_requests.md

@@ -132,7 +132,7 @@ specific commit page.
 
 ![MR diff](img/merge_request_diff.png)
 
->**Tip:**
+TIP: **Tip:**
 You can append `?w=1` while on the diffs page of a merge request to ignore any
 whitespace changes.
 
@@ -277,7 +277,7 @@ Merge Request again.
 Here are some tips that will help you be more efficient with merge requests in
 the command line.
 
-> **Note:**
+NOTE: **Note:**
 This section might move in its own document in the future.
 
 ### Checkout merge requests locally

doc/user/project/pages/getting_started_part_one.md

@@ -13,7 +13,7 @@ according to your intended website's URL.
 
 ## GitLab Pages default domain names
 
->**Note:**
+NOTE: **Note:**
 If you use your own GitLab instance to deploy your
 site with GitLab Pages, check with your sysadmin what's your
 Pages wildcard domain. This guide is valid for any GitLab instance,

doc/user/project/repository/web_editor.md

@@ -46,7 +46,7 @@ has already been created, which creates a link to the license itself.
 
 ![New file button](img/web_editor_template_dropdown_buttons.png)
 
->**Note:**
+NOTE: **Note:**
 The **Set up CI/CD** button will not appear on an empty repository. You have to at
 least add a file in order for the button to show up.