Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update vocabulary for Jenkins #2926

Merged
merged 3 commits into from May 28, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
34 changes: 17 additions & 17 deletions content/doc/book/glossary/index.adoc
Expand Up @@ -52,7 +52,7 @@ Artifact::
run which is *archived* onto the Jenkins <<controller,Controller>> for
later retrieval by users.
Build:: [[build]]
Result of a single execution of a <<job,Job>>
Result of a single execution of a <<job,job>>
Cloud:: [[cloud]]
A System Configuration which provides dynamic <<agent,Agent>>
provisioning and allocation, such as that provided by the
Expand All @@ -67,36 +67,36 @@ Core::
the basic web UI, configuration, and foundation upon which <<plugin, Plugins>>
can be built.
Downstream:: [[downstream]]
A configured <<pipeline,Pipeline>> or <<job,Job>> which is triggered
A configured <<pipeline,Pipeline>> or <<job,job>> which is triggered
as part of the execution of a separate Pipeline or Job.
Executor:: [[executor]]
A slot for execution of work defined by a <<pipeline,Pipeline>> or
<<job,Job>> on a <<node, Node>>. A Node may have zero or more
<<job,job>> on a <<node, Node>>. A Node may have zero or more
Executors configured which corresponds to how many concurrent Jobs or
Pipelines are able to execute on that Node.
Fingerprint::
A hash considered globally unique to track the usage of an
<<artifact,Artifact>> or other entity across multiple
<<pipeline,Pipelines>> or <<job,Job>>.
<<pipeline,Pipelines>> or <<job,jobs>>.
Folder:: [[folder]]
An organizational container for <<pipeline,Pipelines>> and/or
<<job,jobs>>, similar to folders on a file system.
Item:: [[item]]
An entity in the web UI corresponding to either a:
<<folder,Folder>>, <<pipeline,Pipeline>>, or <<job,Job>>.
<<folder,Folder>>, <<pipeline,Pipeline>>, or <<job,job>>.
Jenkins URL:: [[jenkins-url]]
The main url for the jenkins application, as visited by a user.
e.g. https://ci.jenkins.io/
Job:: [[job]]
A user-configured description of work which Jenkins should perform, such as
A user-configured description of work which Jenkins should perform, such as
building a piece of software, etc.
Label:: [[label]]
User-defined text for grouping <<agent,Agents>>, typically by similar
functionality or capability. For example `linux` for Linux-based agents or
`docker` for Docker-capable agents.
LTS::
A long-term support <<release, Release>> line of Jenkins products, becoming
available for downloads every 12 weeks.
available for downloads every 12 weeks.
See link:/download/lts/[this page] for more info.
Master::
A deprecated term, synonymous with <<controller,Controller>>.
Expand All @@ -105,7 +105,7 @@ Node::
of executing <<pipeline,Pipelines>> or <<job,jobs>>. Both the
<<master,Master>> and <<agent,Agents>> are considered to be Nodes.
Project:: [[project]]
A deprecated term, synonymous with <<job,Job>>.
A deprecated term, synonymous with <<job,job>>.
Pipeline:: [[pipeline]]
A user-defined model of a continuous delivery pipeline, for more read the
<<pipeline#,Pipeline chapter>> in this handbook.
Expand All @@ -115,15 +115,15 @@ Plugin::
Publisher::
Part of a <<build,Build>> after the completion of all configured
<<step,Steps>> which publishes reports, sends notifications, etc.
A publisher may report <<stable,Stable>> or <<unstable,Unstable>> result
depending on the result of its processing and its configuration.
For example, if a JUnit test fails, then the whole JUnit publisher may
A publisher may report <<stable,Stable>> or <<unstable,Unstable>> result
depending on the result of its processing and its configuration.
For example, if a JUnit test fails, then the whole JUnit publisher may
report the build result as <<unstable,Unstable>>.
Resource Root URL:: [[resource-root-url]]
A secondary url used to serve potentially untrusted content (especially
build artifacts). This url is distinct from the <<jenkins-url,Jenkins URL>>.
Release::
An event, indicating availability of Jenkins distribution products or one
An event, indicating availability of Jenkins distribution products or one
of Jenkins plugins. Jenkins products belong either to <<lts, LTS>> or weekly
Release lines.
Stage::
Expand All @@ -133,19 +133,19 @@ Stage::
status/progress.
Step::
A single task; fundamentally steps tell Jenkins _what_ to do inside of a
<<pipeline,Pipeline>> or <<job,Job>>.
<<pipeline,Pipeline>> or <<job,job>>.
Trigger:: [[trigger]]
A criteria for triggering a new <<pipeline,Pipeline>> run or
<<build,Build>>.
<<job,job>>.
Update Center:: [[update-center]]
Hosted inventory of plugins and plugin metadata to enable plugin
installation from within Jenkins.
Upstream:: [[upstream]]
A configured <<pipeline,Pipeline>> or <<job,Job>> which triggers a
A configured <<pipeline,Pipeline>> or <<job,job>> which triggers a
separate Pipeline or Job as part of its execution.
Workspace:: [[workspace]]
A disposable directory on the file system of a <<node,Node>>
where work can be done by a <<pipeline,Pipeline>> or <<job,Job>>.
where work can be done by a <<pipeline,Pipeline>> or <<job,job>>.
Workspaces are typically left in place after a <<build,Build>> or
<<pipeline,Pipeline>> run completes unless specific Workspace cleanup policies
have been put in place on the Jenkins <<controller,Controller>>.
Expand All @@ -154,7 +154,7 @@ Workspace:: [[workspace]]
== Build Status

Aborted::
The <<build,Build>> was interrupted before it reaches its expected end. For example, the user has stopped it manually or there was a time-out.
The <<build,Build>> was interrupted before it reaches its expected end. For example, the user has stopped it manually or there was a time-out.
Failed::
The <<build,Build>> had a fatal error.
Stable::
Expand Down