Skip to content

Commit 6331366

Browse files
Merge pull request #31079 from lbarbeevargas/update-build-glossary-description
Updates term glossary for build and adds build configuration
2 parents e5f8947 + 3c32d9d commit 6331366

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

contributing_to_docs/term_glossary.adoc

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,11 +103,21 @@ action. It consists of _identity_ and _action_.
103103
''''
104104
=== build
105105

106-
General usage: build(s)
106+
Usage: build(s), or when speaking generally about `Build` objects.
107107

108-
A build is the process of transforming input parameters into a resulting object.
108+
* A build is the process of transforming input parameters into a resulting object.
109+
* A `Build` object encapsulates the inputs needed to produce a new deployable image, as well as the status of the execution and a reference to the pod that executed the build.
109110

110-
When referencing the actual object, write as `Build`. See link:doc_guidelines.adoc#api-object-formatting[API object formatting] for more details.
111+
When referencing the actual object, write as "``Build`` object" as appropriate. See link:doc_guidelines.adoc#api-object-formatting[API object formatting] for more details.
112+
113+
''''
114+
=== build configuration
115+
116+
Usage: build configuration(s) when speaking generally about `BuildConfig` objects.
117+
118+
A `BuildConfig` object is the definition of the entire build process. A build configuration describes a single build definition and a set of triggers for when a new build is created.
119+
120+
When referencing the actual object, write as "``BuildConfig`` object" as appropriate. See link:doc_guidelines.adoc#api-object-formatting[API object formatting] for more details.
111121

112122
== C
113123

0 commit comments

Comments
 (0)