Add Docs Front Matter for 0.5.1 (#231)

stashed · Nov 27, 2017 · 9fa96d4 · 9fa96d4
1 parent 20f207e
commit 9fa96d4
Show file tree

Hide file tree

Showing 19 changed files with 279 additions and 8 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,3 +1,20 @@
+---
+title: Overview | Stash
+description: Overview of Stash
+menu:
+  product_stash_0.5.1:
+    identifier: overview-stash
+    name: Overview
+    parent: getting-started
+    weight: 20
+product_name: stash
+left_menu: product_stash_0.5.1
+section_menu_id: getting-started
+url: /products/stash/0.5.1/getting-started/
+aliases:
+  - /products/stash/0.5.1/
+---
+
 [![Go Report Card](https://goreportcard.com/badge/github.com/appscode/stash)](https://goreportcard.com/report/github.com/appscode/stash)
 
 # Stash

diff --git a/docs/_index.md b/docs/_index.md
@@ -0,0 +1,10 @@
+---
+title: Docs | Stash
+description: Stash Docs
+menu:
+  product_stash_0.5.1:
+    identifier: getting-started
+    name: Getting Started
+    weight: 10
+left_menu: product_stash_0.5.1
+---
diff --git a/docs/backends.md b/docs/backends.md
@@ -1,3 +1,20 @@
+---
+title: Backends | Stash
+description: Backends of Stash
+menu:
+  product_stash_0.5.1:
+    identifier: backends-stash
+    name: Backends
+    parent: getting-started
+    weight: 25
+product_name: stash
+left_menu: product_stash_0.5.1
+section_menu_id: getting-started
+url: /products/stash/0.5.1/getting-started/backends/
+aliases:
+  - /products/stash/0.5.1/backends/
+---
+
 > New to Stash? Please start [here](/docs/tutorial.md).
 
 # Stash Backends

diff --git a/docs/concept.md b/docs/concept.md
@@ -1,3 +1,20 @@
+---
+title: Concept | Stash
+description: Concepts of Stash
+menu:
+  product_stash_0.5.1:
+    identifier: concept-stash
+    name: Concept
+    parent: getting-started
+    weight: 30
+product_name: stash
+left_menu: product_stash_0.5.1
+section_menu_id: getting-started
+url: /products/stash/0.5.1/getting-started/concept/
+aliases:
+  - /products/stash/0.5.1/concept/
+---
+
 > New to Stash? Please start [here](/docs/tutorial.md).
 
 # Restics

diff --git a/docs/developer-guide/README.md b/docs/developer-guide/README.md
@@ -1,3 +1,17 @@
+title: Overview | Developer Guide
+description: Developer Guide Overview
+menu:
+  product_stash_0.5.1:
+    identifier: developer-guide-readme
+    name: Overview
+    parent: developer-guide
+    weight: 15
+product_name: stash
+left_menu: product_stash_0.5.1
+section_menu_id: developer-guide
+url: /products/stash/0.5.1/developer-guide/
+---
+
 ## Development Guide
 This document is intended to be the canonical source of truth for things like supported toolchain versions for building Stash.
 If you find a requirement that this doc does not capture, please submit an issue on github.

diff --git a/docs/developer-guide/_index.md b/docs/developer-guide/_index.md
@@ -0,0 +1,10 @@
+---
+title: Developer Guide | Stash
+description: Stash Developer Guide
+menu:
+  product_stash_0.5.1:
+    identifier: developer-guide
+    name: Developer Guide
+    weight: 30
+left_menu: product_stash_0.5.1
+---
diff --git a/docs/developer-guide/release.md b/docs/developer-guide/release.md
@@ -1,3 +1,17 @@
+---
+title: Release | Stash
+description: Stash Release
+menu:
+  product_stash_0.5.1:
+    identifier: release    
+    name: Release
+    parent: developer-guide
+    weight: 15
+product_name: stash
+left_menu: product_stash_0.5.1
+section_menu_id: developer-guide
+---
+
 # Release Process
 
 The following steps must be done from a Linux x64 bit machine.

diff --git a/docs/install.md b/docs/install.md
@@ -1,3 +1,20 @@
+---
+title: Install | Stash
+description: Install of Stash
+menu:
+  product_stash_0.5.1:
+    identifier: install-stash
+    name: Install
+    parent: getting-started
+    weight: 35
+product_name: stash
+left_menu: product_stash_0.5.1
+section_menu_id: getting-started
+url: /products/stash/0.5.1/getting-started/install/
+aliases:
+  - /products/stash/0.5.1/install/
+---
+
 > New to Stash? Please start [here](/docs/tutorial.md).
 
 # Installation Guide

diff --git a/docs/monitoring.md b/docs/monitoring.md
@@ -1,3 +1,20 @@
+---
+title: Monitoring | Stash
+description: monitoring of Stash
+menu:
+  product_stash_0.5.1:
+    identifier: monitoring-stash
+    name: Monitoring
+    parent: getting-started
+    weight: 40
+product_name: stash
+left_menu: product_stash_0.5.1
+section_menu_id: getting-started
+url: /products/stash/0.5.1/getting-started/monitoring/
+aliases:
+  - /products/stash/0.5.1/monitoring/
+---
+
 > New to Stash? Please start [here](/docs/tutorial.md).
 
 # Monitoring Stash

diff --git a/docs/rbac.md b/docs/rbac.md
@@ -1,3 +1,20 @@
+---
+title: rbac | Stash
+description: rbac of Stash
+menu:
+  product_stash_0.5.1:
+    identifier: rbac-stash
+    name: RBAC
+    parent: getting-started
+    weight: 45
+product_name: stash
+left_menu: product_stash_0.5.1
+section_menu_id: getting-started
+url: /products/stash/0.5.1/getting-started/rbac/
+aliases:
+  - /products/stash/0.5.1/rbac/
+---
+
 # Configuring RBAC
 
 To use Stash in a RBAC enabled cluster, [install Stash](/docs/install.md) with RBAC options. This creates a ClusterRole named `stash-sidecar`.

diff --git a/docs/reference/_index.md b/docs/reference/_index.md
@@ -0,0 +1,10 @@
+---
+title: Reference
+description: Stash CLI Reference
+menu:
+  product_stash_0.5.1:
+    identifier: reference
+    name: Reference
+    weight: 1000
+left_menu: product_stash_0.5.1
+---
diff --git a/docs/reference/stash.md b/docs/reference/stash.md
@@ -1,3 +1,19 @@
+---
+title: Stash
+menu:
+  product_stash_0.5.1:
+    identifier: stash
+    name: Stash
+    parent: reference
+    weight: 0
+
+product_name: stash
+left_menu: product_stash_0.5.1
+section_menu_id: reference
+aliases:
+  - products/stash/0.5.1/reference/
+
+---
 ## stash
 
 Stash by AppsCode - Backup your Kubernetes Volumes
@@ -22,8 +38,8 @@ Stash is a Kubernetes operator for restic. For more information, visit here: htt
 ```
 
 ### SEE ALSO
-* [stash recover](stash_recover.md)	 - Recover restic backup
-* [stash run](stash_run.md)	 - Run Stash operator
-* [stash schedule](stash_schedule.md)	 - Run Stash cron daemon
-* [stash version](stash_version.md)	 - Prints binary version number.
+* [stash recover](/docs/reference/stash_recover.md)	 - Recover restic backup
+* [stash run](/docs/reference/stash_run.md)	 - Run Stash operator
+* [stash schedule](/docs/reference/stash_schedule.md)	 - Run Stash cron daemon
+* [stash version](/docs/reference/stash_version.md)	 - Prints binary version number.
 
diff --git a/docs/reference/stash_recover.md b/docs/reference/stash_recover.md
@@ -1,3 +1,14 @@
+---
+title: Stash Recover
+menu:
+  product_stash_0.5.1:
+    identifier: stash-recover
+    name: Stash Recover
+    parent: reference
+product_name: stash
+left_menu: product_stash_0.5.1
+section_menu_id: reference
+---
 ## stash recover
 
 Recover restic backup
@@ -34,5 +45,5 @@ stash recover [flags]
 ```
 
 ### SEE ALSO
-* [stash](stash.md)	 - Stash by AppsCode - Backup your Kubernetes Volumes
+* [stash](/docs/reference/stash.md)	 - Stash by AppsCode - Backup your Kubernetes Volumes
 
diff --git a/docs/reference/stash_run.md b/docs/reference/stash_run.md
@@ -1,3 +1,14 @@
+---
+title: Stash Run
+menu:
+  product_stash_0.5.1:
+    identifier: stash-run
+    name: Stash Run
+    parent: reference
+product_name: stash
+left_menu: product_stash_0.5.1
+section_menu_id: reference
+---
 ## stash run
 
 Run Stash operator
@@ -37,5 +48,5 @@ stash run [flags]
 ```
 
 ### SEE ALSO
-* [stash](stash.md)	 - Stash by AppsCode - Backup your Kubernetes Volumes
+* [stash](/docs/reference/stash.md)	 - Stash by AppsCode - Backup your Kubernetes Volumes
 
diff --git a/docs/reference/stash_schedule.md b/docs/reference/stash_schedule.md
@@ -1,3 +1,14 @@
+---
+title: Stash Schedule
+menu:
+  product_stash_0.5.1:
+    identifier: stash-schedule
+    name: Stash Schedule
+    parent: reference
+product_name: stash
+left_menu: product_stash_0.5.1
+section_menu_id: reference
+---
 ## stash schedule
 
 Run Stash cron daemon
@@ -39,5 +50,5 @@ stash schedule [flags]
 ```
 
 ### SEE ALSO
-* [stash](stash.md)	 - Stash by AppsCode - Backup your Kubernetes Volumes
+* [stash](/docs/reference/stash.md)	 - Stash by AppsCode - Backup your Kubernetes Volumes
 
diff --git a/docs/reference/stash_version.md b/docs/reference/stash_version.md
@@ -1,3 +1,14 @@
+---
+title: Stash Version
+menu:
+  product_stash_0.5.1:
+    identifier: stash-version
+    name: Stash Version
+    parent: reference
+product_name: stash
+left_menu: product_stash_0.5.1
+section_menu_id: reference
+---
 ## stash version
 
 Prints binary version number.
@@ -31,5 +42,5 @@ stash version [flags]
 ```
 
 ### SEE ALSO
-* [stash](stash.md)	 - Stash by AppsCode - Backup your Kubernetes Volumes
+* [stash](/docs/reference/stash.md)	 - Stash by AppsCode - Backup your Kubernetes Volumes
 
diff --git a/docs/tutorial.md b/docs/tutorial.md
@@ -1,3 +1,20 @@
+---
+title: Tutorial | Stash
+description: tutorial of Stash
+menu:
+  product_stash_0.5.1:
+    identifier: tutorial-stash
+    name: Tutorial
+    parent: getting-started
+    weight: 45
+product_name: stash
+left_menu: product_stash_0.5.1
+section_menu_id: getting-started
+url: /products/stash/0.5.1/getting-started/tutorial/
+aliases:
+  - /products/stash/0.5.1/tutorial/
+---
+
 # Using Stash
 This tutorial will show you how to use Stash to backup a Kubernetes deployment. At first, you need to have a Kubernetes cluster,
 and the kubectl command-line tool must be configured to communicate with your cluster. If you do not already have a cluster,

diff --git a/docs/uninstall.md b/docs/uninstall.md
@@ -1,3 +1,20 @@
+---
+title: Uninstall | Stash
+description: uninstall of Stash
+menu:
+  product_stash_0.5.1:
+    identifier: uninstall-stash
+    name: Uninstall
+    parent: getting-started
+    weight: 50
+product_name: stash
+left_menu: product_stash_0.5.1
+section_menu_id: getting-started
+url: /products/stash/0.5.1/getting-started/uninstall/
+aliases:
+  - /products/stash/0.5.1/uninstall/
+---
+
 > New to Stash? Please start [here](/docs/tutorial.md).
 
 # Uninstall Stash

diff --git a/docs/workloads.md b/docs/workloads.md
@@ -1,3 +1,20 @@
+---
+title: Workloads | Stash
+description: workloads of Stash
+menu:
+  product_stash_0.5.1:
+    identifier: workloads-stash
+    name: Workloads
+    parent: getting-started
+    weight: 55
+product_name: stash
+left_menu: product_stash_0.5.1
+section_menu_id: getting-started
+url: /products/stash/0.5.1/getting-started/workloads/
+aliases:
+  - /products/stash/0.5.1/workloads/
+---
+
 > New to Stash? Please start [here](/docs/tutorial.md).
 
 # Supported Workloads