docs: fix stale Getting Started environment docs #83

Merged
martin merged 1 commit from docs/fix-getting-started into main 2026-11-16 19:58:21 +00:00
Owner

The README documented a staging environment that does not exist, showed
manifests/{env}/apps/ where the generated path is apps-{env}/, and did not
explain that bootstrap is a one-time per-environment step.

  • Replace staging examples with a clearly marked your-env placeholder and list
    the real dev/infra/prod environments.
  • Document the rendered bootstrap object (Application apps-{env} in argocd,
    automated prune + selfHeal, not tracked in Git) and the Argo CD prerequisite.
  • Correct the repository-structure diagram to apps-{env}/ plus per-app dirs.
  • Mention just diff {env}, clone URL, and just switch running git add.

Closes #80

The README documented a staging environment that does not exist, showed manifests/{env}/apps/ where the generated path is apps-{env}/, and did not explain that bootstrap is a one-time per-environment step. - Replace staging examples with a clearly marked your-env placeholder and list the real dev/infra/prod environments. - Document the rendered bootstrap object (Application apps-{env} in argocd, automated prune + selfHeal, not tracked in Git) and the Argo CD prerequisite. - Correct the repository-structure diagram to apps-{env}/ plus per-app dirs. - Mention just diff {env}, clone URL, and just switch running git add. Closes #80
martin self-assigned this 2026-11-15 20:53:21 +00:00
docs: fix stale Getting Started environment docs
All checks were successful
ci/woodpecker/pr/pr-review Pipeline was successful
fd77a95f19
The README documented a staging environment that does not exist, showed
manifests/{env}/apps/ where the generated path is apps-{env}/, and did not
explain that bootstrap is a one-time per-environment step.

- Replace staging examples with a clearly marked your-env placeholder and list
  the real dev/infra/prod environments.
- Document the rendered bootstrap object (Application apps-{env} in argocd,
  automated prune + selfHeal, not tracked in Git) and the Argo CD prerequisite.
- Correct the repository-structure diagram to apps-{env}/ plus per-app dirs.
- Mention just diff {env}, clone URL, and just switch running git add.

Refs #80
martin force-pushed docs/fix-getting-started from fd77a95f19
All checks were successful
ci/woodpecker/pr/pr-review Pipeline was successful
to f777bb6dcd
All checks were successful
ci/woodpecker/pr/pr-review Pipeline was successful
2026-11-16 19:57:13 +00:00
Compare
martin merged commit 4784f04520 into main 2026-11-16 19:58:21 +00:00
martin deleted branch docs/fix-getting-started 2026-11-16 19:58:21 +00:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Reference
Personal/cluster!83
No description provided.