Skip to content

[Documentation Improvement]: Mention the CDK Stage construct in the 'Best Practices' section. #495

Description

@lutzfe

Documentation Area

Application best practices --> section: Model all production stages in code

Enhancement Description

Mention CDK Stage construct.
The documentation simply describes the principle of creating a stack for each deployment environment. However, it does not mention the CDK Stage construct, which was built for precisely that purpose.
I have encountered this issue myself. Reading this section, I would like to find out if CDK already provides a solution to help implement this best practice.

Why is this enhancement needed?

This is particularly useful for developers who want to streamline their workflow and avoid duplicate code. For example, they could write their own stage construct, as I did.

Proposed Content

Add a new paragraph to the section Model all production stages in code:
f.e. Take a look at the CDK Stage construct, which facilitates parametrisation.

Links

https://docs.aws.amazon.com/cdk/v2/guide/stages.html
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.Stage.html

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions