Skip to content

chore(docs): add cli next docs how to guides - #1523

Merged
chance-coleman merged 14 commits into
mainfrom
chance/cli-221
Sep 3, 2026
Merged

chance-coleman merged 14 commits into
mainfrom
chance/cli-221

Conversation

@chance-coleman

Copy link
Copy Markdown
Contributor

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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Other (security config, docs update, etc)

Live k3d, OCI registry, and Cosign workflows were not run because they require environment-specific resources and credentials.

Checklist before merging

@chance-coleman chance-coleman self-assigned this Aug 27, 2026
@chance-coleman

chance-coleman commented Aug 27, 2026 •

Copy link
Copy Markdown
Contributor Author

@greptileai @codex review these changes

@chatgpt-codex-connector

Copy link
Copy Markdown

To use Codex here, create an environment for this repo.

@greptile-apps

greptile-apps Bot commented Aug 27, 2026 •

Copy link
Copy Markdown
Contributor

Greptile Summary

Adds end-user documentation for authoring, deploying, distributing, inspecting, verifying, and reconfiguring bundles in Next mode.

  • Adds a Next mode quickstart and navigation from the getting-started pages.
  • Adds task-oriented guides for the main Next mode bundle workflows.
  • Clarifies the distinction between signed registry workflows and unsigned local alpha testing.

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
docs/how-to-guides/next-reconfigure-a-bundle.mdx The previously reported terminology is corrected to identify variables as an attribute, matching the defaults parser and the displayed HCL syntax.
docs/getting-started/next-quickstart.mdx Adds a local Next mode workflow covering definition deployment and explicitly scoped unsigned artifact usage.
docs/how-to-guides/next-create-a-bundle.mdx Documents bundle definition, package verification policies, defaults, and signed or local unsigned artifact creation.
docs/how-to-guides/next-deploy-a-bundle.mdx Documents definition and artifact deployment, configuration input, package selection, and signature verification requirements.
docs/how-to-guides/next-publish-pull.mdx Documents signed artifact publication, verified registry pulls, and deployment of downloaded artifacts.
docs/how-to-guides/next-inspect-verify.mdx Documents bundle inspection, signature verification policies, and structured command output.

Reviews (6): Last reviewed commit: "revert changes to next-mode" | Re-trigger Greptile

Comment thread docs/getting-started/overview.mdx Resolved
@chance-coleman
chance-coleman marked this pull request as ready for review August 27, 2026 21:28
@chance-coleman
chance-coleman requested a review from a team as a code owner August 27, 2026 21:28

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 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 bradclawsie 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.

looks good, just my one question

slaskawi
slaskawi previously approved these changes Aug 28, 2026

@briantwatson briantwatson 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.

Great set of doc additions here -- lot's of good content. I've got some questions and suggestions for clarity among several.

bradclawsie
bradclawsie previously approved these changes Aug 28, 2026

@bradclawsie bradclawsie 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.

lgtm

@chance-coleman
chance-coleman dismissed stale reviews from bradclawsie and slaskawi via bc2c289 August 28, 2026 13:58
briantwatson
briantwatson previously approved these changes Sep 1, 2026

@briantwatson briantwatson 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.

Appreciate all the changes -- nice additions to docs!

@joelmccoy joelmccoy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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:

  1. A how-to guide for signing a bundle (including generating a cosign key with zarf)
  2. 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).
  3. A reference doc for bundle.uds.hcl this 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

@chance-coleman
chance-coleman merged commit 6365ecc into main Sep 3, 2026
21 checks passed
@chance-coleman
chance-coleman deleted the chance/cli-221 branch September 3, 2026 13:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants