Fix pkg cat docs source to match generated output#4536
Merged
Conversation
✅ Deploy Preview for kptdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the source Markdown for kpt pkg cat CLI reference docs so that future make generate runs produce the intended generated Go doc output (previously, generated docs were updated directly, causing regeneration to revert the change).
Changes:
- Update
catcommand short/long descriptions to “Print the contents of a package”. - Update args and examples to reflect printing package contents (including non-KRM files and skipping binaries).
Comments suppressed due to low confidence (1)
documentation/content/en/reference/cli/pkg/cat/_index.md:30
- Args description says only "KRM resources (YAML/JSON) are formatted by default", but
kpt pkg catalso formats/displaysKptfilecontent as YAML. Consider explicitly mentioningKptfilehere (or avoid implying only YAML/JSON files are formatted) to match actual behavior/tests.
Path to a file or a directory containing a kpt package. Displays all
package files: KRM resources (YAML/JSON) are formatted by default,
and non-KRM text files (e.g., README.md) are shown as raw content.
Binary files are skipped. Defaults to the current directory.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Aravindhan Ayyanathan <aravindhan.a@est.tech>
470274c to
75956ac
Compare
mozesl-nokia
approved these changes
May 21, 2026
liamfallon
approved these changes
May 21, 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.
Summary
PR #4505 updated the generated
internal/docs/generated/pkgdocs/docs.godirectly but did not update the source markdown atdocumentation/content/en/reference/cli/pkg/cat/_index.md. This caused make generate to overwrite the intended docs with the stale source.Updated the source markdown to match the intended documentation from #4505.
Testing
make generateto test the docs changes are aligned.