Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Add content to @aws-cdk/core README #3167

Merged
merged 3 commits into from
Jul 3, 2019
Merged

Conversation

RomainMuller
Copy link
Contributor

Adds high-leveld escription of the APIs that offer access to low-level
CloudFormation features.


Please read the contribution guidelines and follow the pull-request checklist.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@RomainMuller RomainMuller requested a review from a team as a code owner July 2, 2019 10:50
@ghost ghost requested a review from rix0rrr July 2, 2019 10:50
Adds high-leveld escription of the APIs that offer access to low-level
CloudFormation features.
@RomainMuller RomainMuller force-pushed the rmuller/core-readme branch from f618ae9 to 4437d87 Compare July 2, 2019 10:57
packages/@aws-cdk/core/README.md Outdated Show resolved Hide resolved
the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) (AWS CDK).
This library includes the basic building blocks of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk)
(AWS CDK).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you take a pass at thinking through this README? This is the core library and this readme is actually the most important one? I feel it could use some TLC. A bit of discussion and/or links to user manual around constructs, stacks and apps, etc.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed, this will be done in a second pass, so as not to delay the nice new content.

packages/@aws-cdk/core/README.md Outdated Show resolved Hide resolved
packages/@aws-cdk/core/README.md Outdated Show resolved Hide resolved
packages/@aws-cdk/core/README.md Outdated Show resolved Hide resolved
packages/@aws-cdk/core/README.md Outdated Show resolved Hide resolved
@RomainMuller RomainMuller merged commit 4b88621 into master Jul 3, 2019
@RomainMuller RomainMuller deleted the rmuller/core-readme branch July 3, 2019 11:07
Kaixiang-AWS pushed a commit to Kaixiang-AWS/aws-cdk that referenced this pull request Jul 3, 2019
Adds high-leveld escription of the APIs that offer access to low-level
CloudFormation features.
@NGL321 NGL321 added the contribution/core This is a PR that came from AWS. label Sep 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants