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

Surface integration tests as samples #883

Closed
eladb opened this issue Oct 10, 2018 · 5 comments
Closed

Surface integration tests as samples #883

eladb opened this issue Oct 10, 2018 · 5 comments
Assignees
@Doug-AWS
Labels
docs/guide Related to the developer guide effort/large Large work item – several weeks of effort

Comments

@eladb
Copy link
Contributor

eladb commented Oct 10, 2018

We have many integration tests in our code base and most of them should be relevant as examples for how to use various features of the CDK. If only we added a bit of commentary, we could technically add them all as examples to our docs.
@eladb
Copy link
Contributor Author

eladb commented Oct 10, 2018

Copy: @ccfife @Doug-AWS

@jungseoklee
Copy link
Contributor

I love the idea, but a minor comment. Some tests focus on "testing" itself rather than "documentation". Thus, how about having annotation and surface tests having the annotation only?

@Doug-AWS Doug-AWS added the docs/guide Related to the developer guide label Jan 23, 2019
@Doug-AWS
Copy link
Contributor

See (kinda related) #1277

@Doug-AWS Doug-AWS added p2 effort/large Large work item – several weeks of effort labels Jan 29, 2019
@Doug-AWS
Copy link
Contributor

The only way this works is using automation/script. Putting in the backlog for now.

@Doug-AWS Doug-AWS self-assigned this Feb 26, 2019
@Doug-AWS Doug-AWS changed the title Surface integration tests as samples in our docs Surface integration tests as samples Feb 27, 2019
@Doug-AWS Doug-AWS removed the p2 label Apr 16, 2019
@Doug-AWS Doug-AWS mentioned this issue Jun 21, 2019
Open
@Doug-AWS
Copy link
Contributor

Moving guide issues to doc repo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Doug-AWS Doug-AWS

Labels
docs/guide Related to the developer guide effort/large Large work item – several weeks of effort
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@eladb @jungseoklee @Doug-AWS