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.

Sign up for GitHub

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

Jump to bottom

Publish AWS Construct Library Guidelines #6506

Closed
jusiskin opened this issue Feb 28, 2020 · 2 comments
Closed

Publish AWS Construct Library Guidelines #6506

jusiskin opened this issue Feb 28, 2020 · 2 comments
Labels
@aws-cdk/core Related to core CDK functionality closed-for-staleness This issue was automatically closed because it hadn't received any attention in a while. docs/repo-general Related to repo documentation (CONTRIBUTING, CODE_OF_CONDUCT, etc.) effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p1

Comments

@jusiskin
Copy link
Contributor

https://github.com/aws/aws-cdk/blob/fc379d663bdeaec92c4dcb20e2f76c081fffaa9f/design/aws-guidelines.md#exports

This section in the AWS Guidelines documentation states that every resource interface and resource should implement an export() method. It provides code snippets to do this. In attempting this, I found that the code snippet does not work. I discovered that the corresponding linter rule export has been inverted and exports are now deprecated.

This is a 📕 documentation issue
@jusiskin jusiskin added feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Feb 28, 2020
@SomayaB SomayaB added the docs/repo-general Related to repo documentation (CONTRIBUTING, CODE_OF_CONDUCT, etc.) label Mar 2, 2020
@rix0rrr rix0rrr added the effort/small Small work item – less than a day of effort label Mar 3, 2020
@rix0rrr rix0rrr changed the title Stale exports documentation in AWS guidelines Publicize AWS Construct Library Guidelines Mar 3, 2020
@rix0rrr rix0rrr changed the title Publicize AWS Construct Library Guidelines Publish AWS Construct Library Guidelines Mar 3, 2020
@rix0rrr
Copy link
Contributor

rix0rrr commented Mar 3, 2020

The actual Construct Library Guidelines are in an internal doc. We should publish them publicly.

@rix0rrr rix0rrr added @aws-cdk/core Related to core CDK functionality and removed needs-triage This issue or PR still needs to be triaged. labels Mar 3, 2020
@wulfmann wulfmann mentioned this issue Jul 11, 2020
Closed
@rix0rrr rix0rrr added the p1 label Aug 12, 2020
@github-actions
Copy link

This issue has not received any attention in 1 year. If you want to keep this issue open, please leave a comment below and auto-close will be canceled.

@github-actions github-actions bot added closing-soon This issue will automatically close in 4 days unless further comments are made. closed-for-staleness This issue was automatically closed because it hadn't received any attention in a while. and removed closing-soon This issue will automatically close in 4 days unless further comments are made. labels Jun 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
@aws-cdk/core Related to core CDK functionality closed-for-staleness This issue was automatically closed because it hadn't received any attention in a while. docs/repo-general Related to repo documentation (CONTRIBUTING, CODE_OF_CONDUCT, etc.) effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p1
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@rix0rrr @SomayaB @jusiskin