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 <adelaney21@bloomberg.net>
buildpacks · Jul 12, 2023 · 4f4cf3a · 4f4cf3a
1 parent 8709636
commit 4f4cf3a
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 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
@@ -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
@@ -6,12 +6,6 @@ aliases=[
     "/docs/using-pack/building-app/"
 ]
 +++
-<!--+- if false+-->
-<div class="quote mb-4">
-    {{< summary "docs/concepts/operations/build.md" >}}
-    <div class="author"><a href="/docs/concepts/operations/build">build</a></div>
-</div>
-<!--+- end+-->
 <!--+- `
 # Build an app
 `+-->

diff --git 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
@@ -5,9 +5,6 @@ summary="This is a step-by-step tutorial for creating a Cloud Native Buildpack u
 +++
 
 <!--+if false+-->
-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
@@ -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
@@ -44,7 +44,7 @@ <h1 class="title">{{ .Title | markdownify }}</h1>
           </ul>
         {{ else }}
           <h{{ $headerLvl }}><a href="{{.Permalink}}" class="">{{ .Title | markdownify }}</a></h{{ $headerLvl }}>
-          <p class="m-1">{{ .Summary | replaceRE "<h[0-9].*>.*</h[0-9]>" "" | plainify | safeHTML }}</p>
+          <p class="m-1">{{ .Summary | replaceRE "<h[0-9].*>.*</h[0-9]>" "" | markdownify | safeHTML }}</p>
 
           {{ if .Params.include_summaries }}
             {{- template "subsection-summary" dict "currentSection" . "depth" (add $depth 1)  "titleOnlyAfterDepth" $titleOnlyAfterDepth "maxDepth" $maxDepth -}}