You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: vale fixes — word list and headings in for-app-developers (#932)
* docs: vale fixes — word list and headings in for-app-developers
The .vale.ini referenced a Google style package that had never been
downloaded, so CI lint was silently passing without enforcing any rules.
This commit bootstraps the Google style via vale sync, expands the
CNB-specific vocabulary to correctly accept project terms (buildpacks,
lifecycle, OCI, SBOM, Podman, etc.) using regex patterns that avoid
spurious Vale.Terms conflicts, and excludes SVG files from prose linting.
All Google.WordList violations in for-app-developers are resolved:
"application" → "app", "in order to" → "to", "above" → "preceding",
and heading capitalisation converted to sentence case throughout.
The Google Headings rule is extended with ARM and FAQ as known acronyms
so question headings containing those terms are not mis-flagged.
Signed-off-by: Aidan Delaney <aidan.delaney@gmail.com>
* Fix remaining Vale error-level violations in for-app-developers docs
After establishing a Vale baseline, a second pass was needed to clear
all error-level findings that were not addressed in the initial sweep.
These fixes bring the for-app-developers section to zero Vale errors.
Changes include: BlockIgnores for TOML frontmatter in .vale.ini to
suppress false-positive Google.Quotes on alias arrays; removal of
exclamation marks (Google.Exclamation) from prose and summary fields;
replacement of Latin abbreviations e.g./i.e. with "for example"/"that
is" (Google.Latin); removal of double spaces after sentence-ending
periods (Google.Spacing); fixing "configure configure" repeated word
(Vale.Repetition); "container(s)" to "containers" (Google.OptionalPlurals);
and "locally-configured" to "locally configured" (Google.LyHyphens).
Signed-off-by: Aidan Delaney <aidan.delaney@gmail.com>
---------
Signed-off-by: Aidan Delaney <aidan.delaney@gmail.com>
<metaname="description" content="Build is the process of executing one or more buildpacks against an application’s source code to produce a runnable OCI image.
11
+
<metaname="description" content="Build is the process of executing one or more buildpacks against an app’s source code to produce a runnable OCI image.
<metaproperty="og:description" content="Build is the process of executing one or more buildpacks against an application’s source code to produce a runnable OCI image.
26
+
<metaproperty="og:description" content="Build is the process of executing one or more buildpacks against an app’s source code to produce a runnable OCI image.
<ahref="/docs/for-app-developers/how-to/build-outputs/download-sbom/">Download a Software Bill-of-Materials (SBOM)</a>
@@ -898,7 +898,7 @@
898
898
<h1class="title">What happens during build?</h1>
899
899
</div>
900
900
901
-
<p><code>Build</code> is the process of executing one or more <ahref="/docs/for-app-developers/concepts/buildpack/">buildpacks</a> against an application’s source code to produce a runnable OCI image.</p>
901
+
<p><code>Build</code> is the process of executing one or more <ahref="/docs/for-app-developers/concepts/buildpack/">buildpacks</a> against an app’s source code to produce a runnable OCI image.</p>
<ahref="/docs/for-app-developers/how-to/build-outputs/download-sbom/">Download a Software Bill-of-Materials (SBOM)</a>
@@ -902,7 +902,7 @@ <h1 class="title">What is a builder?</h1>
902
902
an ordered combination of <ahref="/docs/for-app-developers/concepts/buildpack/">buildpacks</a> and
903
903
a <ahref="/docs/for-app-developers/concepts/base-images/build/">build-time base image</a>, a <ahref="/docs/for-platform-operators/concepts/lifecycle/">lifecycle</a> binary, and a reference to a <ahref="/docs/for-app-developers/concepts/base-images/run/">runtime base image</a>.</p>
904
904
<p>The <ahref="/docs/for-app-developers/concepts/base-images/build/">build-time base image</a> provides the base environment for the <code>builder</code>
905
-
(e.g., an Ubuntu Resolute OS image with build tooling) and
905
+
(for example, an Ubuntu Resolute OS image with build tooling) and
906
906
a <ahref="/docs/for-app-developers/concepts/base-images/run/">runtime base image</a> provides the base environment for the <code>app image</code> during runtime.</p>
<p>Under the hood a builder uses the <ahref="/docs/for-platform-operators/concepts/lifecycle/">lifecycle</a> to run the <code>detect</code> phase for all the <code>buildpacks</code> it contains, in order,
0 commit comments