Skip to content

Commit 608ecf1

Browse files
authored
Address doc typos (#1853)
1 parent c313220 commit 608ecf1

File tree

6 files changed

+18
-17
lines changed

6 files changed

+18
-17
lines changed

site/book/01-getting-started/00.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
This chapter is a quick introduction to kpt using an example to demonstrate important concepts and
2-
features. Following chapters will cover these concepts in detail.
2+
features. The following chapters will cover these concepts in detail.

site/book/01-getting-started/01-system-requirements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
In order to follow along with the examples in this book, the following needs to be installed on you
1+
In order to follow along with the examples in this book, the following needs to be installed on your
22
system:
33

44
## kpt

site/book/03-packages/01-getting-a-package.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Let's revisit the Wordpress example:
77
$ kpt pkg get https://github.com/GoogleContainerTools/kpt.git/package-examples/[email protected]
88
```
99

10-
A package in a Git repo can be fetched by specifying a branch, tag, or a commit SHA. In this case,
10+
A package in a Git repo can be fetched by specifying a branch, tag, or commit SHA. In this case,
1111
we are specifying tag `v0.1`.
1212

1313
> Refer to the [command reference][get-doc] for more details.
@@ -56,7 +56,7 @@ The `Kptfile` contains two sections to keep track of the upstream package:
5656
contains three pieces of information:
5757
- `repo`: The Git repository where the package can be found
5858
- `directory`: The directory within the Git repository where this package can be found
59-
- `ref`: The Git reference for the package. This can be either a brach, tag, or commit SHA.
59+
- `ref`: The Git reference for the package. This can be either a branch, tag, or commit SHA.
6060
2. The `upstreamLock` section records the upstream Git reference (exact Git SHA) that was fetched by
6161
kpt. This section is managed by kpt and should not be changed manually.
6262

@@ -88,21 +88,22 @@ This is because there are two different package types in kpt:
8888
In this case, the `mysql` subpackage is a _dependent package_. The upstream package for `mysql` is
8989
automatically inferred from the parent package. You can think of the `Kptfile` in the `mysql`
9090
package as implicitly inheriting the `upstream` section of its parent, with the only difference
91-
being that `upstream.directory` points to `/package-examples/wordpress/mysql`.
91+
being that `upstream.directory` in the subpackage would instead point to
92+
`/package-examples/wordpress/mysql`.
9293

9394
## Package Name and Identifier
9495

9596
It is possible to specify a different local directory name to the `get` command. For example,
96-
the following fetches the packages to a directory names `mywordpress`:
97+
the following fetches the packages to a directory named `mywordpress`:
9798

9899
```shell
99100
$ kpt pkg get https://github.com/GoogleContainerTools/kpt.git/package-examples/[email protected] mywordpress
100101
```
101102

102-
The _name_ of a package is given by its directory name. Since the Kptfile is a KRM resource and
103+
The _name of a package_ is given by its directory name. Since the Kptfile is a KRM resource and
103104
follows the familiar structure of KRM resources, the name of the package is also available from the
104-
`metadata.name` field. This must always be the same of the directory name and kpt will update it
105-
automatically when forking a package. In this case, `metadata.name` is set `mywordpress`.
105+
`metadata.name` field. This must always be the name of the directory, and kpt will update it
106+
automatically when forking a package. In this case, `metadata.name` is set to `mywordpress`.
106107

107108
The name of a package is unique within its parent package, but it may not be unique in a deeply
108109
nested package hierarchy (i.e. Depth > 2). The _unique identifier_ for a package is defined as the

site/book/03-packages/03-editing-a-package.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,27 +19,27 @@ _within_ a package.
1919
## Manual edits
2020

2121
As mentioned earlier, you can manually edit or author KRM resources using your favorite editor.
22-
Since every KRM resource has a known schema, you can take advantage of tooling that assist in
22+
Since every KRM resource has a known schema, you can take advantage of tooling that assists in
2323
authoring and validating resource configuration. For example, [Cloud Code] extensions for VS Code
2424
and IntelliJ provide IDE features such as auto-completion, inline documentation, linting, and snippets.
2525

2626
For example, if you have VS Code installed, try modifying the resources in the `wordpress` package:
2727

2828
```shell
29-
$ code wordress
29+
$ code wordpress
3030
```
3131

3232
## Automation
3333

34-
Often times you want to automate repetitive or complex operations. Having standardized on KRM for
34+
Oftentimes, you want to automate repetitive or complex operations. Having standardized on KRM for
3535
all resources in a package (including meta resources) allows us to easily develop automation in
36-
different toolchains, languages, and at levels of abstraction.
36+
different toolchains and languages, as well as at levels of abstraction.
3737

3838
For example, setting a label on all the resources in the `wordpress` package can be done
3939
using the following function:
4040

4141
```shell
42-
cd wordpress
42+
$ cd wordpress
4343
$ kpt fn eval --image gcr.io/kpt-fn/set-label:v0.1 -- env=dev
4444
```
4545

site/book/03-packages/06-composing-a-package.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ $ kpt pkg get https://github.com/kubernetes/website.git/content/en/examples/appl
5353

5454
TODO(#1829): This can be simplified.
5555

56-
This creates a [independent package]. If you wish this to make this a dependent package, you
56+
This creates an [independent package]. If you wish to make this a dependent package, you
5757
can delete the `upstream` and `upstreamLock` sections of the `Kptfile` in `mysql` directory.
5858

5959
[create a new package]: /book/03-packages/05-creating-a-package

site/book/03-packages/07-publishing-a-package.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ $ cd wordpress
1717
$ git add . && git commit -m "Add wordpress package"
1818
```
1919

20-
Tag and pushes the commit:
20+
Tag and push the commit:
2121

2222
```shell
2323
$ git tag v0.1
@@ -35,7 +35,7 @@ $ kpt pkg get <MY_REPO_URL>/@v0.1
3535
You may have a Git repo containing multiple packages. kpt provides a tagging
3636
convention to enable packages to be independently versioned.
3737

38-
For example, let's assume the `wordpress` directory is not at the root of the repo,
38+
For example, let's assume the `wordpress` directory is not at the root of the repo
3939
but instead is in the directory `packages/wordpress`:
4040

4141
```shell

0 commit comments

Comments
 (0)