Skip to content

docs: fix stale setup and contribution notes#2287

Merged
AndrewChubatiuk merged 1 commit into
VictoriaMetrics:masterfrom
immanuwell:docs/fix-stale-contrib-setup-notes
Jun 15, 2026
Merged

docs: fix stale setup and contribution notes#2287
AndrewChubatiuk merged 1 commit into
VictoriaMetrics:masterfrom
immanuwell:docs/fix-stale-contrib-setup-notes

Conversation

@immanuwell

@immanuwell immanuwell commented Jun 14, 2026

Copy link
Copy Markdown
Contributor

This cleans up a few stale setup notes.

Bug

  • docs/setup.md told users to run make deploy-kind-olm, but that target is gone
  • CONTRIBUTING.md said make test-e2e uses minikube, while the Makefile runs Kind
  • make help did not list install-tools and the Kind targets that the docs point people to

Fix

  • remove the stale deploy-kind-olm instruction
  • update the test-e2e note to Kind
  • add help text for install-tools, olm, and the Kind helper targets

Repro

  1. Check out current master
  2. Run make deploy-kind-olm
  3. It blows up with make: *** No rule to make target 'deploy-kind-olm'. Stop.
  4. Run make help
  5. deploy-kind and install-tools are missing there too

Summary by cubic

Cleans up stale setup and contribution notes and aligns docs with the current Kind-based workflow. Adds clearer target descriptions for local Kind and tooling tasks.

  • Bug Fixes
    • Removed deploy-kind-olm instructions from docs/setup.md; clarified that release workflow produces OLM bundles.
    • Updated CONTRIBUTING.md to note make test-e2e runs on Kind.
    • Added descriptions for install-tools, olm, and Kind targets: ensure-kind-cluster, load-kind, deploy-kind, deploy-kind-no-build, undeploy-kind.

Written for commit 53f1c20. Summary will update on new commits.

Review in cubic

@cubic-dev-ai cubic-dev-ai Bot 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.

No issues found across 3 files

Re-trigger cubic

@AndrewChubatiuk AndrewChubatiuk force-pushed the docs/fix-stale-contrib-setup-notes branch from a779ab1 to 53f1c20 Compare June 15, 2026 12:39

@AndrewChubatiuk AndrewChubatiuk 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! Thanks for contribution!

@AndrewChubatiuk AndrewChubatiuk enabled auto-merge (squash) June 15, 2026 12:40
@AndrewChubatiuk AndrewChubatiuk merged commit f922eaf into VictoriaMetrics:master Jun 15, 2026
4 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