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

Add pkglint rule to require the presence of a README.md file #442

Merged
merged 8 commits into from
Jul 31, 2018
Merged

Add pkglint rule to require the presence of a README.md file #442

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0a7a29b
Add pkglint rule to require the presence of a README.md file
RomainMuller Jul 31, 2018
8e2be0e
Some twaks to aws-cdk/README.md
RomainMuller Jul 31, 2018
8283e97
Switch JSON block to use JS highlighter, so comments are handled prop…
RomainMuller Jul 31, 2018
feba50c
Switch shell examples to 'console' formatter
RomainMuller Jul 31, 2018
af015c3
Prefix comments with $ in shell sessions.
RomainMuller Jul 31, 2018
d3073e0
Table of contents for the commands
RomainMuller Jul 31, 2018
db63f01
Correct anchor
RomainMuller Jul 31, 2018
fa821c9
Move TOC before Commands heading
RomainMuller Jul 31, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Prefix comments with $ in shell sessions.
  • Loading branch information
@RomainMuller
RomainMuller committed Jul 31, 2018
commit af015c3003fb3aca09fb6ab2f5af7a699c0af255
26 changes: 13 additions & 13 deletions packages/aws-cdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ against your currently deployed infrastructure, [deploying](#cdk-deploy) into AW
Outputs the URL to the documentation for the current toolkit version, and attempts to open a browser to that URL.

```console
# Open the documentation in the default browser (using 'open')
$ # Open the documentation in the default browser (using 'open')
$ cdk docs
https://awslabs.github.io/aws-cdk/versions/0.7.4-beta/

# Open the documentation in Chrome.
$ # Open the documentation in Chrome.
$ cdk docs --browser='chrome %u'
https://awslabs.github.io/aws-cdk/versions/0.7.4-beta/
```
Expand All @@ -25,29 +25,29 @@ https://awslabs.github.io/aws-cdk/versions/0.7.4-beta/
Creates a new CDK project.

```console
# List the available template types & languages
$ # List the available template types & languages
$ cdk init --list
Available templates:
* app: Template for a CDK Application
└─ cdk init app --language=[java|typescript]
* lib: Template for a CDK Construct Library
└─ cdk init lib --language=typescript

# Create a new library application in typescript
$ # Create a new library application in typescript
$ cdk init lib --language=typescript
```

#### `cdk list`
Lists the stacks modeled in the CDK app.

```console
# List all stacks in the CDK app 'node bin/main.js'
$ # List all stacks in the CDK app 'node bin/main.js'
$ cdk list --app='node bin/main.js'
Foo
Bar
Baz

# List all stack including all details (add --json to output JSON instead of YAML)
$ # List all stack including all details (add --json to output JSON instead of YAML)
$ cdk list --app='node bin/main.js' --long
-
name: Foo
Expand Down Expand Up @@ -77,13 +77,13 @@ will be generated in the output folder for each stack.
By default, templates are generated in YAML format. The `--json` option can be used to switch to JSON.

```console
# Generate the template for StackName and output it to STDOUT
$ # Generate the template for StackName and output it to STDOUT
$ cdk synthesize --app='node bin/main.js' MyStackName

# Generate the template for MyStackName and save it to template.yml
$ # Generate the template for MyStackName and save it to template.yml
$ cdk synth --app='node bin/main.js' MyStackName --output=template.yml

# Generate templates for all the stacks and save them into templates/
$ # Generate templates for all the stacks and save them into templates/
$ cdk synth --app='node bin/main.js' --output=templates
```

Expand All @@ -93,10 +93,10 @@ deployed application (or a user-specified CloudFormation template). This command
found.

```console
# Diff against the currently deployed stack
$ # Diff against the currently deployed stack
$ cdk diff --app='node bin/main.js' MyStackName

# Diff against a specific template document
$ # Diff against a specific template document
$ cdk diff --app='node bin/main.js' MyStackName --template=path/to/template.yml
```

Expand Down Expand Up @@ -125,10 +125,10 @@ Deploys a `CDKToolkit` CloudFormation stack into the specified environment(s), t
update. The name of the deployed stack can be configured using the `--toolkit-stack-name` argument.

```console
# Deploys to all environments
$ # Deploys to all environments
$ cdk bootstrap --app='node bin/main.js'

# Deploys only to environments foo and bar
$ # Deploys only to environments foo and bar
$ cdk bootstrap --app='node bin/main.js' foo bar
```

Expand Down