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

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

Ouverte
#128 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
documentation enhancement infra-cdk
Langage dominant
TypeScript
Étoiles
143
Forks
46
Merge moyen
3 j 10 h
PR mergées (30 j)
24

Description

## 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)

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par docs/design/DEPLOYMENT_ROLES.md, docs/guides/DEPLOYMENT_GUIDE.md et AGENTS.md, puis examinez les chemins indiqués sous cdk/src/bootstrap/ et cdk/bootstrap/. Utilisez mise //docs:sync et mise //docs:build pour vérifier les miroirs de la documentation et le build. Le travail est terminé lorsque les blobs de policy bruts ont été supprimés, que le routing et les workflows des opérateurs sont documentés, et que mise run build réussit.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
typescript
Domaine
devops, documentation
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
Calme
Clarté
Clairement spécifiée
Accessibilité débutants
72/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.