Skip to content

docs: fix README Deploy section (Helm not docker), surface in-repo docs - #102

Merged
saadqbal merged 1 commit into
mainfrom
docs/fix-readme-deploy-101
May 6, 2026
Merged

docs: fix README Deploy section (Helm not docker), surface in-repo docs#102
saadqbal merged 1 commit into
mainfrom
docs/fix-readme-deploy-101

Conversation

@saadqbal

@saadqbalsaadqbal commented May 6, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Replaces docker pull tracebloc/client:latest with the correct helm repo add + helm install flow — this repo ships a Helm chart (client/Chart.yaml v1.3.1), not a Docker image.
  • Calls out the chart version and supported platforms (AKS / EKS / bare-metal / OpenShift) front-and-center.
  • New table linking every operational doc in this repo: docs/INSTALL.md, docs/SECURITY.md, docs/MIGRATIONS.md, docs/migration-tools/README.md, client/MIGRATION.md. Previously none of these were discoverable from the README.
  • Fixes broken external walkthrough URLs to match actual paths in the tracebloc/docs tree (local-deployment-guide-linux, local-deployment-guide-macos, eks-client-deployment-guide, azure-deployment-guide).
  • Surfaces the NetworkPolicy/CNI prerequisite as a callout under Deploy — currently it's only mentioned deep inside SECURITY.md.

Surgical change: tagline, architecture diagram, "What the client manages" list, Security section, Links, and License all stay as-is.

Closes#101

Test plan

  • Skim rendered README on the PR diff
  • Click each link in the new doc-pointer table — confirm all resolve
  • Click each external walkthrough link — confirm they resolve to real pages on docs.tracebloc.io
  • Verify helm repo add tracebloc https://tracebloc.github.io/client actually serves a chart index (filed as a separate follow-up if not)

Out of scope (separate follow-ups worth filing)

  • docs/INSTALL.md:203,220,229 still reference the old tracebloc-helm-charts repo name
  • Empty legacy aks/, bm/, eks/ directories at repo root
  • Verify GitHub Pages config for https://tracebloc.github.io/client

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only changes updating Helm install guidance and links; no runtime or configuration behavior is modified.

Overview
Updates the README Deploy section to reflect Helm-based installation (adds helm repo add/helm install commands), calls out the unified chart version and supported platforms, and adds a table linking to key in-repo operational docs (install, security, migrations, and runbooks).

Fixes and consolidates platform-specific walkthrough links and adds a prominent NetworkPolicy/CNI prerequisite callout pointing to docs/SECURITY.md.

Reviewed by Cursor Bugbot for commit a610d2f. Bugbot is set up for automated code reviews on this repo. Configure here.

The Deploy section opened with `docker pull tracebloc/client:latest`,
but this repo ships a Helm chart — the actual install is `helm install`.
External walkthrough URLs (`/local-linux`, `/local-macos`, `/aws`,
`/deployment-overview`) didn't match any path in the tracebloc/docs
tree, so they 404. The in-repo documentation (`docs/INSTALL.md`,
`docs/MIGRATIONS.md`, `docs/migration-tools/README.md`,
`client/MIGRATION.md`) was never linked from the README despite being
the operational source of truth.
Surgical change — the rest of the README stays as-is:
- Replace `docker pull` with `helm repo add` + `helm install` (matches
docs/INSTALL.md)
- Call out chart version (v1.3.1) and platform support (AKS / EKS /
bare-metal / OpenShift) up front
- Table linking every in-repo operational doc
- Fix external URLs to match actual tracebloc/docs paths
(local-deployment-guide-linux, local-deployment-guide-macos,
eks-client-deployment-guide, azure-deployment-guide)
- Pull NetworkPolicy/CNI prerequisite into a callout
Closes#101
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for freeto 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.

docs: fix README Deploy section (Helm not docker), surface in-repo docs

3 participants

@saadqbal@divyasinghds@LukasWodka