Skip to content

Fix pkg cat docs source to match generated output#4536

Merged
liamfallon merged 1 commit into
kptdev:mainfrom
Nordix:bug-cat-docs-make-generate
May 21, 2026
Merged

Fix pkg cat docs source to match generated output#4536
liamfallon merged 1 commit into
kptdev:mainfrom
Nordix:bug-cat-docs-make-generate

Conversation

@aravindtga
Copy link
Copy Markdown
Contributor

Summary

PR #4505 updated the generated internal/docs/generated/pkgdocs/docs.go directly but did not update the source markdown at documentation/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

  • Tested with make generate to test the docs changes are aligned.

Copilot AI review requested due to automatic review settings May 21, 2026 12:44
@netlify
Copy link
Copy Markdown

netlify Bot commented May 21, 2026

Deploy Preview for kptdocs ready!

Name Link
🔨 Latest commit 75956ac
🔍 Latest deploy log https://app.netlify.com/projects/kptdocs/deploys/6a0f003ce851fa0008962476
😎 Deploy Preview https://deploy-preview-4536--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 size:S This PR changes 10-29 lines, ignoring generated files. documentation Improvements or additions to documentation labels May 21, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 cat command 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 cat also formats/displays Kptfile content as YAML. Consider explicitly mentioning Kptfile here (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.

Comment thread documentation/content/en/reference/cli/pkg/cat/_index.md Outdated
Signed-off-by: Aravindhan Ayyanathan <aravindhan.a@est.tech>
@aravindtga aravindtga force-pushed the bug-cat-docs-make-generate branch from 470274c to 75956ac Compare May 21, 2026 12:53
@dosubot dosubot Bot added the lgtm label May 21, 2026
@liamfallon liamfallon merged commit f7db281 into kptdev:main May 21, 2026
9 checks passed
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:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants