Proofreading chapter 2#4487
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.
|
Hey @mpgreaves, just a heads-up for future commits to please follow contributing.md. It helps keep the logs structured and clean. Thanks for the contribution! |
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>
Catalin-Stratulat-Ericsson
left a comment
Catalin-Stratulat-Ericsson
left a comment
There was a problem hiding this comment.
looks good just a few minor things maybe to patch in before merging
| title: "Chapter 2: Concepts" | ||
| linkTitle: "Chapter 2: Concepts" | ||
| description: This describes what is kpt and what are the main concepts behind it | ||
| description: This chapter describes what kpt is and what the main concepts are behind kpt. |
There was a problem hiding this comment.
| description: This chapter describes what kpt is and what the main concepts are behind kpt. | |
| description: This chapter describes what kpt is and what the main concepts behind it are. |
There was a problem hiding this comment.
i just thought the description read weird to me.
|
|
||
| *Configuration as Data* is an approach to management of configuration (incl. configuration of infrastructure, policy, | ||
| services, applications, etc.) which: | ||
| *Configuration as data* is an approach to the management of configurations, including the configuration of infrastructure, policy, services, applications, and so on, which comprises the following actions: |
There was a problem hiding this comment.
| *Configuration as data* is an approach to the management of configurations, including the configuration of infrastructure, policy, services, applications, and so on, which comprises the following actions: | |
| *Configuration as data* is an approach to the management of configurations, including the configuration of infrastructure, policy, services, applications, among others, which comprises the following actions: |
and so on doesn't sound very professional
| - **`kpt.dev/bfs-rendering`**: When set to `"true"`, this annotation renders the package hierarchy in breadth-first order, instead of the default depth-first | ||
| post-order. | ||
| - **`kpt.dev/save-on-render-failure`**: When set to `"true"`, this annotation saves partially rendered resources to disk, even when rendering fails, instead of reverting all changes. This is particularly useful for debugging render failures and is essential for programmatic package rendering scenarios, where preserving partial progress is valuable. |
There was a problem hiding this comment.
as we mention subpackages just above this the annotations here should probably also clarify if they operate and the subpackage level when defined in its parent package or if its isolated on a per package basis etc
No description provided.