Conversation
Signed-off-by: Michael Greaves <michael.greaves@nokia.com>
Signed-off-by: Michael Greaves <michael.greaves@nokia.com>
Signed-off-by: Michael Greaves <michael.greaves@nokia.com>
Signed-off-by: Michael Greaves <michael.greaves@nokia.com>
mpgreaves
requested review from
efiacor,
kispaljr,
liamfallon and
mozesl-nokia
as code owners
dosubot
Bot
added
the
size:L
✅ Deploy Preview for kptdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This PR proofreads and rephrases Chapter 2 (“Concepts”) of the kpt book, aiming to improve clarity and readability of the documentation content.
Changes:
- Reworded multiple sections for improved grammar and readability.
- Restructured several paragraphs into bullet/numbered lists and expanded some explanations.
- Updated wording and formatting across the “Packages”, “Workflows”, and “Functions” sections.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Michael Greaves <michael.greaves@nokia.com> Assisted-by: Copilot Code Review: not-known Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Michael Greaves <michael.greaves@nokia.com>
Signed-off-by: Michael Greaves <michael.greaves@nokia.com> Assisted-by: Copilot Code Review: not-known Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| A kpt package is a bundle of configuration _data_. It is represented as a directory tree containing KRM resources using | ||
| YAML as the file format. | ||
| A package is explicitly declared using a file named `Kptfile`. This file contains a KRM resource of type `Kptfile`. The Kptfile contains metadata about the package and is simply a regular resource in the YAML format. |
There was a problem hiding this comment.
In the Kptfile description, Kubernetes/YAML terminology is off: the embedded resource uses kind: Kptfile (not “type Kptfile”). Please change this wording to “resource of kind Kptfile” to match the actual field name used in all Kptfile examples elsewhere in the docs.
| A package is explicitly declared using a file named `Kptfile`. This file contains a KRM resource of type `Kptfile`. The Kptfile contains metadata about the package and is simply a regular resource in the YAML format. | |
| A package is explicitly declared using a file named `Kptfile`. This file contains a KRM resource of kind `Kptfile`. The Kptfile contains metadata about the package and is simply a regular resource in the YAML format. |
| @@ -129,18 +107,15 @@ status: | |||
| pipeline.run: must run with `--allow-exec` option to allow running function binaries | |||
There was a problem hiding this comment.
The YAML failure example contains a tab before pipeline.run, which makes the YAML invalid (YAML indentation must use spaces). Replace the tab with spaces so the example is copy/pasteable and valid YAML.
| pipeline.run: must run with `--allow-exec` option to allow running function binaries | |
| pipeline.run: must run with `--allow-exec` option to allow running function binaries |
No description provided.