Made some edits in Getting Started #420
Merged
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
eladb
suggested changes
Jul 27, 2018
|
|
||
| Now, we will install the CDK core library (:py:mod:`@aws-cdk/cdk`). This | ||
| library includes the basic classes needed to write CDK stacks and apps. | ||
| Add @aws-cdk/core as a Dependency |
There was a problem hiding this comment.
Revert, the name of the code package is now @aws-cdk/cdk
| Add @aws-cdk/core as a Dependency | ||
| ================================= | ||
|
|
||
| Install the |cdk| core library (:py:mod:`_aws-cdk_core`). This |
There was a problem hiding this comment.
References to modules should be :py:mod:`@aws-cdk/cdk`. Please make sure you verify that they work.
| Use **y-npm** to install the **@aws-cdk/cdk** package. We also need **@types/node** | ||
| since we will be using **process.argv** in our code: | ||
| Install the **@aws-cdk/core** package and the **@types/node**, | ||
| the latter to use **process.argv**: |
|
|
||
| CDK apps are modeled as classes which extend the :py:class:`@aws-cdk/cdk.App` | ||
| |cdk| apps are modeled as classes which extend the :py:class:`_aws-cdk_core.App` |
| @@ -0,0 +1,204 @@ | |||
| .. Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. | |||
There was a problem hiding this comment.
Perhaps separate into another PR
There was a problem hiding this comment.
Not sure how I got the tutorial in here as it is in it's own PR. I'll remove it.
eladb
suggested changes
Jul 30, 2018
| @@ -37,6 +37,8 @@ | |||
| .. |npm-package| replace:: aws-cdk-tools | |||
| .. |nuget-package| replace:: aws-cdk | |||
| .. |maven-id| replace:: aws-cdk | |||
| .. |git-repo| replace:: https://github.com/awslabs/aws-cdk | |||
| .. |npm-cmd| replace:: y-npm | |||
eladb
suggested changes
Jul 30, 2018
| @@ -600,7 +600,7 @@ Install the **@aws-cdk/s3** package: | |||
| there is no need to explicitly install the |S3| library. | |||
|
|
|||
| Next, define an |S3| bucket in the stack. |S3| buckets are represented by | |||
| the :py:class:`_aws-cdk_s3.Bucket` class: | |||
| the :py:class:`#aws-cdk/aws-s3.Bucket` class: | |||
There was a problem hiding this comment.
This should be @aws-cdk (with "@")
eladb
approved these changes
Jul 31, 2018
This was referenced Apr 24, 2023
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.
By submitting this pull request, I confirm that my contribution is made under
the terms of the beta license.
Removed a lot of future tense (the xxx will ...); general tidying up.