From 390408689100a545ae8d31cceb2eddf4c334d179 Mon Sep 17 00:00:00 2001 From: davidwells Date: Fri, 2 Sep 2016 13:18:12 -0700 Subject: [PATCH] update frontmatter --- docs/02-providers/aws/events/03-schedule.md | 1 - docs/02-providers/aws/events/README.md | 13 +++++++++++++ docs/03-cli-reference/03-invoke.md | 2 +- docs/03-cli-reference/04-logs.md | 10 +++++----- docs/03-cli-reference/05-info.md | 2 +- .../02-creating-provider-plugins.md | 1 - docs/04-extending-serverless/README.md | 5 +++++ docs/README.md | 11 ++++++++--- docs/usage-tracking.md | 1 - 9 files changed, 33 insertions(+), 13 deletions(-) create mode 100644 docs/02-providers/aws/events/README.md diff --git a/docs/02-providers/aws/events/03-schedule.md b/docs/02-providers/aws/events/03-schedule.md index 9276a77f6..d6c0e1806 100644 --- a/docs/02-providers/aws/events/03-schedule.md +++ b/docs/02-providers/aws/events/03-schedule.md @@ -3,7 +3,6 @@ title: AWS S3 Event configuration layout: Page --> - # Schedule The following config will attach a schedule event and causes the function `crawl` to be called every 2 hours. The configuration allows you to attach multiple schedules to the same function. You can either use the `rate` or `cron` syntax. Take a look at the [AWS schedule syntax documentation](http://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html) for more details. diff --git a/docs/02-providers/aws/events/README.md b/docs/02-providers/aws/events/README.md new file mode 100644 index 000000000..2186ee0b6 --- /dev/null +++ b/docs/02-providers/aws/events/README.md @@ -0,0 +1,13 @@ + + +# AWS serverless events + +* [API Gateway](./01-apigateway.md) +* [S3](./02-s3.md) +* [Schedule](./03-schedule.md) +* [SNS](./04-sns.md) +* [Kinesis Streams](./05-kinesis-streams.md) +* [DynamoDB Streams](./06-dynamodb-streams.md) diff --git a/docs/03-cli-reference/03-invoke.md b/docs/03-cli-reference/03-invoke.md index 2b69e6bd1..597b2b3cb 100644 --- a/docs/03-cli-reference/03-invoke.md +++ b/docs/03-cli-reference/03-invoke.md @@ -8,7 +8,7 @@ layout: Page Invokes a previously deployed function. It allows to send event data to the function and read logs and display other important information of the function invoke. -``` +```bash serverless invoke --function functionName ``` diff --git a/docs/03-cli-reference/04-logs.md b/docs/03-cli-reference/04-logs.md index 3672551b2..936f63981 100644 --- a/docs/03-cli-reference/04-logs.md +++ b/docs/03-cli-reference/04-logs.md @@ -8,7 +8,7 @@ layout: Page Lets you watch the logs of a specific function. -``` +```bash serverless logs -f hello ``` @@ -51,23 +51,23 @@ serverless logs -f hello **Note:** There's a small lag between invoking the function and actually having the log event registered in CloudWatch. So it takes a few seconds for the logs to show up right after invoking the function. -``` +```bash serverless logs -f hello --startTime 5h ``` This will fetch the logs that happened in the past 5 hours. -``` +```bash serverless logs -f hello --startTime 1469694264 ``` This will fetch the logs that happened starting at epoch `1469694264`. -``` +```bash serverless logs -f hello -t ``` Serverless will tail the CloudWatch log output and print new log messages coming in. -``` +```bash serverless logs -f hello --filter serverless ``` This will fetch only the logs that contain the string `serverless` diff --git a/docs/03-cli-reference/05-info.md b/docs/03-cli-reference/05-info.md index 5df61e964..4df7a7e9e 100644 --- a/docs/03-cli-reference/05-info.md +++ b/docs/03-cli-reference/05-info.md @@ -8,7 +8,7 @@ layout: Page Displays information about the deployed service. -``` +```bash serverless info ``` diff --git a/docs/04-extending-serverless/02-creating-provider-plugins.md b/docs/04-extending-serverless/02-creating-provider-plugins.md index abf1712ab..fb9939651 100644 --- a/docs/04-extending-serverless/02-creating-provider-plugins.md +++ b/docs/04-extending-serverless/02-creating-provider-plugins.md @@ -1,6 +1,5 @@ diff --git a/docs/04-extending-serverless/README.md b/docs/04-extending-serverless/README.md index 2696e1deb..b3a547a45 100644 --- a/docs/04-extending-serverless/README.md +++ b/docs/04-extending-serverless/README.md @@ -1,3 +1,8 @@ + + # Developing plugins Here you can read how to develop your own Serverless plugins. We'll get into details on how to write custom plugins to diff --git a/docs/README.md b/docs/README.md index 6f6811681..091d37a0d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -7,11 +7,12 @@ layout: Page Welcome to the Serverless documentation. -- [Quick Start: Check out our getting started guide](01-guide) -- [Providers](#providers) +- [Quick Start Guide](01-getting-started) - [Core Concepts](#concepts) +- [CLI Reference](03-cli-reference) +- [Providers](#providers) +- [Extending Serverless](04-extending-serverless) - [Contributing to Serverless](#contributing) -- [Anonymous Usage Tracking](./usage-tracking.md) ## Providers - [AWS Integration Docs](./02-providers/aws/) @@ -58,3 +59,7 @@ Connect with the community on [gitter](https://gitter.im/serverless/serverless) We love our contributors! Please read our [Contributing Document](CONTRIBUTING.md) to learn how you can start working on the Framework yourself. Check out our [help-wanted](https://github.com/serverless/serverless/labels/help-wanted) or [help-wanted-easy](https://github.com/serverless/serverless/labels/help-wanted-easy) labels to find issues we want to move forward on with your help. + +## Usage Tracking + +[Anonymous Usage Tracking](./usage-tracking.md) \ No newline at end of file diff --git a/docs/usage-tracking.md b/docs/usage-tracking.md index 5e30afe15..38e888ec3 100644 --- a/docs/usage-tracking.md +++ b/docs/usage-tracking.md @@ -3,7 +3,6 @@ title: Serverless Usage Tracking layout: Page --> - # Usage tracking Serverless will automatically track anonymous usage data. This is done so that we better understand the usage and needs