Merge branch 'docs-yaml-notes-2' into 'master'

Adjust usage of NOTE: in CI docs (2/2)

See merge request gitlab-org/gitlab!45174

doc/ci/README.md

@@ -16,7 +16,7 @@ through the [continuous methodologies](introduction/index.md#introduction-to-cic
 - Continuous Delivery (CD)
 - Continuous Deployment (CD)
 
-NOTE: **Note:**
+TIP: **Tip:**
 Out-of-the-box management systems can decrease hours spent on maintaining toolchains by 10% or more.
 Watch our ["Mastering continuous software development"](https://about.gitlab.com/webcast/mastering-ci-cd/)
 webcast to learn about continuous methods and how GitLab’s built-in CI can help you simplify and scale software development.
@@ -79,7 +79,6 @@ Once you're familiar with how GitLab CI/CD works, see the
 [`.gitlab-ci.yml` full reference](yaml/README.md)
 for all the attributes you can set and use.
 
-NOTE: **Note:**
 GitLab CI/CD and [shared runners](runners/README.md#shared-runners) are enabled on GitLab.com and available for all users, limited only by the [pipeline quota](../user/gitlab_com/index.md#shared-runners).
 
 ## Concepts

doc/ci/caching/index.md

@@ -24,7 +24,6 @@ how it is defined in `.gitlab-ci.yml`.
 
 ## Cache vs artifacts
 
-NOTE: **Note:**
 Be careful if you use cache and artifacts to store the same path in your jobs
 as **caches are restored before artifacts** and the content could be overwritten.
 
@@ -73,7 +72,6 @@ Artifacts:
 - Are always uploaded to GitLab (known as coordinator).
 - Can have an expiration value for controlling disk usage (30 days by default).
 
-NOTE: **Note:**
 Both artifacts and caches define their paths relative to the project directory, and
 can't link to files outside it.
 
@@ -204,9 +202,7 @@ runs of jobs for things like dependencies and commonly used libraries
 (Node.js packages, PHP packages, rubygems, Python libraries, etc.),
 so they don't have to be re-fetched from the public internet.
 
-NOTE: **Note:**
-For more examples, check out our [GitLab CI/CD
-templates](https://gitlab.com/gitlab-org/gitlab/tree/master/lib/gitlab/ci/templates).
+For more examples, check out our [GitLab CI/CD templates](https://gitlab.com/gitlab-org/gitlab/tree/master/lib/gitlab/ci/templates).
 
 ### Caching Node.js dependencies
 

doc/ci/docker/using_docker_images.md

@@ -812,7 +812,6 @@ time.
 
 ## How to debug a job locally
 
-NOTE: **Note:**
 The following commands are run without root privileges. You should be
 able to run Docker with your regular user account.
 

doc/ci/enable_or_disable_ci.md

@@ -31,7 +31,6 @@ either:
 - Site-wide by modifying the settings in `gitlab.yml` and `gitlab.rb` for source
   and Omnibus installations respectively.
 
-NOTE: **Note:**
 This only applies to pipelines run as part of GitLab CI/CD. This will not enable or disable
 pipelines that are run from an [external integration](../user/project/integrations/overview.md#integrations-listing).
 

doc/ci/introduction/index.md

@@ -12,7 +12,7 @@ In this document, we'll present an overview of the concepts of Continuous Integr
 Continuous Delivery, and Continuous Deployment, as well as an introduction to
 GitLab CI/CD.
 
-NOTE: **Note:**
+TIP: **Tip:**
 Out-of-the-box management systems can decrease hours spent on maintaining toolchains by 10% or more.
 Watch our ["Mastering continuous software development"](https://about.gitlab.com/webcast/mastering-ci-cd/)
 webcast to learn about continuous methods and how GitLab’s built-in CI can help you simplify and scale software development.

doc/ci/multi_project_pipelines.md

@@ -213,10 +213,9 @@ In this scenario, the `UPSTREAM_BRANCH` variable with a value related to the
 upstream pipeline will be passed to the `downstream-job` job, and will be available
 within the context of all downstream builds.
 
-NOTE: **Tip:**
 Upstream pipelines take precedence over downstream ones. If there are two
 variables with the same name defined in both upstream and downstream projects,
-the ones defined in the upstream project will take precedence.
+the ones defined in the upstream project take precedence.
 
 #### With variable inheritance
 

doc/ci/parent_child_pipelines.md

@@ -83,8 +83,7 @@ microservice_a:
         file: 'path/to/ci-config.yml'
 ```
 
-NOTE: **Note:**
-The max number of entries that are accepted for `trigger:include:` is three.
+The maximum number of entries that are accepted for `trigger:include:` is three.
 
 Similar to [multi-project pipelines](multi_project_pipelines.md#mirroring-status-from-triggered-pipeline),
 we can set the parent pipeline to depend on the status of the child pipeline upon completion:

doc/ci/quick_start/README.md

@@ -68,11 +68,6 @@ blog about it](https://about.gitlab.com/blog/2015/05/06/why-were-replacing-gitla
 
 ### Creating a simple `.gitlab-ci.yml` file
 
-NOTE: **Note:**
-A GitLab team member has made an [unofficial visual pipeline editor](https://unofficial.gitlab.tools/visual-pipelines/).
-There is a [plan to make it an official part of GitLab](https://gitlab.com/groups/gitlab-org/-/epics/4069)
-in the future, but it's available for anyone who wants to try it at the above link.
-
 You need to create a file named `.gitlab-ci.yml` in the root directory of your
 repository. This is a [YAML](https://en.wikipedia.org/wiki/YAML) file
 so you have to pay extra attention to indentation. Always use spaces, not tabs.
@@ -120,6 +115,11 @@ If you want to check whether the `.gitlab-ci.yml` of your project is valid, ther
 For more information and a complete `.gitlab-ci.yml` syntax, please read
 [the reference documentation on `.gitlab-ci.yml`](../yaml/README.md).
 
+TIP: **Tip:**
+A GitLab team member has made an [unofficial visual pipeline editor](https://unofficial.gitlab.tools/visual-pipelines/).
+There is a [plan to make it an official part of GitLab](https://gitlab.com/groups/gitlab-org/-/epics/4069)
+in the future, but it's available for anyone who wants to try it at the above link.
+
 ### Push `.gitlab-ci.yml` to GitLab
 
 Once you've created `.gitlab-ci.yml`, you should add it to your Git repository

doc/ci/ssh_keys/README.md

@@ -36,7 +36,6 @@ with any type of [executor](https://docs.gitlab.com/runner/executors/)
    `~/.ssh/authorized_keys`) or add it as a [deploy key](../../ssh/README.md#deploy-keys)
    if you are accessing a private GitLab repository.
 
-NOTE: **Note:**
 The private key will not be displayed in the job log, unless you enable
 [debug logging](../variables/README.md#debug-logging). You might also want to
 check the [visibility of your pipelines](../pipelines/settings.md#visibility-of-pipelines).
@@ -94,7 +93,6 @@ to access it. This is where an SSH key pair comes in handy.
      # - git config --global user.name "User name"
    ```
 
-   NOTE: **Note:**
    The [`before_script`](../yaml/README.md#before_script-and-after_script) can be set globally
    or per-job.
 
@@ -164,7 +162,6 @@ ssh-keyscan 1.2.3.4
 Create a new [variable](../variables/README.md#gitlab-cicd-environment-variables) with
 `SSH_KNOWN_HOSTS` as "Key", and as a "Value" add the output of `ssh-keyscan`.
 
-NOTE: **Note:**
 If you need to connect to multiple servers, all the server host keys
 need to be collected in the **Value** of the variable, one key per line.
 

doc/ci/triggers/README.md

@@ -252,10 +252,6 @@ of all types of variables.
 
 ## Using cron to trigger nightly pipelines
 
-NOTE: **Note:**
-The following behavior can also be achieved through GitLab's UI with
-[pipeline schedules](../pipelines/schedules.md).
-
 Whether you craft a script or just run cURL directly, you can trigger jobs
 in conjunction with cron. The example below triggers a job on the `master`
 branch of project with ID `9` every night at `00:30`:
@@ -264,6 +260,9 @@ branch of project with ID `9` every night at `00:30`:
 30 0 * * * curl --request POST --form token=TOKEN --form ref=master https://gitlab.example.com/api/v4/projects/9/trigger/pipeline
 ```
 
+This behavior can also be achieved through GitLab's UI with
+[pipeline schedules](../pipelines/schedules.md).
+
 ## Legacy triggers
 
 Old triggers, created before GitLab 9.0 are marked as legacy.

doc/ci/unit_test_reports.md

@@ -82,7 +82,6 @@ To make the Unit test report output files browsable, include them with the
 To upload the report even if the job fails (for example if the tests do not pass), use the [`artifacts:when:always`](yaml/README.md#artifactswhen)
 keyword.
 
-NOTE: **Note:**
 You cannot have multiple tests with the same name and class in your JUnit report format XML file.
 
 ### Ruby example
@@ -144,8 +143,8 @@ java:
       junit: build/test-results/test/**/TEST-*.xml
 ```
 
-NOTE: **Note:**
-Support for `**` was added in [GitLab Runner 13.0](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/2620).
+In [GitLab Runner 13.0](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/2620)
+and later, you can use `**`.
 
 #### Maven