Reorganize docs

README.md

@@ -31,14 +31,11 @@ Please pick a version of Stash that matches your Kubernetes installation.
 To install Stash, please follow the guide [here](/docs/setup/install.md).
 
 ## Using Stash
-Want to learn how to use Stash? Please start [here](/docs/README.md).
+Want to learn how to use Stash? Please start [here](/docs/guides/README.md).
 
 ## Contribution guidelines
 Want to help improve Stash? Please start [here](/docs/CONTRIBUTING.md).
 
-## Developer Guide
-To view developer guide see [here](/docs/setup/developer-guide/README.md).
-
 ---
 
 **Stash binaries collects anonymous usage statistics to help us learn how the software is being used and how we can improve it. To disable stats collection, run the operator with the flag** `--analytics=false`.

docs/CONTRIBUTING.md

@@ -1,8 +1,24 @@
-> New to Stash? Please start [here](/docs/tutorials/README.md).
+---
+title: Contributing | Stash
+description: Contributing
+menu:
+  product_stash_0.5.1:
+    identifier: contributing-stash
+    name: Contributing
+    parent: welcome
+    weight: 10
+product_name: stash
+menu_name: product_stash_0.5.1
+section_menu_id: welcome
+url: /products/stash/0.5.1/welcome/contributing/
+aliases:
+  - /products/stash/0.5.1/CONTRIBUTING/
+---
 
 # Contribution Guidelines
+Want to hack on Stash?
 
-AppsCode projects are [Apache 2.0 licensed](LICENSE) and accept contributions via
+AppsCode projects are [Apache 2.0 licensed](https://github.com/appscode/stash/blob/master/LICENSE) and accept contributions via
 GitHub pull requests.  This document outlines some of the conventions on
 development workflow, commit message formatting, contact points and other
 resources to make it easier to get your contribution accepted.
@@ -12,25 +28,25 @@ resources to make it easier to get your contribution accepted.
 By contributing to this project you agree to the Developer Certificate of
 Origin (DCO). This document was created by the Linux Kernel community and is a
 simple statement that you, as a contributor, have the legal right to make the
-contribution. See the [DCO](DCO) file for details.
+contribution. See the [DCO](https://github.com/appscode/stash/blob/master/DCO) file for details.
 
 ## Developer Guide
 
-We have a [Developer Guide](/docs/setup/developer-guide/README.md) that outlines everything you need to know from setting up your
+We have a [Developer Guide](/docs/setup/developer-guide/overview.md) that outlines everything you need to know from setting up your
 dev environment to how to build and test Stash. If you find something undocumented or incorrect along the way,
 please feel free to send a Pull Request.
 
 ## Getting Help
 
-If you have a question about Stash or having problem using it, you can contact us on our public Slack channel. Follow [this link](https://slack.appscode.com) to get invitation to our Slack channel.
+If you have a question about Stash or having problem using it, you can contact us on the [AppsCode Slack team](https://appscode.slack.com/messages/C8NCX6N23/details/) channel `#stash`. Follow [this link](https://slack.appscode.com) to get invitation to our Slack channel.
 
 ## Bugs/Feature request
 
-If you have found a bug with Stash or want to request for new features, please [file an issue](https://github.com/appscode/Stash/issues/new).
+If you have found a bug with Stash or want to request for new features, please [file an issue](https://github.com/appscode/stash/issues/new).
 
 ## Submit PR
 
-If you fix a bug or developed a new feature, feel free to submit a PR. In either case, please file a [Github issue]((https://github.com/appscode/stash/issues/new)) first, so that we can have a discussion on it. This is a rough outline of what a contributor's workflow looks like:
+If you fix a bug or developed a new feature, feel free to submit a PR. In either case, please file a [Github issue](https://github.com/appscode/stash/issues/new) first, so that we can have a discussion on it. This is a rough outline of what a contributor's workflow looks like:
 
 - Create a topic branch from where you want to base your work (usually master).
 - Make commits of logical units.

docs/README.md

@@ -1,39 +1,29 @@
 ---
-title: Overview | Stash
-description: Overview of Stash
+title: Weclome | Stash
+description: Welcome to Stash
 menu:
   product_stash_0.5.1:
-    identifier: overview-stash
-    name: Overview
-    parent: getting-started
-    weight: 20
+    identifier: readme-stash
+    name: Readme
+    parent: welcome
+    weight: -1
 product_name: stash
 menu_name: product_stash_0.5.1
-section_menu_id: getting-started
-url: /products/stash/0.5.1/getting-started/
+section_menu_id: welcome
+url: /products/stash/0.5.1/welcome/
 aliases:
   - /products/stash/0.5.1/
   - /products/stash/0.5.1/README/
 ---
-
 # Stash
- Stash by AppsCode is a Kubernetes operator for [restic](https://restic.net). If you are running production workloads in Kubernetes, you might want to take backup of your disks. Traditional tools are too complex to setup and maintain in a dynamic compute environment like Kubernetes. `restic` is a backup program that is fast, efficient and secure with few moving parts. Stash is a CRD controller for Kubernetes built around `restic` to address these issues. Using Stash, you can backup Kubernetes volumes mounted in following types of workloads:
+ Stash by AppsCode is a Kubernetes operator for [restic](https://restic.net). If you are running production workloads in Kubernetes, you might want to take backup of your disks. Using Stash, you can backup Kubernetes volumes mounted in following types of workloads:
+
 - Deployment
 - DaemonSet
 - ReplicaSet
 - ReplicationController
 - StatefulSet
 
-## Features
- - Fast, secure, efficient backup of any kubernetes [volumes](https://kubernetes.io/docs/concepts/storage/volumes/).
- - Automates configuration of `restic` for periodic backup.
- - Store backed up files in various cloud storage provider, including S3, GCS, Azure, OpenStack Swift, DigitalOcean Spaces etc.
- - Restore backup easily.
- - Periodically check integrity of backed up data.
- - Take backup in offline mode.
- - Support workload initializer for faster backup.
- - Prometheus ready metrics for backup process.
-
 From here you can learn all about Stash's architecture and how to deploy and use Stash.
 
 - [Concepts](/docs/concepts/). Concepts explain some significant aspect of Stash. This is where you can learn about what Stash does and how it does it.
@@ -51,6 +41,6 @@ make our docs better.
 
 ---
 
-**The stash operator collects anonymous usage statistics to help us learn how the software is being used and how we can improve it. To disable stats collection, run the operator with the flag** `--analytics=false`.
+**Stash binaries collects anonymous usage statistics to help us learn how the software is being used and how we can improve it. To disable stats collection, run the operator with the flag** `--analytics=false`.
 
 ---

docs/_index.md

@@ -3,8 +3,8 @@ title: Docs | Stash
 description: Stash Docs
 menu:
   product_stash_0.5.1:
-    identifier: getting-started
-    name: Getting Started
+    identifier: welcome
+    name: Welcome
     weight: 10
 menu_name: product_stash_0.5.1
----
+---

docs/concepts/README.md

@@ -1,3 +1,24 @@
+---
+title: Concepts | Stash
+menu:
+  product_stash_0.5.1:
+    identifier: concepts-readme
+    name: Readme
+    parent: concepts
+    weight: -1
+product_name: stash
+menu_name: product_stash_0.5.1
+section_menu_id: concepts
+url: /products/stash/0.5.1/concepts/
+aliases:
+  - /products/stash/0.5.1/concepts/README/
+---
 # Concepts
 
-Concepts help you learn about the different parts of the Stash tool and the abstractions it uses.
+Concepts help you learn about the different parts of the Stash and the abstractions it uses.
+
+- What is Stash?
+  - [Overview](/docs/concepts/what-is-stash/overview.md). Provides a conceptual introduction to Stash, including the problems it solves and its high-level architecture.
+- Custom Resource Definitions
+  - [Restic](/docs/concepts/crds/restic.md). Introduces the concept of `Restic` for configuring [restic](https://restic.net) in a Kubernetes native way.
+  - [Recovery](/docs/concepts/crds/recovery.md). Introduces the concept of `Recovery` to restore a backup taken using Stash.

docs/concepts/_index.md

@@ -0,0 +1,10 @@
+---
+title: Concepts
+description: Stash Concepts
+menu:
+  product_stash_0.5.1:
+    identifier: concepts
+    name: Concepts
+    weight: 20
+menu_name: product_stash_0.5.1
+---

docs/concepts/crds/_index.md

@@ -0,0 +1,11 @@
+---
+title: Custom Resource Definitions | Stash
+description: Custom Resource Definitions
+menu:
+  product_stash_0.5.1:
+    identifier: crds
+    parent: concepts
+    name: Types of Alerts
+    weight: 15
+menu_name: product_stash_0.5.1
+---

docs/concepts/recovery.md → docs/concepts/crds/recovery.md

@@ -1,21 +1,17 @@
 ---
-title: Concept | Stash
-description: Concepts of Stash
+title: Recovery Overview
 menu:
   product_stash_0.5.1:
-    identifier: concept-stash
-    name: Concept
-    parent: getting-started
-    weight: 30
+    identifier: recovery-overview
+    name: Recovery
+    parent: crds
+    weight: 5
 product_name: stash
 menu_name: 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/
+section_menu_id: concepts
 ---
 
-> New to Stash? Please start [here](/docs/guides/README.md).
+> New to Stash? Please start [here](/docs/concepts/README.md).
 
 # Recoveries
 
@@ -142,7 +138,7 @@ Stash operator updates `.status` of a Recovery CRD when recovery operation is co
 ## Next Steps
 
 - Learn how to use Stash to backup a Kubernetes deployment [here](/docs/guides/backup.md).
-- Learn about the details of Restic CRD [here](/docs/concepts/restic.md).
+- Learn about the details of Restic CRD [here](/docs/concepts/crds/restic.md).
 - To restore a backup see [here](/docs/guides/restore.md).
 - To run backup in offline mode see [here](/docs/guides/offline_backup.md)
 - See the list of supported backends and how to configure them [here](/docs/guides/backends.md).

docs/concepts/restic.md → docs/concepts/crds/restic.md

@@ -1,21 +1,17 @@
 ---
-title: Concept | Stash
-description: Concepts of Stash
+title: Restic Overview
 menu:
   product_stash_0.5.1:
-    identifier: concept-stash
-    name: Concept
-    parent: getting-started
-    weight: 30
+    identifier: recovery-overview
+    name: Restic
+    parent: crds
+    weight: 5
 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/
+menu_name: product_stash_0.5.1
+section_menu_id: concepts
 ---
 
-> New to Stash? Please start [here](/docs/guides/README.md).
+> New to Stash? Please start [here](/docs/concepts/README.md).
 
 # Restics
 
@@ -119,6 +115,7 @@ Stash operator updates `.status` of a Restic CRD every time a backup operation i
 
 ## Workload Annotations
 For each workload where a sidecar container is added by Stash operator, the following annotations are added:
+
  - `restic.appscode.com/last-applied-configuration` indicates the configuration of applied Restic CRD.
  - `restic.appscode.com/tag` indicates the tag of `appscode/stash` Docker image that was added as sidecar.
 
@@ -135,7 +132,7 @@ To stop taking backup, you can do 2 things:
 
 - Learn how to use Stash to backup a Kubernetes deployment [here](/docs/guides/backup.md).
 - To restore a backup see [here](/docs/guides/restore.md).
-- Learn about the details of Recovery CRD [here](/docs/concepts/recovery.md).
+- Learn about the details of Recovery CRD [here](/docs/concepts/crds/recovery.md).
 - To run backup in offline mode see [here](/docs/guides/offline_backup.md)
 - See the list of supported backends and how to configure them [here](/docs/guides/backends.md).
 - See working examples for supported workload types [here](/docs/guides/workloads.md).

docs/concepts/what-is-stash/_index.md

@@ -0,0 +1,11 @@
+---
+title: What is Stash
+description: What is Stash
+menu:
+  product_stash_0.5.1:
+    identifier: what-is-stash
+    parent: concepts
+    name: What is Stash
+    weight: 10
+menu_name: product_stash_0.5.1
+---

docs/concepts/overview.md → docs/concepts/what-is-stash/overview.md

@@ -1,5 +1,20 @@
+---
+title: Stash Overview
+description: Stash Overview
+menu:
+  product_stash_0.5.1:
+    identifier: overview-concepts
+    name: Overview
+    parent: what-is-stash
+    weight: 10
+product_name: stash
+menu_name: product_stash_0.5.1
+section_menu_id: concepts
+---
 # Stash
+
  Stash by AppsCode is a Kubernetes operator for [restic](https://restic.net). If you are running production workloads in Kubernetes, you might want to take backup of your disks. Traditional tools are too complex to setup and maintain in a dynamic compute environment like Kubernetes. `restic` is a backup program that is fast, efficient and secure with few moving parts. Stash is a CRD controller for Kubernetes built around `restic` to address these issues. Using Stash, you can backup Kubernetes volumes mounted in following types of workloads:
+
 - Deployment
 - DaemonSet
 - ReplicaSet

docs/guides/README.md

@@ -1,15 +1,28 @@
-# Tutorials
+---
+title: Table of Contents | Guides
+description: Table of Contents | Guides
+menu:
+  product_stash_0.5.1:
+    identifier: guides-readme
+    name: Readme
+    parent: guides
+    weight: -1
+product_name: stash
+menu_name: product_stash_0.5.1
+section_menu_id: guides
+url: /products/stash/0.5.1/guides/
+aliases:
+  - /products/stash/0.5.1/guides/README/
+---
+# Guides
 
-This section contains guides on how to use Stash. Please visit the links below to learn more:
+Guides show you how to perform tasks with Stash.
 
 - Learn how to use Stash to backup a Kubernetes deployment [here](/docs/guides/backup.md).
-- Learn about the details of Restic CRD [here](/docs/concepts/restic.md).
 - To restore a backup see [here](/docs/guides/restore.md).
-- Learn about the details of Recovery CRD [here](/docs/concepts/recovery.md).
 - To run backup in offline mode see [here](/docs/guides/offline_backup.md)
 - See the list of supported backends and how to configure them [here](/docs/guides/backends.md).
 - See working examples for supported workload types [here](/docs/guides/workloads.md).
 - Thinking about monitoring your backup operations? Stash works [out-of-the-box with Prometheus](/docs/guides/monitoring.md).
 - Learn about how to configure [RBAC roles](/docs/guides/rbac.md).
 - Learn about how to configure Stash operator as workload initializer [here](/docs/guides/initializer.md).
-- Want to hack on Stash? Check our [contribution guidelines](/docs/CONTRIBUTING.md).

docs/guides/_index.md

@@ -0,0 +1,9 @@
+---
+title: Guides | Stash
+menu:
+  product_stash_0.5.1:
+    identifier: guides
+    name: Guides
+    weight: 40
+menu_name: product_stash_0.5.1
+---