summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatija Čupić <matteeyah@gmail.com>2018-10-29 16:58:35 +0100
committerMatija Čupić <matteeyah@gmail.com>2018-10-29 16:58:35 +0100
commit3cbea3b95d2d20de7b65ef0775959c1c153c4e15 (patch)
treee898d6cfe88a0609b7942c5b2039c49a6eba364d
parent3c2acb3acfcc95eead03403f6593201391ead8d2 (diff)
downloadgitlab-ce-3cbea3b95d2d20de7b65ef0775959c1c153c4e15.tar.gz
Copyedit documentation updates
-rw-r--r--doc/ci/variables/README.md4
-rw-r--r--doc/ci/yaml/README.md15
2 files changed, 8 insertions, 11 deletions
diff --git a/doc/ci/variables/README.md b/doc/ci/variables/README.md
index 0ddbc828d1a..bdbcf8c9435 100644
--- a/doc/ci/variables/README.md
+++ b/doc/ci/variables/README.md
@@ -65,8 +65,8 @@ future GitLab releases.**
| **CI_JOB_NAME** | 9.0 | 0.5 | The name of the job as defined in `.gitlab-ci.yml` |
| **CI_JOB_STAGE** | 9.0 | 0.5 | The name of the stage as defined in `.gitlab-ci.yml` |
| **CI_JOB_TOKEN** | 9.0 | 1.2 | Token used for authenticating with the [GitLab Container Registry][registry] and downloading [dependent repositories][dependent-repositories] |
-| **CI_NODE_INDEX** | 11.5 | all | The index of the job in the whole set. If the job is not paralellized, this is not set. |
-| **CI_NODE_TOTAL** | 11.5 | all | The total number of instances of this job running in parallel. If the job is not paralellized, this is set to 1. |
+| **CI_NODE_INDEX** | 11.5 | all | Index of the job in the job set. If the job is not parallelized, this variable is not set. |
+| **CI_NODE_TOTAL** | 11.5 | all | Total number of instances of this job running in parallel. If the job is not parallelized, this variable is set to `1`. |
| **CI_JOB_URL** | 11.1 | 0.5 | Job details URL |
| **CI_REPOSITORY_URL** | 9.0 | all | The URL to clone the Git repository |
| **CI_RUNNER_DESCRIPTION** | 8.10 | 0.5 | The description of the runner as saved in GitLab |
diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md
index 4801d5d42e7..b3a55e48f4e 100644
--- a/doc/ci/yaml/README.md
+++ b/doc/ci/yaml/README.md
@@ -75,7 +75,7 @@ A job is defined by a list of parameters that define the job behavior.
| environment | no | Defines a name of environment to which deployment is done by this job |
| coverage | no | Define code coverage settings for a given job |
| retry | no | Define how many times a job can be auto-retried in case of a failure |
-| parallel | no | Define how many duplicates of a job should be run in parallel |
+| parallel | no | Defines how many instances of a job should be run in parallel |
### `extends`
@@ -1454,17 +1454,15 @@ test:
## `parallel`
-> [Introduced][ce-22631] in GitLab 11.5.
+> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/22631) in GitLab 11.5.
-`parallel` allows you to configure how many duplicates of a job will be run in
-parallel. This value has to be greater or equal to two (2).
+`parallel` allows you to configure how many instances of a job to run in
+parallel. This value has to be greater than or equal to two (2).
-This creates N duplicates of the same job that run in parallel. They're named
+This creates N instances of the same job that run in parallel. They're named
sequentially from `job_name 1/N` to `job_name N/N`.
-For every job `CI_NODE_INDEX` and `CI_NODE_TOTAL` environment variables are set.
-`CI_NODE_TOTAL` represents the total number of jobs while `CI_NODE_INDEX` is the
-index of the job in the whole set.
+For every job, `CI_NODE_INDEX` and `CI_NODE_TOTAL` [environment variables](../variables/README.html#predefined-variables-environment-variables) are set.
A simple example:
@@ -2054,7 +2052,6 @@ CI with various languages.
[ce-7983]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7983
[ce-7447]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7447
[ce-12909]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/12909
-[ce-22631]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/22631
[schedules]: ../../user/project/pipelines/schedules.md
[variables-expressions]: ../variables/README.md#variables-expressions
[ee]: https://about.gitlab.com/gitlab-ee/