Skip to content

docs(deploy-repo): fix claims about dfe-infra and dfe-engine - #37

Merged
catinspace-au merged 2 commits into
mainfrom
docs/suite-review
Nov 16, 2026
Merged

catinspace-au merged 2 commits into
mainfrom
docs/suite-review

Conversation

@catinspace-au

Copy link
Copy Markdown
Contributor

Fix 30 incorrect claims and add 2 missing claims across the README, CONTRIBUTING, docs/ and directory READMEs. Of 100 claims, 64 match dfe-infra's appsets, charts and scripts and dfe-engine's source. The other 4 depend on Argo CD or Kubernetes behaviour.

  • A pins.yaml bump moves no chart. Argo CD renders from the cluster secret's target_revision. dfe-ops upgrade apply --push updates both pins.yaml and target_revision.
  • Bootstrap creates the bundled Forgejo repo without this template (documented with a link to dfe-infra#13).
  • The schema overlay variable is DFE_ENGINE_SCHEMAS_OVERLAY_DIR. The documented name did nothing.
  • An action against a missing instance file creates it WITH its deploy block and deploys that instance. The old text said it deployed nothing.
  • The data ApplicationSet reads sizing/ straight from the repo, so nothing needs copying into infra/.

Restore the bootstrap-seeding status dropped by #31 as the dfe-infra#13 note. Restore the README's "Read by" column as the values cascade table. Keep #32 to #35.

Fix three false arrows in the 1 Mermaid diagram that failed the checker's source pass. The 1 diagram in docs/README.md returns ok 975x298 nodes=7 arrows=6 on Mermaid 12.3.0.

Trim config comments to pointers and short reasons in pins.yaml, both workflows and tools/requirements-validate.txt. The governance/ YAML stays byte-identical to dfe-engine's seeded copies.

Merge leaves the published site alone until a stack pins a newer dfe-deploy tag.

A pins.yaml bump does not move the base. Argo CD renders from the cluster secret's target_revision. dfe-ops upgrade apply moves the pin and target_revision.

Bootstrap creates the bundled Forgejo repo without this template (dfe-infra#13).

- the schema overlay variable is DFE_ENGINE_SCHEMAS_OVERLAY_DIR
- an invoke against a missing instance file creates it with its deploy block, so it deploys the instance
- dfe-engine and its hunt runner read config/, not the other apps
- the data ApplicationSet reads sizing/ straight from this repo, under infra/
- the infra/ file list matches the ApplicationSets
- dfe-schema.yaml is removed
- the values cascade lists every layer the ApplicationSets stack
- each storage model states its storage.md status
- the AWS bucket takes precedence over an infra/ overlay
- engine seeding of governance/ and .seed-ignore are documented

The repo's top diagram is added to docs/README.md. Config comments in pins.yaml, both workflows and the validator requirements are cut to pointers and short reasons. The governance/ YAML stays byte-identical to dfe-engine's seeded copies.
The table lists argocd/values/apps/ and the culvert instance files as inputs to the edge tunnel ApplicationSet, matching the apps ApplicationSet (dfe-infra layer2-edge.yaml). The edge gateway alone reads infra/<app>.yaml.
@catinspace-au
catinspace-au merged commit 0ed97e5 into main Nov 16, 2026
4 checks passed
@catinspace-au
catinspace-au deleted the docs/suite-review branch November 16, 2026 04:11
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