docs: consolidate install/CI cleanup for OSS launch - #79
Merged
Conversation
The fork stopped publishing via krew in b8f55df (removal of .krew.yaml and the krew publish step). README.md already warns that `kubectl krew install deprecations` installs upstream, not this fork — remove the matching docs section so the docs site does not silently direct users to the upstream binary. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Remove the Github Action example using cpanato/kubepug-installer@v1.0.0 — a 5-year-old third-party action that installs upstream kubepug (not this fork) and references actions/checkout@v2 and K8s 1.22. Add a Container image section pointing to ghcr.io/nudgebee/kubepug, which is the primary distribution channel per the README but was not mentioned in docs/install.md. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- Remove the "Example of Usage in CI with Github Actions" section. Same stale cpanato/kubepug-installer@v1.0.0 + actions/checkout@v2 example we just dropped from docs/install.md; it installs upstream kubepug, not this fork. - Fix Helm one-liner: "helm template -f values.yaml .0" → "... ." Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
mayankpande88
approved these changes
May 22, 2026
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
Bundled docs cleanups identified during the OSS-readiness review:
docs/install.md:cpanato/kubepug-installer@v1.0.0(5-year-old third-party action, installs upstream) plusactions/checkout@v2and K8s 1.22.ghcr.io/nudgebee/kubepug— primary distribution channel per README but missing from install.md.README.md:helm template -f values.yaml .0→helm template -f values.yaml .Same delete-don't-disclaim pattern as #78 (snap section removal).
Test plan
grep -nE "krew|cpanato" README.md docs/install.mdreturns nothinggrep -n "ghcr.io/nudgebee" docs/install.mdreturns the new sectiongrep -n "\.0 | kubepug" README.mdreturns nothing🤖 Generated with Claude Code