Open
Conversation
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
Contributor
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.
Contributor
|
Related Documentation Checked 76 published document(s) in 1 knowledge base(s). No updates required. How did I do? Any feedback? |
liamfallon
approved these changes
Mar 4, 2026
Contributor
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.
Comments suppressed due to low confidence (1)
documentation/content/en/book/01-getting-started/_index.md:20
- The text says to "Install" the kpt CLI using
kpt version, butkpt versiononly verifies an existing installation. Consider rephrasing to something like "After installing the kpt CLI, verify it by running…" or update the command to an actual install step.
Install the [kpt CLI](installation/kpt-cli), using the following command:
```shell
kpt version
</details>
---
💡 <a href="/kptdev/kpt/new/main?filename=.github/instructions/*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.<br><br>You can also share your feedback on Copilot code review. [Take the survey](https://www.surveymonkey.com/r/XP6L3XJ).
Signed-off-by: Michael Greaves <michael.greaves@nokia.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Michael Greaves <michael.greaves@nokia.com>
Signed-off-by: Michael Greaves <michael.greaves@nokia.com>
mpgreaves
force-pushed
the
proofreading-chapter-1
branch
from
ca29d07 to
7db9d3a
Compare
Comment on lines
-17
to
21
| Install the [kpt CLI](installation/kpt-cli): | ||
| Install the [kpt CLI](installation/kpt-cli), using the following command: | ||
|
|
||
| ```shell | ||
| kpt version | ||
| ``` | ||
|
|
Contributor
There was a problem hiding this comment.
That is not the installation command, but to check if you have it installed.
| ``` | ||
|
|
||
| As you can see, this package contains 3 resources in 3 files. There is a special file named `Kptfile` which is used by | ||
| As can be seen, this package contains three resources in three files. There is a special file named `Kptfile`. This file is used by |
Contributor
There was a problem hiding this comment.
"As can be seen" sounds a little archaic to me.
I don't think we should split "...special file named Kptfile which is used by..." into two different sentences.
|
|
||
| You might want to label all resources in the package. To achieve that, you can declare `set-labels` function in the | ||
| `pipeline` section of `Kptfile`. Add this by running the following command: | ||
| It might be a good idea to label all the resources in the package. To achieve this, you can declare the `set-labels` function, in the |
Contributor
There was a problem hiding this comment.
Suggested change
| It might be a good idea to label all the resources in the package. To achieve this, you can declare the `set-labels` function, in the | |
| It might be a good idea to label all the resources in the package. To achieve this, you can declare the `set-labels` function in the |
| 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. |
Contributor
There was a problem hiding this comment.
I agree with copilot here, "let us now" sounds too formal IMO.
kispaljr
approved these changes
Mar 12, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.