Repository navigation
docs: get started from released packages, not a source build - #667
Merged
Merged
Conversation
The getting-started paths in the README, the tutorials, the book and the website install Kind, kubectl, Helm and the kates CLI with Homebrew (macOS or Linux), or on Linux without Homebrew with scripts/install-kates.sh or a release tarball, then run `kates deploy`, which creates the panda Kind cluster when none is reachable and pulls the release's published charts and backend image. No clone of the repository is needed. Building from source (make cli-install, make all, make kates-image-native-local) stays, framed for working on Kates itself. Also corrects two README notes: kates deploy on Kind falls back to the published native image, and it switches kubectl to the cluster it deploys to. Tutorial 07 now deploys Kyverno with --with-kyverno, since make all never installed it.
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
Getting started no longer builds Kates from source. The README, the tutorials, the book and the website now install the released CLI and its prerequisites, then deploy with
kates deploy, with no clone of the repository:On Linux without Homebrew, the docs use
scripts/install-kates.sh(checkschecksums.txt) or the release tarball, plus cosign. There is no .deb/.rpm; the Homebrew formula already covers Linux.Building from source (
make cli-install,make all,make kates-image-native-local) stays, framed for working on Kates itself: README "Building from source" and a new "Building from Source" subsection in the Deployment Guide.Pages
Corrections found on the way
kates deployon Kind falls back to the published native image when none is local (kindBackendImageArgs); the README said it never pulls one.kates deployswitches kubectl to the cluster it deploys to (useTargetContext); the README said it does not.make all; it is opt-in, now--with-kyverno.Test plan
scripts/check-book-style.shpython3 scripts/gen-book-index.py docs/book --checklychee --offline --include-fragments README.md "docs/**/*.md"npx html-validate@9 website/index.html website/work-with-us.htmlgo test ./cmd -run 'TestMCP.*(Doc|Anchor|Ref)'brew install+kates deployon Kind — not run