aws-samples / aws-samples/sample-autonomous-cloud-coding-agents

docs(bootstrap): update DEPLOYMENT_ROLES.md, AGENTS.md, deployment guide

Offen
#128 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
documentation enhancement infra-cdk
Vorherrschende Sprache
TypeScript
Sterne
143
Forks
46
Ø Merge
3 T. 10 Std.
Gemergte PRs (30 T.)
24

Beschreibung

## Parent

Sub-issue 8 of #120 (RFC: Least-privilege CDK bootstrap policies as code)

## Branch strategy

`feat/bootstrap-docs` → targets `feat/bootstrap-cicd` → final merge to `main`

## Estimated review time: ~15 min

## Summary

Update all documentation to reference the new code-as-source-of-truth and new operator workflows. This is the final PR in the stack — merging it to `main` completes the full feature.

## Deliverables

- [ ] Update `docs/design/DEPLOYMENT_ROLES.md`:
- Remove inline JSON policy blobs (replaced by generated artifacts)
- Add "Source of truth: `cdk/src/bootstrap/policies/`" reference
- Update "Using these policies" section to reference `mise //cdk:bootstrap`
- Keep the "How CDK deployment roles work" explanation (still valuable context)
- Add "Versioning" section explaining the triple-layer scheme
- [ ] Update `docs/guides/DEPLOYMENT_GUIDE.md`:
- Add "Bootstrap with least-privilege" section
- Document the upgrade path: default bootstrap → custom bootstrap
- Document preflight validation and what to do on failure
- [ ] Update `AGENTS.md`:
- Routing table: add `cdk/src/bootstrap/` → "Bootstrap policies, preflight, Aspect"
- Routing table: add `cdk/bootstrap/` → "Generated bootstrap artifacts (do not edit directly)"
- "Common mistakes": add "Editing `cdk/bootstrap/` directly instead of regenerating from `cdk/src/bootstrap/`"
- "Commands you can use": add `mise //cdk:bootstrap`, `mise //cdk:bootstrap:generate`, `mise //cdk:preflight`
- [ ] Sync Starlight mirrors (`mise //docs:sync`)
- [ ] Verify: `mise //docs:build` passes
- [ ] Final PR targets `main` — squash-merge the full stack

## Acceptance criteria

- `DEPLOYMENT_ROLES.md` no longer contains raw JSON (points to generated artifacts)
- `AGENTS.md` correctly routes agents to bootstrap code and generated artifacts
- Deployment guide has clear operator instructions for fresh bootstrap and upgrades
- Starlight mirrors are in sync
- `mise run build` passes (full monorepo build including docs)

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit docs/design/DEPLOYMENT_ROLES.md, docs/guides/DEPLOYMENT_GUIDE.md und AGENTS.md und untersuche anschließend die aufgeführten Pfade unter cdk/src/bootstrap/ und cdk/bootstrap/. Verwende mise //docs:sync und mise //docs:build, um zu überprüfen, dass die Dokumentationsspiegel und der Build funktionieren. Als abgeschlossen gilt die Aufgabe, wenn die rohen Policy-Blobs entfernt, Routing und Operator-Workflows dokumentiert sind und mise run build erfolgreich ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
devops, documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Ruhig
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
72/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.