Add front matter to all files.

serverless · Jun 14, 2017 · 251f292 · 251f292
1 parent 413a9c1
commit 251f292
Show file tree

Hide file tree

Showing 25 changed files with 315 additions and 104 deletions.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -1,3 +1,11 @@
+<!--
+title: Code of Conduct
+menuText: Code of Conduct
+menuOrder: 3
+description: Code of conduct guidelines for content in the guide
+layout: Doc
+-->
+
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,3 +1,11 @@
+<!--
+title: Contributing to the guide
+menuText: Contribute
+menuOrder: 2
+description: Contribution guidelines for potential authors 
+layout: Doc
+-->
+
 ## Contribute
 
 It is very easy to contribute:

diff --git a/README.md b/README.md
@@ -1,3 +1,11 @@
+<!--
+title: About the Guide
+menuText: About
+menuOrder: 1
+description: About the guide with sections for contribution guidelines, credits, contact us, and license. 
+layout: Doc
+-->
+
 # Serverless Guide
 
 *By the community, curated by [Serverless, Inc.](https://serverless.com/)*

diff --git a/source/README.md b/source/README.md
@@ -1,3 +1,11 @@
+<!--
+title: Table of Contents
+menuText: Table of Contents
+menuOrder: 4
+description: Table of contents for the guide
+layout: Doc
+-->
+
 ## Contents
 
 * [Introduction](./introduction.md)
@@ -42,21 +50,11 @@
     * Access Management
 
 * [Providers](./providers/README.md)
-    * [Introduction](./providers/README.md#introduction)
-    * [A Comparative Look](./providers/README.md#a-comparative-look)
-    * The Players
-      * [AWS Lambda](./providers/aws.md)
-      * [Azure Functions](./providers/azure.md)
-      * [Google Cloud Functions](./providers/gcf.md)
-      * [IBM OpenWhisk](./providers/openwhisk.md)
+    * [AWS Lambda](./providers/aws.md)
+    * [Azure Functions](./providers/azure.md)
+    * [Google Cloud Functions](./providers/gcf.md)
+    * [IBM OpenWhisk](./providers/openwhisk.md)
 
 * [Case Studies](./case_studies/README.md)
-    * Backends for Web, Mobile & IoT
-    * Data Processing Pipelines
-    * Webhooks
-    * Chatbots
-    * All Event-Driven Workflows
-    * Devops/Tooling Automation
-    * CRON Jobs
 
 * [Glossary](./glossary.md)
diff --git a/source/adoption/README.md b/source/adoption/README.md
@@ -1,6 +1,14 @@
+<!--
+title: Adoption
+menuText: Adoption
+menuOrder: 7
+description: A section about adoption of serverless technologies in the enterprises, and the community in general.
+layout: Doc
+-->
+
 ### Adoption
 
-*[Describe the adoption of serverless technology in the community and in enterprises]*
+*[Describe the adoption of serverless technology in the community and in the enterprises]*
 
 * Is it for me?
 * It is just a hype, so I will wait (Enterprises)

diff --git a/source/architecture/README.md b/source/architecture/README.md
@@ -1,3 +1,11 @@
+<!--
+title: Architecture
+menuText: Architecture
+menuOrder: 6
+description: A section about serverless architectures, patterns and solutions.
+layout: Doc
+-->
+
 ## Architecture
 
 ### A Look Back

diff --git a/source/case_studies/README.md b/source/case_studies/README.md
@@ -1,11 +1,21 @@
+<!--
+title: Case Studies
+menuText: Case Studies
+menuOrder: 22
+description: Real-life case studies from enterprises that have been successful running serverless in production.
+layout: Doc
+-->
+
 ## Case Studies
 
 AWS Lambda and serverless technologies in general, has led to a lot of excitement in the enterprises. A lot of use cases have emerged where serverless is the right fit. There is a need to showcase specific implemntations out there in the field, and to highlight success stories around them. The early adopters have paved the path with to innovative solutions to real-life problems using serverless. We want to celebrate those successes. Build trust in serverless. Share our excitment.
 
 <!--
 1. See the template (CASE_STUDY_TEMPLATE.md) for guidance around structure for your case study.
 2. Create a new markdown file in the case_studies folder, and name it <title_company.md>. Keep the filename short.
+-->
 
+***
 Some examples of use cases that could be covered:
 
 * Backends for Web, Mobile & IoT
@@ -16,5 +26,5 @@ Some examples of use cases that could be covered:
 * Devops/Tooling Automation
 * CRON Jobs
 
--->
+***
 
diff --git a/source/dev/README.md b/source/dev/README.md
@@ -1,3 +1,11 @@
+<!--
+title: Development
+menuText: Development
+menuOrder: 8
+description: An overview of development trends, changing mindsets, using serverless technologies.
+layout: Doc
+-->
+
 # Development
 
 Bringing a product to life usually starts with an idea, which transforms into a code spike. A short sprint that manifests the core idea into code. Most developers want to share the idea and deploy the code as soon as they can. The excitement is usually curbed by the decisions that follow. The decisions around infrastructure, scalability, costs... That is usually a big chasm to cross.
@@ -63,8 +71,6 @@ The serverless style of computing is opening up the gates to a distributed, even
 
 The possibilities are endless, and we are on the threshold of unleashing the power of serverless computing.
 
-<hr>
-
+***
 **Credits:** Rupak Ganguly (@rupakg)
-
-<hr>
+***
diff --git a/source/dev/culture.md b/source/dev/culture.md
@@ -1,30 +1,26 @@
-### Culture
-
 <!--
-Some guidance as to what needs to go in this section:
-
-1. How is the culture inside organizations changing due to adoption of serverless?
-2. Are we seeing a shift in how teams are formed? Autonomous teams?
-3. What are the challenges for training the new workforce?
-4. How are we educating the teams about serverless?
-5. How does the serverless mindset effecting how we hire?
-
-Feel free to modify the sub-sections. 
+title: Development
+menuText: Development
+menuOrder: 8
+description: An overview of development trends, changing mindsets, using serverless technologies.
+layout: Doc
+-->
 
-Add yourself as a contributer for the section(s) you contribute to. 
+### Culture
 
-<hr>
+There is a whole new culture that is evolving to internalize the serverless movement. 
 
-**Section Credits:** <name> (<github handle>)
+***
+Some guidance as to what needs to go in this section:
 
-<hr>
--->
+* How is the culture inside organizations changing due to adoption of serverless?
+* Are we seeing a shift in how teams are formed? Autonomous teams?
+* What are the challenges for training the new workforce?
+* How are we educating the teams about serverless?
+* How does the serverless mindset effecting how we hire?
+* What are some of the best practices?
 
-There is a whole new culture that is evolving to internalize the serverless movement. 
+Feel free to add/modify the sub-sections.
+***
 
-* How do I form teams?
-* Microservice/developer autonomy 
-* How do I train my teams?
-* How do I hire?
-* What are some of the best practices?
 
diff --git a/source/dev/debugging.md b/source/dev/debugging.md
@@ -1,2 +1,21 @@
+<!--
+title: Debugging
+menuText: Debugging
+menuOrder: 13
+description: Discussion around challenges and issues with debugging functions and serverless apps.
+layout: Doc
+-->
+
 ### Debugging
 
+***
+Some guidance as to what needs to go in this section:
+
+* What are the challenges around debugging serverless services and apps?
+* What are some of the workarounds that exist?
+* Is it practically impossible to trace through functions in the cloud? 
+* What problems do event-driven architectures bring to the surface?
+* 
+
+Feel free to add/modify the sub-sections. 
+***
diff --git a/source/dev/deployment.md b/source/dev/deployment.md
@@ -1,8 +1,22 @@
+<!--
+title: Deployment
+menuText: Deployment
+menuOrder: 11
+description: Some best practices around deploying serverless apps.
+layout: Doc
+-->
+
 ### Deployment  
 
+***
+Some guidance as to what needs to go in this section:
+
 * How is deploying serverless services different? 
 * How to I continuously deploy?
 * How do I manage deployment to different staged environments?
 * Blue/Green Deployments
 * Rollbacks? 
-* Versioning support
+* Versioning support
+
+Feel free to add/modify the sub-sections. 
+***
diff --git a/source/dev/examples.md b/source/dev/examples.md
@@ -1,3 +1,17 @@
+<!--
+title: Examples
+menuText: Examples
+menuOrder: 14
+description: Some examples of serverless services and apps.
+layout: Doc
+-->
+
 ### Examples
 
-*[link, description, and (tags?) for each example from the examples repo (Goal: provide concrete use cases and example code)]*
+***
+Some guidance as to what needs to go in this section:
+
+* Provide concrete use cases and example code
+* List examples with link, and description from the examples repo
+
+***
diff --git a/source/dev/pathway_to_sls.md b/source/dev/pathway_to_sls.md
@@ -1,10 +1,24 @@
+<!--
+title: Pathway to Serverless Development
+menuText: Pathway to Development
+menuOrder: 9
+description: An overview of getting started with developing serverless applications and services.
+layout: Doc
+-->
+
 ### Pathway to Serverless Development
 
 The excitement around serverless technologies is huge and is growing each day. The developer is challenged with a steep learning curve due to the yet-to-be-mature state of the serverless space. AWS Lambda has led the serverless movement and provided a solid platform for developing & deploying serverless applications. A whole slew of services around AWS Lambda makes it possible to write multi-service applications. The space is brimming with new services like Auth0, Firebase, IOPipe, Stripe, Cloudant, to name a few, that can integrate well into the serverless architecture.
 
 Following the lead of AWS Lambda, the space has also warmed up to new serverless compute providers, namely, Microsoft Azure Functions, Google Cloud Functions and IBM OpenWhisk. It is a good indication of popularity of the serverless architecture. It has opened up the servreless space and given the developers a choice to pick from a variety of providers, services and platforms. While that is all good, it has also introduced a lot of complexity for the application developer.
 
+***
+Some guidance as to what needs to go in this section:
+
 * How do I start developing a serverless application?
 * How is the mindset different from a traditional app?
 * Do you start with the provider tools?
 * Do you look out for existing toolsets?
+
+Feel free to add/modify the sub-sections. 
+***
diff --git a/source/dev/project_structure.md b/source/dev/project_structure.md
@@ -1,10 +1,24 @@
+<!--
+title: Project Structure
+menuText: Project Structure
+menuOrder: 10
+description: Some best practices around project structures for serverless apps
+layout: Doc
+-->
+
 ### Project Structure
 
+
+***
+Some guidance as to what needs to go in this section:
+
+* How should a multi-services app be structured?
 * What are best practices for breaking apart services? 
 * How should I organize repos for services? one repo or multiple repos?
 * What are the pain points of either cases?
 * How do you manage configuration for services?
 * How to manage secrets for services?
 * How to organise or group functions? 
 
-
+Feel free to add/modify the sub-sections. 
+***
diff --git a/source/dev/testing.md b/source/dev/testing.md
@@ -1,28 +1,28 @@
-### Testing
-
 <!--
-Some guidance as to what needs to go in this section:
-
-1. Describe how testing strategies have changed.
-2. Effects on unit and integartion testing. New trends, problems etc.
-3. How has serverless changed CI/CD and effected automation in dev to deployment cycles?
-4. Any emerging tooling for testing?
-5. Showcase any best practices evolving around test-driven development
-
-Feel free to modify the sub-sections. 
-
-Add yourself as a contributer for the section(s) you contribute to. 
-
-<hr>
+title: Testing
+menuText: Testing
+menuOrder: 12
+description: Some best practices and strategies around testing serverless apps.
+layout: Doc
+-->
 
-**Section Credits:** <name> (<github handle>)
+### Testing
 
-<hr>
--->
+***
+Some guidance as to what needs to go in this section:
 
+* Describe how testing strategies have changed
 * How is testing different in the serverless world?
 * How can I test locally?
-* Hoe can I make my testing cycle faster?
+* How can I make my dev-testing cycle faster?
+* Effects on unit and integration testing. New trends, problems etc.
+* How has serverless changed CI/CD and effected automation in dev to deployment cycles?
+* Any emerging tooling for testing?
+* Showcase any best practices evolving around test-driven development
+
+Feel free to add/modify the sub-sections. 
+***
+
 
 #### Testing Locally
 
@@ -47,6 +47,7 @@ Add yourself as a contributer for the section(s) you contribute to.
 #### Tooling
 
 * What are some of the tooling that helps testing serverless apps?
+* Chaos Testing as a Service - Gremlin
 
 #### Best Practices
 

diff --git a/source/glossary.md b/source/glossary.md
@@ -1,3 +1,11 @@
+<!--
+title: Glossary
+menuText: Glossary
+menuOrder: 99
+description: The glossary section of the guide, listing the commonly used terms in serverless.
+layout: Doc
+-->
+
 # Serverless Terminology
 
 ## Serverless Platform