Repository navigation
chore(docs): add cli next docs how to guides - #1523
Conversation
|
@greptileai @codex review these changes |
|
To use Codex here, create an environment for this repo. |
Greptile SummaryAdds end-user documentation for authoring, deploying, distributing, inspecting, verifying, and reconfiguring bundles in Next mode.
Confidence Score: 5/5The PR appears safe to merge. No blocking failure remains. Important Files Changed
Reviews (6): Last reviewed commit: "revert changes to next-mode" | Re-trigger Greptile |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: fed50a08fd
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
bradclawsie
left a comment
There was a problem hiding this comment.
looks good, just my one question
briantwatson
left a comment
There was a problem hiding this comment.
Great set of doc additions here -- lot's of good content. I've got some questions and suggestions for clarity among several.
bc2c289
briantwatson
left a comment
There was a problem hiding this comment.
Appreciate all the changes -- nice additions to docs!
joelmccoy
left a comment
There was a problem hiding this comment.
Looking pretty good! A couple small comments and a couple things that I might request as follow on work if you can create tickets for them:
- A how-to guide for signing a bundle (including generating a cosign key with zarf)
- A reference doc for
config.uds.hcl, this should include all things that can be set in the config (we don't have a good doc for this). - A reference doc for
bundle.uds.hclthis should include all the things/fields we can set in the bundle per package
I think as a developer have a single one page reference for the spec for config and bundle definitions would be SUPER helpful
Description
Add end-user documentation for UDS CLI Next mode, covering bundle authoring, deployment, publishing, pulling, inspection, verification, and reconfiguration.
The guides explain when to use Next versus Legacy mode, keep unsigned workflows limited to local alpha testing, and require signature verification for registry workflows.
Related Issue
Relates to CLI-221
Type of change
Live k3d, OCI registry, and Cosign workflows were not run because they require environment-specific resources and credentials.
Checklist before merging