Skip to content

docs: consolidate install/CI cleanup for OSS launch - #79

Merged
mayankpande88 merged 3 commits into
mainfrom
oss-readiness/drop-krew-docs
May 22, 2026
Merged

docs: consolidate install/CI cleanup for OSS launch#79
mayankpande88 merged 3 commits into
mainfrom
oss-readiness/drop-krew-docs

Conversation

@blue4209211

@blue4209211 blue4209211 commented May 22, 2026

Copy link
Copy Markdown
Contributor

Summary

Bundled docs cleanups identified during the OSS-readiness review:

docs/install.md:

  • Drop the Krew plugin section. Fork stopped publishing via krew (b8f55df); README already warns krew installs upstream, not this fork.
  • Drop the Github Action section. Used cpanato/kubepug-installer@v1.0.0 (5-year-old third-party action, installs upstream) plus actions/checkout@v2 and K8s 1.22.
  • Add a Container image section pointing to ghcr.io/nudgebee/kubepug — primary distribution channel per README but missing from install.md.

README.md:

  • Drop the matching Example of Usage in CI with Github Actions section — same stale third-party installer.
  • Fix the Helm one-liner typo: helm template -f values.yaml .0helm 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.md returns nothing
  • grep -n "ghcr.io/nudgebee" docs/install.md returns the new section
  • grep -n "\.0 | kubepug" README.md returns nothing
  • mkdocs build succeeds (CI)

🤖 Generated with Claude Code

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>

@gemini-code-assist gemini-code-assist 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.

Code Review

This pull request updates the installation documentation by removing the section detailing how to install Kubepug as a Krew plugin. I have no feedback to provide as there are no review comments.

blue4209211 and others added 2 commits May 22, 2026 11:48
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>
@blue4209211 blue4209211 changed the title docs: drop Krew install section docs: consolidate install/CI cleanup for OSS launch May 22, 2026
@mayankpande88
mayankpande88 merged commit 2d2cd22 into main May 22, 2026
2 checks passed
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.

2 participants