Skip to content

Proofreading chapter 2 - #4487

Open
mpgreaves wants to merge 12 commits into
kptdev:mainfrom
nokia:proofreading-chapter-2
Open

Proofreading chapter 2#4487
mpgreaves wants to merge 12 commits into
kptdev:mainfrom
nokia:proofreading-chapter-2

Conversation

@mpgreaves

Copy link
Copy Markdown
Contributor

No description provided.

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>
Copilot AI review requested due to automatic review settings April 16, 2026 09:00
@dosubot dosubot Bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Apr 16, 2026
@netlify

netlify Bot commented Apr 16, 2026

Copy link
Copy Markdown

Deploy Preview for kptdocs ready!

Name Link
🔨 Latest commit 4715832
🔍 Latest deploy log https://app.netlify.com/projects/kptdocs/deploys/6a900639e8158c0008495892
😎 Deploy Preview https://deploy-preview-4487--kptdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@dosubot dosubot Bot added the documentation Improvements or additions to documentation label Apr 16, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread documentation/content/en/book/02-concepts/_index.md Outdated
Comment thread documentation/content/en/book/02-concepts/_index.md
Comment thread documentation/content/en/book/02-concepts/_index.md
Comment thread documentation/content/en/book/02-concepts/_index.md Outdated
Comment thread documentation/content/en/book/02-concepts/_index.md Outdated
Comment thread documentation/content/en/book/02-concepts/_index.md Outdated
Comment thread documentation/content/en/book/02-concepts/_index.md Outdated
Comment thread documentation/content/en/book/02-concepts/_index.md Outdated
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>
Copilot AI review requested due to automatic review settings April 23, 2026 08:59

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread documentation/content/en/book/02-concepts/_index.md Outdated
Comment thread documentation/content/en/book/02-concepts/_index.md Outdated
mpgreaves and others added 2 commits April 23, 2026 11:06
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>
Copilot AI review requested due to automatic review settings April 23, 2026 09:15

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread documentation/content/en/book/02-concepts/_index.md Outdated
Comment thread documentation/content/en/book/02-concepts/_index.md Outdated
@Jaisheesh-2006

Copy link
Copy Markdown
Contributor

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>
Copilot AI review requested due to automatic review settings May 21, 2026 08:57

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

liamfallon
liamfallon previously approved these changes Jun 2, 2026
@dosubot dosubot Bot added the lgtm label Jun 2, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good just a few minor things maybe to patch in before merging

Comment thread documentation/content/en/book/02-concepts/_index.md Outdated
Comment thread documentation/content/en/book/02-concepts/_index.md Outdated
Comment thread documentation/content/en/book/02-concepts/_index.md
CsatariGergely and others added 2 commits July 2, 2026 12:01
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>

Co-authored-by: Catalin Stratulat <159934629+Catalin-Stratulat-Ericsson@users.noreply.github.com>
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
@sonarqubecloud

Copy link
Copy Markdown

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>

<<<<<<< HEAD
Details of how to work with packages are set out in [Chapter 3](../03-packages).
=======

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Merge conflict need to be resolved.

- The functions are hermetic. For correctness, security and speed, it is desirable to be able to run functions hermetically without any privileges, thereby preventing out-of-band access to the host filesystem and networking.

We will discuss the KRM Functions Specification Standard in detail in
<<<<<<< HEAD

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Merge conflict need to be resolved.

- `kpt fn render`: This command executes the pipeline of functions declared in the package and its subpackages. This is a declarative way to run the functions.
- `kpt fn eval`: This command executes a given function on the package. The image to run and the `functionConfig` are specified as a CLI argument. This is an imperative way to run functions. Since the function is provided explicitly by the user, an imperative invocation can be more privileged and low-level than a declarative invocation. For example, it can have access to the host system.

<<<<<<< HEAD

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Merge conflict need to be resolved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation lgtm size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants