(aws-cdk-lib): Better Document Stages
- Dominant language
- TypeScript
- Stars
- 12.9k
- Forks
- 4.6k
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 83
Description
### Describe the issue
A common concept in a lot of recent frameworks in the concept of "Stacks" or "Stages" as discreet environment-specific configurations of Stacks.
The CDK even has the concept of [Stages](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.Stage.html), but it's largely relegated to documenting it's usage in the context of CDK Pipelines.
I'd love to see the documentation expanded to describe how one would use stages in a manner similar to Serverless Framework, SST, or Pulumi Stacks, and how to deploy specific stages via the CLI without using pipelines.
### Links
https://docs.aws.amazon.com/cdk/v2/guide/stacks.html
https://docs.aws.amazon.com/cdk/v2/guide/environments.html
Contributor guide
Research direction
Start with the linked CDK stacks and environments guide pages and review how Stage usage is currently documented for CDK Pipelines. Done means the documentation explains framework-style, environment-specific stages and how to deploy a selected stage through the CLI without pipelines.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws, typescript
- Domain
- cli, cloud, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100