docs(chart): slim README 699->298, link to canonical docs#525
Merged
Conversation
Signed-off-by: Tri Lam <tree@lumalabs.ai>
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
Slimmed
install/kubernetes/tracecore/README.mdfrom 699 → 298 lines(-401 LoC, -57%). The chart README had grown into a third operator
manual, duplicating canonical docs the repo already maintains.
What was cut
a top-level group pointer. Authoritative per-knob commentary already
lives in
values.yaml(post-Lane-L trim).reference, vanilla Prometheus pod-SD job, Loki/Tempo/Datadog hints,
journald details) → pointers to
docs/integrations/.rollout-math paragraphs, line-by-line probe arithmetic, kubelet probe
state-machine narrative) → pointer to
docs/RUNBOOK-tracecore.md,bullets only for chart-install gotchas.
summary; conftest + CI remain the load-bearing enforcement.
apply snippet.
What was kept (load-bearing)
#troubleshooting,#values-reference,#common-configurations, and the sectionheadings "Install", "Upgrade", "Upgrade posture", "Production
preset", "Pod Security Standard compliance", "Documented deviations".
Cross-refs preserved
Pre-flight grep verified these inbound refs still resolve:
docs/getting-started.md— file-level ref, unchanged.docs/reference-architectures/01-single-cluster.md—#troubleshooting,#values-reference,#common-configurationsanchors preserved.
docs/reference-architectures/README.md— file-level ref, unchanged.install/kubernetes/tracecore/values-production.yaml— §"Productionpreset" heading preserved.
install/kubernetes/tracecore/templates/networkpolicy.yaml—§"NetworkPolicy" content covered under
#common-configurations.docs/rfcs/0008-auto-update-boundary.md— §"Upgrade" / §"Upgradeposture" preserved.
docs/integrations/cert-manager-mtls.md— file-level ref, unchanged.(Pre-existing line-number-anchored refs in
docs/v1-rc1-operational-gaps.mddescribing the README as stale willneed a separate sweep — they document drift this PR partly addresses.)
Test plan
wc -l install/kubernetes/tracecore/README.md→ 298 (< 300).make doc-checkgreen pre + post (1115 markdown links + 218anchor slugs resolve).