Skip to content

Commit

Permalink
"in the Jenkins environment" as a means for referring to the collecti…
Browse files Browse the repository at this point in the history
…ve resources

This comes after some discussion with @omehegan on how to refer to the concept
  • Loading branch information
R. Tyler Croy committed Dec 2, 2016
1 parent 37c24cf commit 4a80581
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 3 deletions.
12 changes: 12 additions & 0 deletions STYLEGUIDE.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ CAUTION: This document is still a work in progress.
* Master
* Node
* Pipeline
* Executor

Mixing of these terms is incorrect

Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/doc/book/pipeline/getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down
4 changes: 2 additions & 2 deletions content/doc/book/pipeline/jenkinsfile.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 4a80581

Please sign in to comment.