Java Getting Started (+ rewrite without "cdk init") #245
Conversation
Add getting started and welcome in Java (and JavaScript). Rewrite "Getting Started" to detail the process of defining CDK apps without using `cdk init`. This is in order to improve the understanding of users when they onboard the CDK, which fixes #219. Fix TOC to include only two layers deep which fixes #129.
|
|
||
| Metric objects | ||
| -------------- | ||
| ## Metrics |
There was a problem hiding this comment.
Haha :) I had this changed in my local copy. Thanks :P
| @@ -76,7 +95,7 @@ in :doc:`getting-started`. | |||
|
|
|||
| The process of creating your AWS resources using the |cdk| is straightforward: | |||
|
|
|||
| 1. Install the |cdk| on your development machine | |||
| 1. Install the |cdk| on your development machine (see setup instructions in README). | |||
There was a problem hiding this comment.
Consider making README a link... Or at least hint on where to find it.
There was a problem hiding this comment.
This will change post-beta anyway
| .. code-tab:: ts | ||
|
|
||
| import { App, Stack, StackProps } from '@aws-cdk/core'; | ||
| import * as cdk from '@aws-cdk/core'; |
There was a problem hiding this comment.
There's some interesting discussions to be had on import * as foo from 'bar'; versus import { Foo, Baz } from 'bar';. I think we should devise some kind of a guideline...
There was a problem hiding this comment.
I agree. I think we should move away from instructing people to import individual classes because the CDK is a huge class library and we occasionally use names that are contextual. I think codecommit.Repository and cdk.App read much better than Repository and App.
If you guys agree, I will open an issue to track converting our examples to this scheme.
|
Quick question about cdk.json for TypeScript, which currently shows: { Should it be: { |
|
@Doug-AWS Nope - it's the javascript (aka compiled code) that |
|
Gotcha |
…sting-s3-bucket chore: revert change to lambda event source
Add getting started and welcome in Java (and JavaScript).
Rewrite "Getting Started" to detail the process of defining CDK apps
without using
cdk init. This is in order to improve the understandingof users when they onboard the CDK, which fixes #219.
Download rendered docs for your viewing pleasure.