diff --git a/STYLEGUIDE.adoc b/STYLEGUIDE.adoc index 2844eb18ac1b..c7b901de6769 100644 --- a/STYLEGUIDE.adoc +++ b/STYLEGUIDE.adoc @@ -10,6 +10,7 @@ CAUTION: This document is still a work in progress. * Master * Node * Pipeline +* Executor Mixing of these terms is incorrect @@ -18,6 +19,17 @@ should always be title-cased. When referring to a conceptual pipeline ("continuous delivery pipeline"), it it should always be lower-cased. +When needing to refer to the collection of executors and/or nodes it is best to +refer to them collective as "the Jenkins environment", for example: + +____ +[..] they will now execute in parallel assuming the requisite capacity exists +in the Jenkins environment. +____ + +As opposed to "the Jenkins cluster", "agent pool" or any other phrase to +describe the collective set of resources provided by Jenkins. + == Syntax/Formatting Below are some tips for keeping documentation consistently formatted to ensure diff --git a/content/doc/book/pipeline/getting-started.adoc b/content/doc/book/pipeline/getting-started.adoc index ca6e06d926cc..eaf2375b69cf 100644 --- a/content/doc/book/pipeline/getting-started.adoc +++ b/content/doc/book/pipeline/getting-started.adoc @@ -100,7 +100,7 @@ node { // <1> echo 'Hello World' // <2> } ---- -<1> `node` allocates an executor and workspace on the Jenkins cluster. +<1> `node` allocates an executor and workspace in the Jenkins environment. <2> `echo` writes simple string in the Console Output. diff --git a/content/doc/book/pipeline/jenkinsfile.adoc b/content/doc/book/pipeline/jenkinsfile.adoc index 1ea42eb4edce..b92a3b1b3fab 100644 --- a/content/doc/book/pipeline/jenkinsfile.adoc +++ b/content/doc/book/pipeline/jenkinsfile.adoc @@ -53,7 +53,7 @@ node { // <1> } } ---- -<1> `node` allocates an executor and workspace on the Jenkins cluster. +<1> `node` allocates an executor and workspace in the Jenkins environment. <2> `stage` describes distinct parts of the Pipeline for better visualization of progress/status. Not all Pipelines will have these same three stages, but this is a good @@ -445,7 +445,7 @@ stage('Test') { Instead of executing the tests on the "linux" and "windows" labelled nodes in series, they will now execute in parallel assuming the requisite capacity -exists in the Jenkins cluster. +exists in the Jenkins environment. === Optional step arguments