Add pkglint rule to require the presence of a README.md file #442
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
And created the missing README.md files so that pkglint is happy.
eladb
approved these changes
Jul 31, 2018
packages/aws-cdk/README.md
Outdated
| $ cdk synthesize --app='node bin/main.js' StackName | ||
|
|
||
| # Generate the template for StackName and save it to template.yml | ||
| $ cdk synthesize --app='node bin/main.js' StackName --output=template.yml |
There was a problem hiding this comment.
Change to MyStackName (so it's clear it's a user-defined value and not a switch)
packages/aws-cdk/README.md
Outdated
|
|
||
| ```shell | ||
| # Generate the template for StackName and output it to STDOUT | ||
| $ cdk synthesize --app='node bin/main.js' StackName |
packages/aws-cdk/README.md
Outdated
| ``` | ||
|
|
||
| #### `cdk deploy` | ||
| Deploys a stack of your CDK application to it's environment. During the deployment, the toolkit will output progress |
There was a problem hiding this comment.
Use "CDK app" instead of "CDK application"
packages/aws-cdk/README.md
Outdated
|
|
||
| #### `cdk diff` | ||
| Computes differences between the infrastructure specified in the current state of the CDK Application and the currently | ||
| deployed application (or a user-specified CloudFomration template). This command returns non-`0` if any differences are |
There was a problem hiding this comment.
Fomration => Formation
I would use "non-zero" instead of "non-0"
| @@ -0,0 +1,162 @@ | |||
| ## AWS CDK Toolkit | |||
| The AWS CDK Toolkit provides the `cdk` command-line interface that can be used to work with AWS CDK applications. | |||
|
|
|||
There was a problem hiding this comment.
- I would provide a one-line summary at the top of all the commands with links
- The order of command should "tell a story": init, list, synth, deploy, diff (and then bootstrap, docs, etc).
There was a problem hiding this comment.
I'm not sure I understand your 1. here -- but I agree with 2. (initially intended to, somehow lost it at some point -- already re-organized the sections).
There was a problem hiding this comment.
✅ I've tried something - I hope that's what you meant :)
eladb
approved these changes
Jul 31, 2018
packages/aws-cdk/README.md
Outdated
| This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. | ||
|
|
||
| ### Commands | ||
| Command | Description |
There was a problem hiding this comment.
Perfect. Obviously over-done ;-)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
And created the missing
README.mdfiles so that pkglint is happy.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.