Skip to content

docs(values): point argocd/values comments at the docs - #1126

Merged
catinspace-au merged 1 commit into
mainfrom
fix/comments-argocd-values
Nov 16, 2026
Merged

catinspace-au merged 1 commit into
mainfrom
fix/comments-argocd-values

Conversation

@catinspace-au

Copy link
Copy Markdown
Collaborator

Comments in argocd/values/ point to docs pages or give short reasons beside surprising values.

  • 62 YAML files trimmed, comments down from 1327 to 317
  • explanations move into docs/deployment/values-shared.md, values-clouds-edge.md and values-tiers-apps.md

Of the 317 comments:

  • 211 are pointers or short reasons

  • 66 sit in the fragment and seeded-app blocks composition.py rewrites

  • 40 are shell and Python comments in the engine's init-container scripts (string values)

  • every edited file loads to the same value before and after (yaml.safe_load, 62 of 62)

  • the render goldens are unchanged

  • the staging example file is untouched

argocd/values/ comments drop from 1327 lines to 317. Of those, 211 point to a docs page or give a short reason beside a surprising value. Another 66 sit in the fragment and seeded-app blocks that scripts/composition.py rewrites.

The other 40 are shell and Python comments inside the engine's init-container scripts. These scripts are string values.

The explanations move into three pages linked from docs/deployment/README.md:

- values-shared.md for common.yaml
- values-clouds-edge.md for the cloud and edge flavour files
- values-tiers-apps.md for the tier profiles and per-app files

Every edited YAML file loads to the same value before and after. composition.py --check-fragments passes.
@catinspace-au
catinspace-au merged commit 2426205 into main Nov 16, 2026
15 checks passed
@catinspace-au
catinspace-au deleted the fix/comments-argocd-values branch November 16, 2026 08:02
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.

1 participant