Merge pull request serverless#6596 from serverless/style-updates-for-…

…docs Style updates for docs
kiesel · Aug 27, 2019 · 50add41 · 50add41
2 parents 5910028 + e7d0406
commit 50add41
Show file tree

Hide file tree

Showing 44 changed files with 165 additions and 239 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -36,6 +36,6 @@ menuItems:
 
 The Serverless Framework helps you build serverless apps with radically less overhead and cost. It provides a powerful, unified experience to develop, deploy, test, secure and monitor your serverless applications.
 
-The Serverless Framework consists of an open source **[CLI](./providers/)** that makes it easy to develop, deploy and test serverless apps across different cloud providers, as well as a hosted **[Dashboard](./dashboard/)** that includes features designed to further simplify serverless development, deployment, and testing, and enable you to easily secure and monitor your serverless apps.
+The Serverless Framework consists of an open source [CLI](./providers/) that makes it easy to develop, deploy and test serverless apps across different cloud providers, as well as a hosted [Dashboard](./dashboard/) that includes features designed to further simplify serverless development, deployment, and testing, and enable you to easily secure and monitor your serverless apps.
 
-If you are new to serverless and want to experience how fast and easy it is to build a serverless app, or if you are an experienced user of the Serverless Framework open source CLI and want to explore new features of the Framework, you can get started **[here](./getting-started.md)**, for free.
+If you are new to serverless and want to experience how fast and easy it is to build a serverless app, or if you are an experienced user of the Serverless Framework open source CLI and want to explore new features of the Framework, you can get started [here](./getting-started.md), for free.
diff --git a/docs/dashboard/access-roles.md b/docs/dashboard/access-roles.md
@@ -1,6 +1,7 @@
 <!--
 title: Serverless Dashboard - Access Roles
 menuText: Access Roles
+menuOrder: 6
 layout: Doc
 -->
 

diff --git a/docs/dashboard/insights.md b/docs/dashboard/insights.md
@@ -1,6 +1,7 @@
 <!--
 title: Serverless Dashboard - Insights
 menuText: Insights
+menuOrder: 1
 layout: Doc
 -->
 

diff --git a/docs/dashboard/notifications.md b/docs/dashboard/notifications.md
@@ -1,6 +1,7 @@
 <!--
 title: Serverless Dashboard - Notifications
 menuText: Notifications
+menuOrder: 2
 layout: Doc
 -->
 

diff --git a/docs/dashboard/output-variables.md b/docs/dashboard/output-variables.md
@@ -1,6 +1,7 @@
 <!--
 title: Serverless Dashboard - Output Variables
 menuText: Output Variables
+menuOrder: 3
 layout: Doc
 -->
 

diff --git a/docs/dashboard/pipelines.md b/docs/dashboard/pipelines.md
@@ -1,6 +1,7 @@
 <!--
 title: Serverless Dashboard - Pipelines
 menuText: Pipelines
+menuOrder: 8
 layout: Doc
 -->
 

diff --git a/docs/dashboard/profiles.md b/docs/dashboard/profiles.md
@@ -1,6 +1,7 @@
 <!--
 title: Serverless Dashboard - Profiles
 menuText: Profiles
+menuOrder: 7
 layout: Doc
 -->
 

diff --git a/docs/dashboard/safeguards.md b/docs/dashboard/safeguards.md
@@ -1,6 +1,7 @@
 <!--
 title: Serverless Dashboard - Safeguards
 menuText: Safeguards
+menuOrder: 5
 layout: Doc
 -->
 

diff --git a/docs/dashboard/secrets.md b/docs/dashboard/secrets.md
@@ -1,6 +1,7 @@
 <!--
 title: Serverless Dashboard - Secrets
 menuText: Secrets
+menuOrder: 4
 layout: Doc
 -->
 

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -26,9 +26,9 @@ npm install -g serverless
 npm update -g serverless
 ```
 
-If you don’t already have **[Node 6](https://nodejs.org/en/download/package-manager/)** or higher on your machine, you’ll need to do that first.
+If you don’t already have [Node 6](https://nodejs.org/en/download/package-manager/) or higher on your machine, you’ll need to do that first.
 
-Once you have the Serverless Framework installed, simply run the ‘serverless’ command and follow the prompts. In no time you will have deployed your first serverless app using the Serverless Framework **[CLI](./providers/)** and configured your Serverless Framework **[Dashboard](./dashboard/)** account to automatically monitor your serverless app, generate alerts, and much more.
+Once you have the Serverless Framework installed, simply run the ‘serverless’ command and follow the prompts. In no time you will have deployed your first serverless app using the Serverless Framework [CLI](./providers/) and configured your Serverless Framework [Dashboard](./dashboard/) account to automatically monitor your serverless app, generate alerts, and much more.
 
 ```bash
 # Create and deploy a new service/project

diff --git a/docs/providers/README.md b/docs/providers/README.md
@@ -14,87 +14,63 @@ layout: Doc
 
 Under the hood, the Serverless Framework is deploying your code to a cloud provider like AWS, Microsoft Azure, Google Cloud Platform, Apache OpenWhisk, Cloudflare Workers, or a Kubernetes-based solution like Kubeless. Click on your provider for detailed Serverless Framework CLI user guides and references.
 
-<div class="docsSections">
-  <div class="docsSection">
-    <div class="docsSectionHeader">
-      <a href="./aws/">
-        <img src="https://s3-us-west-2.amazonaws.com/assets.site.serverless.com/images/aws-black.png" width="250" draggable="false"/>
-      </a>
-    </div>
-    <div style="text-align:center;">
-      <a href="./aws/">AWS Docs</a>
+<div class="providersSections">
+  <a href="./aws/">
+  <div class="providerSection">
+    <div class="providerSectionHeader">
+        <img src="https://s3-us-west-2.amazonaws.com/assets.site.serverless.com/images/docs/aws-logo.svg" width="250" draggable="false" class='aws-logo' />
     </div>
   </div>
-  <div class="docsSection">
-    <div class="docsSectionHeader">
-      <a href="./azure/">
-        <img src="https://s3-us-west-2.amazonaws.com/assets.site.serverless.com/images/azure-black.png" width="250" draggable="false"/>
-      </a>
-    </div>
-    <div style="text-align:center;">
-      <a href="./azure/">Azure Functions Docs</a>
+  </a>
+  <a href="./azure/">
+  <div class="providerSection">
+    <div class="providerSectionHeader">
+        <img src="https://s3-us-west-2.amazonaws.com/assets.site.serverless.com/images/docs/azure-logo.svg" width="250" draggable="false" class='azure-logo'/>
     </div>
   </div>
-  <div class="docsSection">
-    <div class="docsSectionHeader">
-      <a href="./openwhisk/">
-        <img src="https://s3-us-west-2.amazonaws.com/assets.site.serverless.com/images/openwhisk-black.png" width="250" draggable="false"/>
-      </a>
-    </div>
-    <div style="text-align:center;">
-      <a href="./openwhisk/">OpenWhisk Docs</a>
+  </a>
+  <a href="./openwhisk/">
+  <div class="providerSection">
+    <div class="providerSectionHeader">
+        <img src="https://s3-us-west-2.amazonaws.com/assets.site.serverless.com/images/docs/openwhisk-logo.svg" width="250" draggable="false" class='openwhisk-logo'/>
     </div>
   </div>
-  <div class="docsSection">
-    <div class="docsSectionHeader">
-      <a href="./google/">
-        <img src="https://s3-us-west-2.amazonaws.com/assets.site.serverless.com/images/gcf-black.png" width="250" draggable="false"/>
-      </a>
-    </div>
-    <div style="text-align:center;">
-      <a href="./google/">Cloud Functions Docs</a>
+  </a>
+  <a href="./google/">
+  <div class="providerSection">
+    <div class="providerSectionHeader">
+        <img src="https://s3-us-west-2.amazonaws.com/assets.site.serverless.com/images/docs/google-logo.png" width="250" draggable="false" class='google-logo'/>
     </div>
   </div>
-  <div class="docsSection">
-    <div class="docsSectionHeader">
-      <a href="./kubeless/">
-        <img src="https://s3-us-west-2.amazonaws.com/assets.site.serverless.com/docs/kubeless-logos-black.png" width="250" draggable="false"/>
-      </a>
-    </div>
-    <div style="text-align:center;">
-      <a href="./kubeless/">Kubeless Docs</a>
+  </a>
+  <a href="./kubeless/">
+  <div class="providerSection">
+    <div class="providerSectionHeader">
+        <img src="https://s3-us-west-2.amazonaws.com/assets.site.serverless.com/images/docs/kubeless-logo.svg" width="250" draggable="false" class='kubeless-logo'/>
     </div>
   </div>
-  <div class="docsSection">
-    <div class="docsSectionHeader">
-      <a href="./spotinst/">
-        <img src="https://s3-us-west-2.amazonaws.com/assets.site.serverless.com/docs/spotinst-logos-black-small.png" width="250" draggable="false"/>
-      </a>
-    </div>
-    <div style="text-align:center;">
-      <a href="./spotinst/">Spotinst Docs</a>
+  </a>
+  <a href="./spotinst/">
+  <div class="providerSection">
+    <div class="providerSectionHeader">
+        <img src="https://s3-us-west-2.amazonaws.com/assets.site.serverless.com/images/docs/spotinst-logo.svg" width="250" draggable="false" class='spotinst-logo'/>
     </div>
   </div>
-  <div class="docsSection">
-    <div class="docsSectionHeader">
-      <a href="./fn/">
-        <img src="https://s3-us-west-2.amazonaws.com/assets.site.serverless.com/docs/fn-logo-black.png" width="250" draggable="false"/>
-      </a>
-    </div>
-    <div style="text-align:center;">
-      <a href="./fn/">Fn Docs</a>
+  </a>
+  <a href="./fn/">
+  <div class="providerSection">
+    <div class="providerSectionHeader">
+        <img src="https://s3-us-west-2.amazonaws.com/assets.site.serverless.com/images/docs/fn-logo.svg" width="250" draggable="false" class='fn-logo'/>
     </div>
   </div>
-  <div class="docsSection">
-    <div class="docsSectionHeader">
-      <a href="./cloudflare/">
-        <img src="https://s3-us-west-2.amazonaws.com/assets.site.serverless.com/docs/cloudflare/cf-logo-v-dark-gray.png" width="250" draggable="false"/>
-      </a>
-    </div>
-    <div style="text-align:center;">
-      <a href="./cloudflare/">Cloudflare Workers Docs</a>
+  </a>
+  <a href="./cloudflare/">
+  <div class="providerSection">
+    <div class="providerSectionHeader">
+        <img src="https://s3-us-west-2.amazonaws.com/assets.site.serverless.com/images/docs/cloudflare-logo.svg" width="250" draggable="false" class='cloudflare-logo'/>
     </div>
   </div>
+  </a>
 
 </div>
 <br/>

diff --git a/docs/providers/aws/README.md b/docs/providers/aws/README.md
@@ -14,12 +14,10 @@ layout: Doc
 
 <div class="docsSections">
   <div class="docsSection">
-    <div class="docsSectionHeader">
-      <a href="./guide/">
-      <img src="https://s3-us-west-2.amazonaws.com/assets.site.serverless.com/images/sls_aws_guide.png" alt="Serverless Framework AWS Lambda Guide" width="250" draggable="false"/>
-      </a>
+    <div class="docsSectionSubHeader">
+      <h4>Guides</h4>
     </div>
-    <div class="test">
+    <div class="docsProviderItems">
       <ul>
         <li><a href="./guide/intro.md">Intro</a></li>
         <li><a href="./guide/installation.md">Installation</a></li>
@@ -41,12 +39,10 @@ layout: Doc
   </div>
 
   <div class="docsSection">
-    <div class="docsSectionHeader">
-      <a href="./cli-reference/">
-      <img src="https://s3-us-west-2.amazonaws.com/assets.site.serverless.com/images/sls_aws_cli.png" alt="Serverless Framework AWS Lambda CLI Reference" width="250" draggable="false"/>
-      </a>
+    <div class="docsSectionSubHeader">
+      <h4>CLI references</h4>
     </div>
-    <div>
+    <div class="docsProviderItems">
       <ul>
         <li><a href="./cli-reference/config-credentials.md">Config Credentials</a></li>
         <li><a href="./cli-reference/create.md">Create</a></li>
@@ -75,12 +71,10 @@ layout: Doc
   </div>
 
   <div class="docsSection">
-    <div class="docsSectionHeader">
-      <a href="./events/">
-      <img src="https://s3-us-west-2.amazonaws.com/assets.site.serverless.com/images/sls_aws_events.png" alt="Serverless Framework AWS Lambda Events"  width="250" draggable="false"/>
-      </a>
+    <div class="docsSectionSubHeader">
+      <h4>Events</h4>
     </div>
-    <div>
+    <div class="docsProviderItems">
       <ul>
         <li><a href="./events/apigateway.md">API Gateway</a></li>
         <li><a href="./events/websocket.md">Websocket</a></li>
@@ -102,13 +96,11 @@ layout: Doc
   </div>
 
   <div class="docsSection">
-    <div class="docsSectionHeader">
-      <a href="./examples/">
-      <img src="https://s3-us-west-2.amazonaws.com/assets.site.serverless.com/images/sls_aws_examples.png" alt="Serverless Framework AWS Lambda Examples" width="250" draggable="false"/>
-      </a>
+    <div class="docsSectionSubHeader">
+      <h4>Examples</h4>
     </div>
     <div>
-      <div>
+      <div class="docsProviderItems">
         <ul>
           <li><a href="./examples/hello-world">Hello World</a></li>
         </ul>

diff --git a/docs/providers/aws/examples/hello-world/README.md b/docs/providers/aws/examples/hello-world/README.md
@@ -1,6 +1,6 @@
 <!--
 title: Hello World Example
-menuText: Hello World Example
+menuText: Hello World
 description: Example of creating a Hello World function in Node.js and Python with the Serverless framework
 layout: Doc
 -->

diff --git a/docs/providers/aws/examples/hello-world/csharp/README.md b/docs/providers/aws/examples/hello-world/csharp/README.md
@@ -1,6 +1,6 @@
 <!--
 title: Hello World C# Example
-menuText: Hello World C# Example
+menuText: C#
 description: Create a C# Hello World Lambda function
 layout: Doc
 -->

diff --git a/docs/providers/aws/examples/hello-world/fsharp/README.md b/docs/providers/aws/examples/hello-world/fsharp/README.md
@@ -1,6 +1,6 @@
 <!--
 title: Hello World F# Example
-menuText: Hello World F# Example
+menuText: F#
 description: Create a F# Hello World Lambda function
 layout: Doc
 -->

diff --git a/docs/providers/aws/examples/hello-world/go/README.md b/docs/providers/aws/examples/hello-world/go/README.md
@@ -1,6 +1,6 @@
 <!--
 title: Hello World Go Example
-menuText: Hello World Go Example
+menuText: Go
 description: Create a Go Hello World Lambda function
 layout: Doc
 -->

diff --git a/docs/providers/aws/examples/hello-world/node/README.md b/docs/providers/aws/examples/hello-world/node/README.md
@@ -1,6 +1,6 @@
 <!--
 title: Hello World Node.js Example
-menuText: Hello World Node.js Example
+menuText: Node.js
 description: Create a Node.js Hello World Lambda function
 layout: Doc
 -->

diff --git a/docs/providers/aws/examples/hello-world/python/README.md b/docs/providers/aws/examples/hello-world/python/README.md
@@ -1,6 +1,6 @@
 <!--
 title: Hello World Python Example
-menuText: Hello World Python Example
+menuText: Python
 description: Create a Python Hello World Lambda function
 layout: Doc
 -->

diff --git a/docs/providers/aws/examples/hello-world/ruby/README.md b/docs/providers/aws/examples/hello-world/ruby/README.md
@@ -1,6 +1,6 @@
 <!--
 title: Hello World Ruby Example
-menuText: Hello World Ruby Example
+menuText: Ruby
 description: Create a Ruby Hello World Lambda function
 layout: Doc
 -->

diff --git a/docs/providers/aws/guide/README.md b/docs/providers/aws/guide/README.md
@@ -14,6 +14,6 @@ layout: Doc
 
 Welcome to the Serverless AWS Lambda Guide!
 
-Get started with the **[Introduction to the framework](./intro.md)**
+Get started with the [Introduction to the framework](./intro.md)
 
 If you have questions, join the [chat in Slack](https://serverless.com/slack) or [post over on the forums](https://forum.serverless.com/)