Add front matter to the examples readme for pusblishing to site.

wafamhamdi · May 18, 2017 · 08b69fd · 08b69fd
1 parent 6772c74
commit 08b69fd
Show file tree

Hide file tree

Showing 41 changed files with 205 additions and 0 deletions.
diff --git a/aws-java-simple-http-endpoint/README.md b/aws-java-simple-http-endpoint/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS Simple HTTP Endpoint example in Java
+description: This example demonstrates how to setup a simple HTTP GET endpoint using Java. Once you ping it, it will reply with the current time.
+layout: Doc
+-->
 # Simple HTTP Endpoint Example
 
 This example demonstrates how to setup a simple HTTP GET endpoint using Java. Once you ping it, it will reply with the current time.

diff --git a/aws-node-alexa-skill/README.md b/aws-node-alexa-skill/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS Serverless Alexa Skill example in NodeJS
+description: This example demonstrates how to setup your own Alexa skill using AWS Lambdas.
+layout: Doc
+-->
 # Serverless Alexa Skill Example
 
 This example demonstrates how to setup your own Alexa skill using AWS Lambdas.

diff --git a/aws-node-auth0-custom-authorizers-api/README.md b/aws-node-auth0-custom-authorizers-api/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS API Gateway Custom Authorizer Function with Auth0 example in NodeJS
+description: This is an example of how to protect API endpoints with Auth0, JSON Web Tokens (jwt) and a custom authorizer lambda function.
+layout: Doc
+-->
 # API Gateway Custom Authorizer Function + Auth0
 
 This is an example of how to protect API endpoints with [auth0](https://auth0.com/), JSON Web Tokens (jwt) and a [custom authorizer lambda function](https://serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-custom-authorizers).

diff --git a/aws-node-env-variables-encrypted-in-a-file/README.md b/aws-node-env-variables-encrypted-in-a-file/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS Storing Encrypted Secrets example in NodeJS
+description: This example demonstrates how to store secrets like API keys encrypted in your repository while providing them as environment variables to your AWS Lambda functions.
+layout: Doc
+-->
 # Serverless
 
 IMPORTANT NOTE: As pointed out in the [AWS documentation](http://docs.aws.amazon.com/lambda/latest/dg/env_variables.html) for storing sensible the `Ciphertext` should be stored in the environment variables. This tutorial doesn't go into that yet, but we will update it soon accordingly.

diff --git a/aws-node-env-variables/README.md b/aws-node-env-variables/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS Serverless Environment Variables Usage example in NodeJS
+description: This example demonstrates how to use environment variables for AWS Lambdas.
+layout: Doc
+-->
 # Serverless Environment Variables Usage
 
 This example demonstrates how to use environment variables for AWS Lambdas.

diff --git a/aws-node-fetch-file-and-store-in-s3/README.md b/aws-node-fetch-file-and-store-in-s3/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS Fetch image from URL and upload to S3 example in NodeJS
+description: This example display how to fetch an image from remote source (URL) and then upload this image to a S3 bucket.
+layout: Doc
+-->
 # Fetch image from URL then upload to s3 Example
 
 This example display how to fetch an image from remote source (URL) and then upload this image to a S3 bucket.

diff --git a/aws-node-function-compiled-with-babel/README.md b/aws-node-function-compiled-with-babel/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS Function compiled with Babel example in NodeJS
+description: This example demonstrates how to compile your JavaScript code with Babel. In order to do so the 'serverless-babel-plugin' is leveraged.
+layout: Doc
+-->
 # Function compiled with Babel
 
 This example demonstrates how to compile your JavaScript code with Babel. In order to do so the `serverless-babel-plugin` is leveraged.

diff --git a/aws-node-github-webhook-listener/README.md b/aws-node-github-webhook-listener/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS Serverless Github Webhook Listener example in NodeJS
+description: This service will listen to github webhooks fired by a given repository.
+layout: Doc
+-->
 # Serverless Github webhook listener
 
 This service will listen to github webhooks fired by a given repository.

diff --git a/aws-node-iot-event/README.md b/aws-node-iot-event/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS Serverless IoT Event example in NodeJS
+description: This example demonstrates how to setup a AWS IoT Rule to send events to a Lambda function.
+layout: Doc
+-->
 # Serverless IoT Event
 
 This example demonstrates how to setup a AWS IoT Rule to send events to a Lambda function.

diff --git a/aws-node-recursive-function/README.md b/aws-node-recursive-function/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS Recursive Lambda function Invocation example in NodeJS
+description: This is an example of a function that will recursively call itself.
+layout: Doc
+-->
 # Recursive Lambda function Invocation
 
 This is an example of a function that will recursively call itself.

diff --git a/aws-node-rekognition-analysis-s3-image/README.md b/aws-node-rekognition-analysis-s3-image/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS Analyse Image from S3 with Amazon Rekognition example in NodeJS
+description: This example shows how to analys an image in an S3 bucket with Amazon Rekognition and return a list of labels.
+layout: Doc
+-->
 # Analyse Image from S3 with Amazon Rekognition Example
 
 This example shows how to analys an image in an S3 bucket with Amazon Rekognition and return a list of labels.

diff --git a/aws-node-rest-api-with-dynamodb-and-offline/README.md b/aws-node-rest-api-with-dynamodb-and-offline/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS Serverless REST API with DynamoDB and offline support example in NodeJS
+description: This example demonstrates how to run a service locally, using the 'serverless-offline' plugin. It provides a REST API to manage Todos stored in DynamoDB.
+layout: Doc
+-->
 # Serverless REST API with DynamoDB and offline support
 
 This example demonstrates how to run a service locally, using the

diff --git a/aws-node-rest-api-with-dynamodb/README.md b/aws-node-rest-api-with-dynamodb/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS Serverless REST API example in NodeJS
+description: This example demonstrates how to setup a RESTful Web Service allowing you to create, list, get, update and delete Todos. DynamoDB is used to store the data. 
+layout: Doc
+-->
 # Serverless REST API
 
 This example demonstrates how to setup a [RESTful Web Services](https://en.wikipedia.org/wiki/Representational_state_transfer#Applied_to_web_services) allowing you to create, list, get, update and delete Todos. DynamoDB is used to store the data. This is just an example and of course you could use any data storage as a backend.

diff --git a/aws-node-scheduled-cron/README.md b/aws-node-scheduled-cron/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS Node Scheduled Cron example in NodeJS
+description: This is an example of creating a function that runs as a cron job using the serverless 'schedule' event.
+layout: Doc
+-->
 # AWS Node Scheduled Cron Example
 
 This is an example of creating a function that runs as a cron job using the serverless `schedule` event. For more information on `schedule` event check out the Serverless docs on [schedule](https://serverless.com/framework/docs/providers/aws/events/schedule/).

diff --git a/aws-node-scheduled-weather/README.md b/aws-node-scheduled-weather/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS Node Scheduled Weather example in NodeJS
+description: This is an example of creating a function that runs as a cron job using the serverless 'schedule' event. It retrieves weather information at 10am (UTC) and emails it to a predefined recipient. 
+layout: Doc
+-->
 # AWS Node Scheduled Weather Example
 
 This is an example of creating a function that runs as a cron job using the serverless `schedule` event. It retrieves weather information at 10am (UTC) and emails it to a predefined recipient. For more information on `schedule` event check out the Serverless docs on [schedule](https://serverless.com/framework/docs/providers/aws/events/schedule/).

diff --git a/aws-node-serve-dynamic-html-via-http-endpoint/README.md b/aws-node-serve-dynamic-html-via-http-endpoint/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS Serving Dynamic HTML via API Gateway example in NodeJS
+description: This example illustrates how to hookup an API Gateway endpoint to a Lambda function to render HTML on a GET request.
+layout: Doc
+-->
 # Serving Dynamic HTML via API Gateway Example
 
 This example illustrates how to hookup an API Gateway endpoint to a Lambda function to render HTML on a `GET` request.

diff --git a/aws-node-simple-http-endpoint/README.md b/aws-node-simple-http-endpoint/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS Simple HTTP Endpoint example in NodeJS
+description: This example demonstrates how to setup a simple HTTP GET endpoint. Once you ping it, it will reply with the current time.
+layout: Doc
+-->
 # Simple HTTP Endpoint Example
 
 This example demonstrates how to setup a simple HTTP GET endpoint. Once you ping it, it will reply with the current time. While the internal function is name `currentTime` the HTTP endpoint is exposed as `ping`.

diff --git a/aws-node-single-page-app-via-cloudfront/README.md b/aws-node-single-page-app-via-cloudfront/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS Single Page Application example in NodeJS
+description: This example demonstrates how to setup a Single Page Application.
+layout: Doc
+-->
 # Single Page Application
 
 This example demonstrates how to setup a Single Page Application. Our goals here are to serve a static page with low latency. One additional goal is to make sure the client side application can leverage the History API functions `pushState` and `replaceState` to change the current URL without reloading. Further we want to make sure all the content is only served via HTTPS. HTTP requests should get redirected to HTTPS.

diff --git a/aws-node-stripe-integration/README.md b/aws-node-stripe-integration/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS Stripe Integration example in NodeJS
+description: This example for Stripe integration using AWS Lambda and API Gateway.
+layout: Doc
+-->
 # Stripe Integration Example
 
 This example for Stripe integration using AWS Lambda and API Gateway.

diff --git a/aws-node-text-analysis-via-sns-post-processing/README.md b/aws-node-text-analysis-via-sns-post-processing/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS Data Processing example in NodeJS
+description: This example demonstrates how to setup a simple data processing pipeline.
+layout: Doc
+-->
 # Data processing
 
 This example demonstrates how to setup a simple data processing pipeline. The service exposes one HTTP endpoint that allows you to add a text note. This HTTP endpoint returns instantly to provide a good user experience while the actual analysis is deferred. Only messages above a certain sentiment level are actually saved.

diff --git a/aws-node-twilio-send-text-message/README.md b/aws-node-twilio-send-text-message/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS Send SMS Message with Twilio example in NodeJS
+description: This example demonstrates how to send SMS messages with the Twilio SDK and AWS lambda.
+layout: Doc
+-->
 # Send SMS Message with Twilio
 
 <img align="right" width="316" height="103" src="https://s3-us-west-2.amazonaws.com/assets.site.serverless.com/blog/twilio-logo.jpg">

diff --git a/aws-node-upload-to-s3-and-postprocess/README.md b/aws-node-upload-to-s3-and-postprocess/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS Upload a file to S3 to trigger a Lambda function example in NodeJS
+description: This example shows how to upload a file to S3 using a HTML form, and have S3 trigger a lambda function.
+layout: Doc
+-->
 # Upload a file to S3 to trigger a lambda function
 
 This example shows how to upload a file to S3 using a HTML form, and have S3

diff --git a/aws-python-alexa-skill/README.md b/aws-python-alexa-skill/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS Serverless Alexa Skill example in Python
+description: This example demonstrates how to setup your own Alexa skill using AWS Lambdas.
+layout: Doc
+-->
 # Serverless Alexa Skill Example
 
 This example demonstrates how to setup your own Alexa skill using AWS Lambdas.

diff --git a/aws-python-rest-api-with-dynamodb/README.md b/aws-python-rest-api-with-dynamodb/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS Serverless REST API with DynamoDB store example in Python
+description: This example demonstrates how to setup a RESTful Web Service allowing you to create, list, get, update and delete Todos. DynamoDB is used to store the data.
+layout: Doc
+-->
 # Serverless REST API
 
 This example demonstrates how to setup a [RESTful Web Services](https://en.wikipedia.org/wiki/Representational_state_transfer#Applied_to_web_services) allowing you to create, list, get, update and delete Todos. DynamoDB is used to store the data. This is just an example and of course you could use any data storage as a backend.

diff --git a/aws-python-rest-api-with-faunadb/README.md b/aws-python-rest-api-with-faunadb/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS Serverless REST API with FaunaDB store example in Python
+description: This example demonstrates how to setup a RESTful Web Service allowing you to create, list, get, update and delete Todos. FaunaDB is used to store the data.
+layout: Doc
+-->
 # Serverless REST API
 
 This example demonstrates how to setup a [RESTful Web Services](https://en.wikipedia.org/wiki/Representational_state_transfer#Applied_to_web_services) allowing you to create, list, get, update and delete Todos. FaunaDB is used to store the data.

diff --git a/aws-python-scheduled-cron/README.md b/aws-python-scheduled-cron/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS Python Scheduled Cron example in Python
+description: This is an example of creating a function that runs as a cron job using the serverless 'schedule' event.
+layout: Doc
+-->
 # AWS Python Scheduled Cron Example
 
 This is an example of creating a function that runs as a cron job using the serverless `schedule` event. For more information on `schedule` event check out the Serverless docs on [schedule](https://serverless.com/framework/docs/providers/aws/events/schedule/).

diff --git a/aws-python-simple-http-endpoint/README.md b/aws-python-simple-http-endpoint/README.md
@@ -1,3 +1,8 @@
+<!--
+title: AWS Simple HTTP Endpoint example in Python
+description: This example demonstrates how to setup a simple HTTP GET endpoint. Once you ping it, it will reply with the current time.
+layout: Doc
+-->
 # Simple HTTP Endpoint Example
 
 This example demonstrates how to setup a simple HTTP GET endpoint. Once you ping it, it will reply with the current time. While the internal function is name `currentTime` the HTTP endpoint is exposed as `ping`.

diff --git a/azure-node-simple-http-endpoint/README.md b/azure-node-simple-http-endpoint/README.md
@@ -1,3 +1,8 @@
+<!--
+title: Azure Simple HTTP Endpoint example in NodeJS
+description: In this example, we deploy an HTTP Node.js Azure Function. This example shows you how to read properties off of a query string or the request body, then set a result back to Azure.
+layout: Doc
+-->
 # Simple HTTP example
 
 In this example, we deploy an HTTP Node.js Azure Function. This sample show you how to read properties off of a query string or the request body, then set a result back to Azure.

diff --git a/google-node-simple-http-endpoint/README.md b/google-node-simple-http-endpoint/README.md
@@ -1,3 +1,8 @@
+<!--
+title: GCF Simple HTTP Endpoint example in NodeJS
+description: This example demonstrates how to setup a simple HTTP GET endpoint.
+layout: Doc
+-->
 # Simple HTTP example
 
 # Setup

diff --git a/openwhisk-go-simple/README.md b/openwhisk-go-simple/README.md
@@ -1,3 +1,8 @@
+<!--
+title: OpenWhisk Serverless Boilerplate example in Go
+description: This example shows a Serverless boilerplate in Go.
+layout: Doc
+-->
 # Serverless Boilerplate - OpenWhisk - Go
 
 Make sure `serverless` is installed. [See installation guide](https://serverless.com/framework/docs/providers/openwhisk/guide/installation/).

diff --git a/openwhisk-node-and-docker-chaining-functions/README.md b/openwhisk-node-and-docker-chaining-functions/README.md
@@ -1,3 +1,8 @@
+<!--
+title: OpenWhisk Serverless Boilerplate using Docker example in NodeJS
+description: This example shows a Serverless boilerplate using Docker in NodeJS.
+layout: Doc
+-->
 # Serverless Boilerplate - OpenWhisk - Node.js & Docker
 
 Make sure `serverless` is installed. [See installation guide](https://serverless.com/framework/docs/providers/openwhisk/guide/installation/).

diff --git a/openwhisk-node-chaining-functions/README.md b/openwhisk-node-chaining-functions/README.md
@@ -1,3 +1,8 @@
+<!--
+title: OpenWhisk Serverless Chaining Functions example in NodeJS
+description: This example demonstrates chaining functions in NodeJS.
+layout: Doc
+-->
 # Serverless Boilerplate - OpenWhisk - Node.js
 
 Make sure `serverless` is installed. [See installation guide](https://serverless.com/framework/docs/providers/openwhisk/guide/installation/).

diff --git a/openwhisk-node-scheduled-cron/README.md b/openwhisk-node-scheduled-cron/README.md
@@ -1,3 +1,8 @@
+<!--
+title: OpenWhisk Serverless Scheduled Cron job example in NodeJS
+description: This example demonstrates scheduleding a cron job in NodeJS.
+layout: Doc
+-->
 # Serverless Boilerplate - OpenWhisk - Node.js
 
 Make sure `serverless` is installed. [See installation guide](https://serverless.com/framework/docs/providers/openwhisk/guide/installation/).

diff --git a/openwhisk-node-simple-http-endpoint/README.md b/openwhisk-node-simple-http-endpoint/README.md
@@ -1,3 +1,8 @@
+<!--
+title: OpenWhisk Simple HTTP Endpoint example in NodeJS
+description: This example demonstrates how to setup a simple HTTP GET endpoint.
+layout: Doc
+-->
 # Serverless Boilerplate - OpenWhisk - Node.js
 
 Make sure `serverless` is installed. [See installation guide](https://serverless.com/framework/docs/providers/openwhisk/guide/installation/).

diff --git a/openwhisk-node-simple/README.md b/openwhisk-node-simple/README.md
@@ -1,3 +1,8 @@
+<!--
+title: OpenWhisk Serverless Simple example in NodeJS
+description: This example demonstrates a simple example in NodeJS.
+layout: Doc
+-->
 # Serverless Boilerplate - OpenWhisk - Node.js
 
 Make sure `serverless` is installed. [See installation guide](https://serverless.com/framework/docs/providers/openwhisk/guide/installation/).

diff --git a/openwhisk-python-scheduled-cron/README.md b/openwhisk-python-scheduled-cron/README.md
@@ -1,3 +1,8 @@
+<!--
+title: OpenWhisk Serverless Scheduled Cron job example in Python
+description: This example demonstrates scheduleding a cron job.
+layout: Doc
+-->
 # Serverless Boilerplate - OpenWhisk - Python
 
 Make sure `serverless` is installed. [See installation guide](https://serverless.com/framework/docs/providers/openwhisk/guide/installation/).

diff --git a/openwhisk-python-simple-http-endpoint/README.md b/openwhisk-python-simple-http-endpoint/README.md
@@ -1,3 +1,8 @@
+<!--
+title: OpenWhisk Simple HTTP Endpoint example in Python
+description: This example demonstrates how to setup a simple HTTP GET endpoint.
+layout: Doc
+-->
 # Serverless Boilerplate - OpenWhisk - Python
 
 Make sure `serverless` is installed. [See installation guide](https://serverless.com/framework/docs/providers/openwhisk/guide/installation/).

diff --git a/openwhisk-python-simple/README.md b/openwhisk-python-simple/README.md
@@ -1,3 +1,8 @@
+<!--
+title: OpenWhisk Serverless Simple example in Python
+description: This example demonstrates a simple example in Python.
+layout: Doc
+-->
 # Serverless Boilerplate - OpenWhisk - Python
 
 Make sure `serverless` is installed. [See installation guide](https://serverless.com/framework/docs/providers/openwhisk/guide/installation/).

diff --git a/openwhisk-swift-scheduled-cron/README.md b/openwhisk-swift-scheduled-cron/README.md
@@ -1,3 +1,8 @@
+<!--
+title: OpenWhisk Serverless Scheduled Cron job example in Swift
+description: This example demonstrates scheduleding a cron job.
+layout: Doc
+-->
 # Serverless Boilerplate - OpenWhisk - Swift
 
 Make sure `serverless` is installed. [See installation guide](https://serverless.com/framework/docs/providers/openwhisk/guide/installation/).

diff --git a/openwhisk-swift-simple-http-endpoint/README.md b/openwhisk-swift-simple-http-endpoint/README.md
@@ -1,3 +1,8 @@
+<!--
+title: OpenWhisk Simple HTTP Endpoint example in Swift
+description: This example demonstrates how to setup a simple HTTP GET endpoint.
+layout: Doc
+-->
 # Serverless Boilerplate - OpenWhisk - Swift
 
 Make sure `serverless` is installed. [See installation guide](https://serverless.com/framework/docs/providers/openwhisk/guide/installation/).

diff --git a/openwhisk-swift-simple/README.md b/openwhisk-swift-simple/README.md
@@ -1,3 +1,8 @@
+<!--
+title: OpenWhisk Serverless Simple example in Swift
+description: This example demonstrates a simple example in Swift.
+layout: Doc
+-->
 # Serverless Boilerplate - OpenWhisk - Swift
 
 Make sure `serverless` is installed. [See installation guide](https://serverless.com/framework/docs/providers/openwhisk/guide/installation/).