Skip to content

Commit

Permalink
Java Getting Started (+ rewrite without "cdk init") (#245)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
Elad Ben-Israel authored Jul 9, 2018
1 parent 00976d9 commit e4240d2
Show file tree
Hide file tree
Showing 5 changed files with 744 additions and 239 deletions.
18 changes: 5 additions & 13 deletions packages/@aws-cdk/cloudwatch/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
Add alarms and graphs to CDK applications
=========================================

Metric objects
--------------
## Metrics

Metric objects represent a metric that is emitted by AWS services or your own
application, such as `CPUUsage`, `FailureCount` or `Bandwidth`.
Expand All @@ -19,8 +15,7 @@ represents the amount of errors reported by that Lambda function:
const errors = lambda.metricErrors();
```

Aggregation
-----------
### Aggregation

To graph or alarm on metrics you must aggregate them first, using a function
like `Average` or a percentile function like `P99`. By default, most Metric objects
Expand Down Expand Up @@ -63,8 +58,7 @@ useful when embedding them in graphs, see below).
> happen to know the Metric you want to alarm on makes sense as a rate
> (`Average`) you can always choose to change the statistic.
Alarms
------
## Alarms

Alarms can be created on metrics in one of two ways. Either create an `Alarm`
object, passing the `Metric` object to set the alarm on:
Expand Down Expand Up @@ -94,8 +88,7 @@ The most important properties to set while creating an Alarms are:
- `evaluationPeriods`: how many consecutive periods the metric has to be
breaching the the threshold for the alarm to trigger.

Making Dashboards
-----------------
## Dashboards

Dashboards are set of Widgets stored server-side which can be accessed quickly
from the AWS console. Available widgets are graphs of a metric over time, the
Expand Down Expand Up @@ -168,8 +161,7 @@ dashboard.add(new TextWidget({
}));
```

Dashboard Layout
----------------
### Dashboard Layout

The widgets on a dashboard are visually laid out in a grid that is 24 columns
wide. Normally you specify X and Y coordinates for the widgets on a Dashboard,
Expand Down
2 changes: 1 addition & 1 deletion packages/@aws-cdk/rtv/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Runtime Values
## Runtime Values

The CDK allows apps to advertise values from __construction time__ to __runtime
code__. For example, consider code in a Lambda function which needs to know the
Expand Down
Loading

0 comments on commit e4240d2

Please sign in to comment.