docs: updated "Getting Started" topic #1045
Conversation
…labs/aws-cdk into dougsch/test-getting-started
…labs/aws-cdk into dougsch/test-getting-started
docs/src/getting-started.rst
Outdated
|
|
||
| .. _setup_recommendations: | ||
|
|
||
| Recommendations |
There was a problem hiding this comment.
This is not really a recommendation. It's required
There was a problem hiding this comment.
I'll remove the "Recommendations" heading.
docs/src/getting-started.rst
Outdated
| `Node.js (>= 8.11.x) <https://nodejs.org/en/download>`_ to use the command-line | ||
| toolkit and language bindings. | ||
|
|
||
| You must set the `JAVA_HOME` environment variable to the path to where you have |
There was a problem hiding this comment.
I would start the sentence with "If you use Java...", so people can "bail out" early if they don't care
docs/src/getting-started.rst
Outdated
| This guide walks you through the process of creating an |cdk| project. | ||
| You can also use the | ||
| :code:`cdk init` command to create a skeleton project from a | ||
| template in any of the supported languages except JavaScript. |
There was a problem hiding this comment.
That's going to be outdated soon. Maybe we can just write "in supported languages".
| } | ||
| } | ||
|
|
||
| .. group-tab:: Java | ||
|
|
||
| Create an empty source-controlled directory for your project: |
There was a problem hiding this comment.
It (git init) is already there in the others.
| .. code-block:: sh | ||
|
|
||
| .classpath.txt | ||
| target |
There was a problem hiding this comment.
Stoopid editor. I've replaced all tabs.
docs/src/getting-started.rst
Outdated
| @@ -158,8 +207,7 @@ library includes the basic classes needed to write |cdk| stacks and apps. | |||
|
|
|||
| .. group-tab:: TypeScript | |||
|
|
|||
| Install the **@aws-cdk/cdk** package and the **@types/node** (the latter | |||
| is needed because we reference **process.argv** in our code): | |||
| Install the **@aws-cdk/cdk** and the **@types/node** packages: | |||
There was a problem hiding this comment.
@types/node is actually not needed anymore
docs/src/getting-started.rst
Outdated
| public static void main(final String argv[]) { | ||
| App app = new App(); | ||
|
|
||
| // Create your stacks here as: |
There was a problem hiding this comment.
I'll remove it as we add a stack later.
docs/src/getting-started.rst
Outdated
|
|
||
| .. tabs:: | ||
|
|
||
| .. group-tab:: JavaScript | ||
|
|
||
| In **index.js**: | ||
| Create the file **hello-cdk.js** in the **bin** folder: |
There was a problem hiding this comment.
I think it's clearer if you write it as bin/hello-cdk.js
…labs/aws-cdk into dougsch/test-getting-started
|
ping |
|
Please merge from master: $ git fetch origin
$ git merge origin/master
$ git push origin dougsch/test-getting-started |
|
Okay, 1 file changed |
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.
I updated the topic based on the feedback from issue #1044; updated code based on V 0.14.1.