From 9b38d0b1870e8c4eee07cbe2ca54527d9149fa29 Mon Sep 17 00:00:00 2001 From: Aidan Delaney Date: Wed, 12 Jul 2023 07:21:22 +0100 Subject: [PATCH 1/3] Address technical language review Replace some technical words and phrases with Simplified Technical English as described at https://en.wikipedia.org/wiki/Simplified_Technical_English#Writing_rules Signed-off-by: Aidan Delaney --- content/docs/app-developer-guide/build-a-windows-app.md | 6 +++--- content/docs/app-developer-guide/build-an-app.md | 6 ------ content/docs/app-journey.md | 6 +++--- .../docs/buildpack-author-guide/create-buildpack/_index.md | 3 --- content/docs/features/dockerfiles.md | 2 +- themes/buildpacks/layouts/partials/docs.html | 2 +- 6 files changed, 8 insertions(+), 17 deletions(-) diff --git a/content/docs/app-developer-guide/build-a-windows-app.md b/content/docs/app-developer-guide/build-a-windows-app.md index 01f88ba28..2dc65f640 100644 --- a/content/docs/app-developer-guide/build-a-windows-app.md +++ b/content/docs/app-developer-guide/build-a-windows-app.md @@ -4,11 +4,11 @@ weight=2 summary="The basics of taking your Windows app from source code to runnable image." +++ -> **EXPERIMENTAL** Windows support is experiment! +> **EXPERIMENTAL** Windows support is experimental! > > Enable experimental mode by running: `pack config experimental true` -### Precursor +### Before You Start #### Recommended reading @@ -20,7 +20,7 @@ When you're done, head back here. In order to produce Windows container images, ensure [Windows container mode][container-mode] is enabled in your Docker settings (available only in Docker for Windows). -Then, building a Windows app using Cloud Native Buildpacks is nearly identical to [building for Linux][build-linux]: +Then, building a Windows app using Cloud Native Buildpacks is nearly identical to [building for Linux][build-linux]. > **Not using Windows?** > diff --git a/content/docs/app-developer-guide/build-an-app.md b/content/docs/app-developer-guide/build-an-app.md index 62f30b019..1bac2ef93 100644 --- a/content/docs/app-developer-guide/build-an-app.md +++ b/content/docs/app-developer-guide/build-an-app.md @@ -6,12 +6,6 @@ aliases=[ "/docs/using-pack/building-app/" ] +++ - -
- {{< summary "docs/concepts/operations/build.md" >}} -
build
-
- diff --git a/content/docs/app-journey.md b/content/docs/app-journey.md index 3033a25c3..0c5744274 100644 --- a/content/docs/app-journey.md +++ b/content/docs/app-journey.md @@ -26,7 +26,7 @@ Before we set out, you'll need to know the basics of **buildpacks** and how they ### What is a [buildpack][buildpack]? -A buildpack is something you've probably leveraged without knowing, as they're currently +A buildpack is something you've probably used without knowing, as they're currently being used in many cloud platforms. A buildpack's job is to gather everything your app needs to build and run, and it often does this job quickly and quietly. @@ -35,8 +35,8 @@ code into a runnable app image. ##### Auto-detection -What enables buildpacks to go unnoticed is auto-detection. This happens when a platform sequentially -tests groups of buildpacks against your app's source code. The first group that deems itself fit for your source code +What enables buildpacks to be transparent is auto-detection. This happens when a platform sequentially +tests groups of buildpacks against your app's source code. The first group that succesfully detects your source code will become the selected set of buildpacks for your app. Detection criteria is specific to each buildpack -- for instance, an **NPM buildpack** might look for a `package.json`, and a **Go buildpack** might look for Go source files. diff --git a/content/docs/buildpack-author-guide/create-buildpack/_index.md b/content/docs/buildpack-author-guide/create-buildpack/_index.md index 9a8983f0b..ed714e953 100644 --- a/content/docs/buildpack-author-guide/create-buildpack/_index.md +++ b/content/docs/buildpack-author-guide/create-buildpack/_index.md @@ -5,9 +5,6 @@ summary="This is a step-by-step tutorial for creating a Cloud Native Buildpack u +++ -You can also follow an interactive version of this guide on Katacoda. - -{{< katacoda-button href="https://www.katacoda.com/buildpacks/scenarios/buildpack-author-guide" color="green" >}} Learn on Katacoda {{}} ## Prerequisites diff --git a/content/docs/features/dockerfiles.md b/content/docs/features/dockerfiles.md index 0919f03a9..11f32446b 100644 --- a/content/docs/features/dockerfiles.md +++ b/content/docs/features/dockerfiles.md @@ -1,6 +1,6 @@ +++ title="Dockerfiles" -summary="Dockerfiles can be used to extend base images for buildpacks builds" +summary="Dockerfiles can be used to extend base images for buildpacks builds." +++ ## Why Dockerfiles? diff --git a/themes/buildpacks/layouts/partials/docs.html b/themes/buildpacks/layouts/partials/docs.html index 2ba3e315c..6c5d046a8 100644 --- a/themes/buildpacks/layouts/partials/docs.html +++ b/themes/buildpacks/layouts/partials/docs.html @@ -44,7 +44,7 @@

{{ .Title | markdownify }}

{{ else }} {{ .Title | markdownify }} -

{{ .Summary | replaceRE ".*" "" | plainify | safeHTML }}

+

{{ .Summary | replaceRE ".*" "" | markdownify | safeHTML }}

{{ if .Params.include_summaries }} {{- template "subsection-summary" dict "currentSection" . "depth" (add $depth 1) "titleOnlyAfterDepth" $titleOnlyAfterDepth "maxDepth" $maxDepth -}} From f4c1b762eaac9edb8883ea192aa718433130923d Mon Sep 17 00:00:00 2001 From: Aidan Delaney Date: Tue, 18 Jul 2023 05:53:36 +0100 Subject: [PATCH 2/3] Update content/docs/app-journey.md Co-authored-by: Natalie Arellano Signed-off-by: Aidan Delaney Signed-off-by: Aidan Delaney --- content/docs/app-journey.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/app-journey.md b/content/docs/app-journey.md index 0c5744274..6aa3d1cd0 100644 --- a/content/docs/app-journey.md +++ b/content/docs/app-journey.md @@ -26,7 +26,7 @@ Before we set out, you'll need to know the basics of **buildpacks** and how they ### What is a [buildpack][buildpack]? -A buildpack is something you've probably used without knowing, as they're currently +A buildpack is something you've probably used without knowing it, as they're currently being used in many cloud platforms. A buildpack's job is to gather everything your app needs to build and run, and it often does this job quickly and quietly. From bf113e53e64dacce2a59b4a3c7de11688df0f8d1 Mon Sep 17 00:00:00 2001 From: Aidan Delaney Date: Tue, 18 Jul 2023 05:53:43 +0100 Subject: [PATCH 3/3] Update content/docs/app-journey.md Co-authored-by: Natalie Arellano Signed-off-by: Aidan Delaney Signed-off-by: Aidan Delaney --- content/docs/app-journey.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/app-journey.md b/content/docs/app-journey.md index 6aa3d1cd0..2084db32b 100644 --- a/content/docs/app-journey.md +++ b/content/docs/app-journey.md @@ -36,7 +36,7 @@ code into a runnable app image. ##### Auto-detection What enables buildpacks to be transparent is auto-detection. This happens when a platform sequentially -tests groups of buildpacks against your app's source code. The first group that succesfully detects your source code +tests groups of buildpacks against your app's source code. The first group that successfully detects your source code will become the selected set of buildpacks for your app. Detection criteria is specific to each buildpack -- for instance, an **NPM buildpack** might look for a `package.json`, and a **Go buildpack** might look for Go source files.