Skip to content

Commit

Permalink
Address technical language review
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
AidanDelaney committed Jul 12, 2023
1 parent 8709636 commit 4f4cf3a
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 17 deletions.
6 changes: 3 additions & 3 deletions content/docs/app-developer-guide/build-a-windows-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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?**
>
Expand Down
6 changes: 0 additions & 6 deletions content/docs/app-developer-guide/build-an-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
`+-->
Expand Down
6 changes: 3 additions & 3 deletions content/docs/app-journey.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion content/docs/features/dockerfiles.md
Original file line number Diff line number Diff line change
@@ -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?
Expand Down
2 changes: 1 addition & 1 deletion themes/buildpacks/layouts/partials/docs.html
Original file line number Diff line number Diff line change
Expand Up @@ -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 -}}
Expand Down

0 comments on commit 4f4cf3a

Please sign in to comment.