aws-samples / aws-samples/sample-autonomous-cloud-coding-agents
docs(bootstrap): update DEPLOYMENT_ROLES.md, AGENTS.md, deployment guide
まだ誰も着手していません。
- 主要言語
- TypeScript
- スター
- 146
- フォーク
- 46
- 平均マージ
- 3日 10時間
- マージ済み PR(30日)
- 24
説明
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 fromcdk/src/bootstrap/" - "Commands you can use": add
mise //cdk:bootstrap,mise //cdk:bootstrap:generate,mise //cdk:preflight
- Routing table: add
- Sync Starlight mirrors (
mise //docs:sync) - Verify:
mise //docs:buildpasses - Final PR targets
main— squash-merge the full stack
Acceptance criteria
DEPLOYMENT_ROLES.mdno longer contains raw JSON (points to generated artifacts)AGENTS.mdcorrectly 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 buildpasses (full monorepo build including docs)
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
docs/design/DEPLOYMENT_ROLES.md、docs/guides/DEPLOYMENT_GUIDE.md、AGENTS.md から始め、続いて cdk/src/bootstrap/ と cdk/bootstrap/ にある一覧記載のパスを調べます。mise //docs:sync と mise //docs:build を使って、ドキュメントのミラーとビルドを検証します。raw policy blobs が削除され、routing と operator workflows が文書化され、mise run build が成功すれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- devops, documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 静か
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 72/100