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

Made some edits in Getting Started #420

Merged
merged 10 commits into from
Jul 31, 2018
Merged

Made some edits in Getting Started #420

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
a8cb53b
Working on tutorial
Doug-AWS Jul 24, 2018
36656c1
Suspending tutorial work until API Gateway L2 is available
Doug-AWS Jul 24, 2018
1418f92
Tidied up Getting Started
Doug-AWS Jul 26, 2018
ff18231
Working on tutorial
Doug-AWS Jul 24, 2018
ef0fa9e
Suspending tutorial work until API Gateway L2 is available
Doug-AWS Jul 24, 2018
8417871
Merged update
Doug-AWS Jul 26, 2018
79e4df2
Fixed merge issue
Doug-AWS Jul 26, 2018
f042fc7
Removed erroneous tutorial
Doug-AWS Jul 30, 2018
f4a4538
Updated Getting Started topic with feedback from Elad
Doug-AWS Jul 30, 2018
1766551
Fixed aws-cdk reference
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
2 changes: 1 addition & 1 deletion packages/aws-cdk-docs/src/_includes.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
.. |nuget-package| replace:: aws-cdk
.. |maven-id| replace:: aws-cdk
.. |git-repo| replace:: https://github.com/awslabs/aws-cdk
.. |npm-cmd| replace:: y-npm
.. |npm-cmd| replace:: npm

.. Construct levels

Expand Down
20 changes: 10 additions & 10 deletions packages/aws-cdk-docs/src/getting-started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,17 +115,17 @@ Create an empty project structure for the |cdk| app.

.. _add_core:

Add @aws-cdk/core as a Dependency
=================================
Add @aws-cdk/cdk as a Dependency
================================

Install the |cdk| core library (:py:mod:`_aws-cdk_core`). This
Install the |cdk| core library (:py:mod:`@aws-cdk/cdk`). This
library includes the basic classes needed to write |cdk| stacks and apps.

.. tabs::

.. group-tab:: JavaScript

Install the **@aws-cdk/core** package:
Install the **@aws-cdk/cdk** package:

.. code-block:: sh

Expand All @@ -138,8 +138,8 @@ library includes the basic classes needed to write |cdk| stacks and apps.

.. group-tab:: TypeScript

Install the **@aws-cdk/core** package and the **@types/node**,
the latter to use **process.argv**:
Install the **@aws-cdk/cdk** package and the **@types/node**,
the latter to use **process.argv**:

.. code-block:: sh

Expand Down Expand Up @@ -181,7 +181,7 @@ library includes the basic classes needed to write |cdk| stacks and apps.
Define the |cdk| App
====================

|cdk| apps are modeled as classes which extend the :py:class:`_aws-cdk_core.App`
|cdk| apps are modeled as classes which extend the :py:class:`@aws-cdk/cdk.App`
class. Let's create our first, empty **App**:

.. tabs::
Expand Down Expand Up @@ -342,7 +342,7 @@ your project directory:

.. group-tab:: Java

Specify a
Specify a
**CLASSPATH**, which contains both the compiled code and dependencies,
to execute the Java program.
Use **maven-dependency-plugin** to produce the file **.classpath.txt**
Expand Down Expand Up @@ -578,7 +578,7 @@ there's nothing to deploy.

Let's define an |S3| bucket.

Install the **@aws-cdk/s3** package:
Install the **@aws-cdk/aws-s3** package:

.. tabs::

Expand All @@ -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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be @aws-cdk (with "@")


.. tabs::

Expand Down