Conversation
Signed-off-by: Michael Greaves <michael.greaves@nokia.com>
mpgreaves
requested review from
efiacor,
kispaljr and
mozesl-nokia
as code owners
✅ Deploy Preview for kptdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
dosubot
bot
added
size:L
There was a problem hiding this comment.
Pull request overview
This PR proofreads Chapter 1 of the getting-started book section to improve readability, consistency, and phrasing.
Changes:
- Rewrites the chapter description and multiple paragraphs for clarity and concision.
- Normalizes heading capitalization and adjusts instructional phrasing throughout.
- Improves grammar and flow in the quickstart/customization/apply/update/cleanup sections.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### Kubernetes cluster | ||
|
|
||
| In order to deploy the examples, you need a Kubernetes cluster and a configured kubeconfig context. | ||
| To deploy the examples, you need a Kubernetes cluster and a configured kubeconfig context. |
There was a problem hiding this comment.
kubeconfig is typically styled as kubeconfig (file name) or kubeconfig-related, but kubeconfig context is slightly ambiguous. Consider rephrasing to a configured kubectl context (common user-facing terminology) or a configured kubeconfig with a current context set for precision.
| To deploy the examples, you need a Kubernetes cluster and a configured kubeconfig context. | |
| To deploy the examples, you need a Kubernetes cluster and a configured kubectl context. |
| The [`kpt fn`](../../reference/cli/fn/) set of commands enable you to execute programs called _kpt functions_. These | ||
| programs are packaged as containers and take in YAML files, mutate or validate them, and then output YAML. | ||
| The [`kpt fn`](../../reference/cli/fn/) set of commands enables you to execute programs called _kpt functions_. These programs are | ||
| packaged as containers and take in YAML files, mutate or validate them, and then output YAML. |
There was a problem hiding this comment.
Minor grammar: take in YAML files is more naturally written as take YAML files as input. This reads more smoothly and is consistent with common documentation phrasing.
| packaged as containers and take in YAML files, mutate or validate them, and then output YAML. | |
| packaged as containers and take YAML files as input, mutate or validate them, and then output YAML. |
|
|
||
| For instance, you can use a function (`ghcr.io/kptdev/krm-functions-catalog/search-replace:latest`) to search and replace all the occurrences of | ||
| the `app` key in the `spec` section of the YAML document (`spec.**.app`) and set the value to `my-nginx`. | ||
| For example, you can use a function (`ghcr.io/kptdev/krm-functions-catalog/search-replace:latest`) to search for and replace all the occurrences of the `app` key, in the `spec` section of the YAML document (`spec.**.app`), and set the value to `my-nginx`. |
There was a problem hiding this comment.
This sentence has several commas that break up the flow and slightly change meaning (notably the comma after key). Consider removing the unnecessary commas to improve readability, e.g., avoid isolating in the spec section as a parenthetical clause.
| For example, you can use a function (`ghcr.io/kptdev/krm-functions-catalog/search-replace:latest`) to search for and replace all the occurrences of the `app` key, in the `spec` section of the YAML document (`spec.**.app`), and set the value to `my-nginx`. | |
| For example, you can use a function (`ghcr.io/kptdev/krm-functions-catalog/search-replace:latest`) to search for and replace all occurrences of the `app` key in the `spec` section of the YAML document (`spec.**.app`) and set the value to `my-nginx`. |
| Regardless of how you choose to customize the package — whether by manually editing it or running one-time functions using `kpt fn eval` | ||
| — you need to _render_ the package before applying it to the cluster. This ensures that all the functions declared in the package |
There was a problem hiding this comment.
The em dash formatting is broken across lines: line 158 starts with a leading space before the dash ( ␠—), which can render oddly in Markdown and may be treated as an indented block in some renderers. Keep the em-dash clause on the same line (or remove the extra leading space) so the punctuation renders correctly.
| Regardless of how you choose to customize the package — whether by manually editing it or running one-time functions using `kpt fn eval` | |
| — you need to _render_ the package before applying it to the cluster. This ensures that all the functions declared in the package | |
| Regardless of how you choose to customize the package — whether by manually editing it or running one-time functions using `kpt fn eval` — you need to _render_ the package before applying it to the cluster. | |
| This ensures that all the functions declared in the package |
| Congrats! You should now have a rough idea of what kpt is and what you can do | ||
| with it. Now, let's delve into the details. | ||
| You should now have a rough idea of what kpt is and what you can do | ||
| with it. Let us now delve into the details. |
There was a problem hiding this comment.
Tone consistency: most of the chapter uses you / imperative voice. Let us now delve... shifts to a more formal collective voice. Consider Now, let's delve into the details. (close to the original) to keep the style consistent.
| with it. Let us now delve into the details. | |
| with it. Now, let's delve into the details. |
|
Related Documentation Checked 76 published document(s) in 1 knowledge base(s). No updates required. How did I do? Any feedback? |
No description provided.