docs(docs): quickstart as a TL;DR and Helm guide as the verified EKS walkthrough - #118
Closed
cubeorgdev[bot] wants to merge 2 commits into
Closed
cubeorgdev[bot] wants to merge 2 commits into
cubeorgdev[bot] wants to merge 2 commits into
Conversation
Rewrite the quickstart around the three things you need: the CLI, a config file, and a server. Each part gets a short explanation and a link to the deep page instead of repeating it. Move what the quickstart used to own into the pages it now links to: CLI installation into CLI commands, the bundle checksum step into the Helm guide, and a health-check example into the deployment contract. Repoint the two links that used the old install anchor. Fixes #117 Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Contributor
Author
|
This pull request was created from a Blocks session. |
The Kubernetes with Helm page was prose with no runnable sequence. It is now the end-to-end EKS guide: fourteen numbered steps from an empty AWS account to a governed agent, with gateway mode as a continuation. Code blocks are the verified ones; paths now point at the release bundle. The revision-bump comment and sed are dropped: the Control API strips revision before comparing baselines, so they did nothing. Content the old page held alone moves to the page that owns the topic: cert-manager and bring-your-own-certificates detail to Bring your own gateway, the invitation-link note to Manage users and invitations, and the config mount-path caveat to the chart README. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Contributor
Author
|
Superseded by #125, the same two commits rebased onto main. |
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.
Fixes #117
Stacked on #116.
Quickstart
Now the short version: the three things you need (the CLI, a config file, a server), what each is for, and a link to the deep page. The
governancesection leads with what it controls: allowed agents, default model and settings, MCP servers, extensions, session capture. The three "how to deploy" cards from the old page are kept under the server section.Three things were only in the quickstart, so they moved:
BLUE_VERSIONpinning, and the installer's checksum note are now an Install section at the top of CLI commands.SHA256SUMScheck for the deployment bundle is now in the Helm guide.curlhealth checks are now under the deployment contract's health-check table.The two links that pointed at the old
#install-the-workstation-clianchor (Docker Compose page, README) now point at the new Install section.Kubernetes with Helm
Replaced with the verified end-to-end EKS walkthrough: a bundle download, then fourteen numbered steps from an empty AWS account to a governed agent, with gateway mode as a continuation of the same stack. Prose is one or two lines per step.
Code blocks are the verified ones, with these deliberate changes:
infra/awsfolder. The five path exports point at the current directory and at../../chart/blueinstead of a source checkout.revisionbump comment and the step 12sedare gone. The Control API stripsrevisionbefore comparing the mounted baseline to the stored one (normalized_governance_value), so bumping it did nothing, and Configure blue.yaml already says so. Thesedalso looked for a value nothing had written.Content the old page held alone moves to the page that owns the topic:
blue.config.mountPathcaveat: Helm chart README.Only
nextis changed;0.1.0is untouched.node scripts/check-content.mjspasses. A code-block diff of the new Helm page against the verified guide shows only the changes listed above. Not run:mint broken-links(not installed here).🤖 Generated with Claude Code