From 5c426ecf6eff0efd0f9f1fdccf0b78ed7fca64e1 Mon Sep 17 00:00:00 2001 From: jeffnoehren Date: Tue, 3 Oct 2017 14:49:29 -0700 Subject: [PATCH] updating spotinst homepage readme --- docs/providers/spotinst/README.md | 92 ++++++++++++++----- .../spotinst/cli-reference/README.md | 2 +- docs/providers/spotinst/events/schedule.md | 6 +- docs/providers/spotinst/guide/permissions.md | 0 4 files changed, 74 insertions(+), 26 deletions(-) create mode 100644 docs/providers/spotinst/guide/permissions.md diff --git a/docs/providers/spotinst/README.md b/docs/providers/spotinst/README.md index 0672b9785..0f6cb3497 100755 --- a/docs/providers/spotinst/README.md +++ b/docs/providers/spotinst/README.md @@ -1,6 +1,6 @@ @@ -14,28 +14,72 @@ Welcome to the Serverless Spotinst documentation! If you have questions, join the [chat in gitter](https://gitter.im/serverless/serverless) or [post over on the forums](https://forum.serverless.com/) -## Getting Started +
+
+
+ + Serverless Spotinst Guide + +
+ +
-Get started here by reading the guide + -## CLI reference +
+
+ + Serverless Spotinst Events + +
+
+ +
+
- - -## Supported Events - +
+
+ + Serverless Framework AWS Lambda Examples + +
+
+
+ +
+
+
+
diff --git a/docs/providers/spotinst/cli-reference/README.md b/docs/providers/spotinst/cli-reference/README.md index f4efe854c..87cb241ee 100755 --- a/docs/providers/spotinst/cli-reference/README.md +++ b/docs/providers/spotinst/cli-reference/README.md @@ -14,4 +14,4 @@ Welcome to the Serverless Spotinst Functions CLI Reference! Please select a section on the left to get started. -**Note:** Before continuing [Spotinst Functions credentials](../guide/credentials.md) are required for using the CLI.. +**Note:** Before continuing [Spotinst Functions credentials](../guide/credentials.md) are required for using the CLI. diff --git a/docs/providers/spotinst/events/schedule.md b/docs/providers/spotinst/events/schedule.md index 19621cbeb..6c8c5511b 100755 --- a/docs/providers/spotinst/events/schedule.md +++ b/docs/providers/spotinst/events/schedule.md @@ -12,14 +12,18 @@ layout: Doc # Schedule -You can trigger the functions by using a scheduled event. This will execute the function according to the cron expressions you specify +You can trigger the functions by using a scheduled event. This will execute the function according to the cron expressions you specify. You can either use the `rate` or `cron` syntax. +The following two examples are function configurations in the serverless.yml file that are scheduled to trigger the function crawl every 2 hours. You are able to attach more than one schedule to a function. + + ```yml functions: crawl: handler: crawl events: + - schedule: rate(2 hours) - schedule: cron(0 12 * * ? *) ``` diff --git a/docs/providers/spotinst/guide/permissions.md b/docs/providers/spotinst/guide/permissions.md new file mode 100644 index 000000000..e69de29bb