Reorganize files & write front matter

README.md

@@ -30,24 +30,23 @@ Please pick a version of KubeDB that matches your Kubernetes installation.
 | [0.6.0](https://github.com/kubedb/cli/releases/tag/0.6.0) (uses TPR) | [User Guide](https://github.com/kubedb/cli/tree/0.6.0/docs) | 1.5.x - 1.7.x      |
 
 ## Installation
-To install KubeDB, please follow the guide [here](/docs/install.md).
+To install KubeDB, please follow the guide [here](/docs/setup/install.md).
 
 ## Using KubeDB
-Want to learn how to use KubeDB? Please start [here](/docs/tutorials/README.md).
+Want to learn how to use KubeDB? Please start [here](/docs/guides//README.md).
 
 ## Contribution guidelines
-Want to help improve KubeDB? Please start [here](/CONTRIBUTING.md).
-
-## Project Status
-Wondering what features are coming next? Please visit [here](/ROADMAP.md).
+Want to help improve KubeDB? Please start [here](/docs/CONTRIBUTING.md).
 
 ---
 
-**The KubeDB 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`.
+**KubeDB 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`.
 
 ---
 
 ## Support
-If you have any questions, talk to us on the [Kubernetes Slack team](http://slack.kubernetes.io/) channel `#kubedb`.
+We use Slack for public discussions. To chit chat with us or the rest of the community, join us in the [Kubernetes Slack team](https://kubernetes.slack.com/messages/C8149MREV/) channel `#kubedb`. To sign up, use our [Slack inviter](http://slack.kubernetes.io/).
+
+To receive product annoucements, please join our [mailing list](https://groups.google.com/forum/#!forum/kubedb) or follow us on [Twitter](https://twitter.com/KubeDB). Our mailing list is also used to share design docs shared via Google docs.
 
-If you have found a bug with KubeDB or want to request for new features, please file issues under [kubedb/project](https://github.com/kubedb/project/issues/new) repository.
+If you have found a bug with KubeDB or want to request for new features, please [file an issue](https://github.com/kubedb/project/issues/new).

docs/CONTRIBUTING.md

@@ -0,0 +1,55 @@
+---
+title: Contributing | KubeDB
+description: Contributing
+menu:
+  docs_0.8.0-beta.0:
+    identifier: contributing-cli
+    name: Contributing
+    parent: welcome
+    weight: 10
+menu_name: docs_0.8.0-beta.0
+section_menu_id: welcome
+url: /docs/0.8.0-beta.0/welcome/contributing/
+aliases:
+  - /docs/0.8.0-beta.0/CONTRIBUTING/
+---
+
+# Contribution Guidelines
+Want to hack on KubeDB?
+
+AppsCode projects are [Apache 2.0 licensed](https://github.com/kubedb/cli/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.
+
+## Certificate of Origin
+
+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](https://github.com/kubedb/cli/blob/master/DCO) file for details.
+
+## Developer Guide
+
+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 KubeDB. If you find something undocumented or incorrect along the way, please feel free to send a Pull Request.
+
+## Getting Help
+
+We use Slack for public discussions. To chit chat with us or the rest of the community, join us in the [Kubernetes Slack team](https://kubernetes.slack.com/messages/C8149MREV/) channel `#kubedb`. To sign up, use our [Slack inviter](http://slack.kubernetes.io/).
+
+To receive product annoucements, please join our [mailing list](https://groups.google.com/forum/#!forum/kubedb) or follow us on [Twitter](https://twitter.com/KubeDB). Our mailing list is also used to share design docs shared via Google docs.
+
+## Bugs/Feature request
+
+If you have found a bug with KubeDB or want to request for new features, please [file an issue](https://github.com/kubedb/project/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/kubedb/project/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.
+- Push your changes to a topic branch in your fork of the repository.
+- Make sure the tests pass, and add any new tests as appropriate.
+- Submit a pull request to the original repository.
+
+Thanks for your contributions!
+
+## Spread the word
+
+If you have written blog post or tutorial on KubeDB, please share it with us on [Twitter](https://twitter.com/KubeDB) or the [Kubernetes Slack team](http://slack.kubernetes.io) channel `#kubedb`.

docs/README.md

@@ -1,24 +1,23 @@
-
 ---
-title: KubeDB Overview
+title: Weclome | KubeDB
+description: Welcome to CLI
 menu:
-  docs_0.8.0:
-    identifier: kubedb-overview
-    name: Overview
-    parent: getting-started
-    weight: 10
-menu_name: docs_0.8.0
-section_menu_id: getting-started
-url: /docs/0.8.0/getting-started/
+  docs_0.8.0-beta.0:
+    identifier: readme-cli
+    name: Readme
+    parent: welcome
+    weight: -1
+menu_name: docs_0.8.0-beta.0
+section_menu_id: welcome
+url: /docs/0.8.0-beta.0/welcome/
 aliases:
-  - /docs/0.8.0/
-  - /docs/0.8.0/README/
+  - /docs/0.8.0-beta.0/
+  - /docs/0.8.0-beta.0/README/
 ---
 
-[![Go Report Card](https://goreportcard.com/badge/github.com/kubedb/cli)](https://goreportcard.com/report/github.com/kubedb/cli)
-
 # KubeDB
-Running production quality database in Kubernetes can be tricky to say the least. In the early days of Kubernetes, replication controllers were used to run a single pod for a database. With the introduction of StatefulSet, it became easy to run a docker container for any database. But what about monitoring, taking periodic backups, restoring from backups or cloning from an existing database? KubeDB is a framework for writing operators for any database that support the following operational requirements:
+
+Running production quality databases in Kubernetes can be tricky. KubeDB is a framework for writing operators for any database that support the following operational requirements:
 
  - Create a database declaratively using CRD.
  - Take one-off backups or period backups to various cloud stores, eg,, S3, GCS, etc.
@@ -28,36 +27,28 @@ Running production quality database in Kubernetes can be tricky to say the least
  - Keep track of deleted databases, cleanup prior snapshots with a single command.
  - Use cli to manage databases like kubectl for Kubernetes.
 
-KubeDB is developed at [AppsCode](https://twitter.com/AppsCodeHQ) to run their SAAS platform on Kubernetes. Currently we include complete implementations for Postgres and Elasticsearch database.
+Currently KubeDB includes support for following datastores:
+ - Postgres
+ - Elasticsearch
+ - MySQL
+ - MongoDB
+ - Redis
+ - Memcached
 
-## Supported Versions
-Please pick a version of KubeDB that matches your Kubernetes installation.
+From here you can learn all about KubeDB's architecture and how to deploy and use KubeDB.
 
-| KubeDB Version                                                       | Docs                                                        | Kubernetes Version |
-|----------------------------------------------------------------------|-------------------------------------------------------------|--------------------|
-| [0.7.1](https://github.com/kubedb/cli/releases/tag/0.7.1) (uses CRD) | [User Guide](https://github.com/kubedb/cli/tree/0.7.1/docs) | 1.7.x +            |
-| [0.6.0](https://github.com/kubedb/cli/releases/tag/0.6.0) (uses TPR) | [User Guide](https://github.com/kubedb/cli/tree/0.6.0/docs) | 1.5.x - 1.7.x      |
+- [Concepts](/docs/concepts/). Concepts explain some significant aspect of KubeDB. This is where you can learn about what KubeDB does and how it does it.
 
-## Installation
-To install KubeDB, please follow the guide [here](/docs/install.md).
+- [Setup](/docs/setup/). Setup contains instructions for installing the KubeDB in various cloud providers.
 
-## Using KubeDB
-Want to learn how to use KubeDB? Please start [here](/docs/tutorials/README.md).
+- [Guides](/docs/guides/). Guides show you how to perform tasks with KubeDB.
 
-## Contribution guidelines
-Want to help improve KubeDB? Please start [here](/CONTRIBUTING.md).
+- [Reference](/docs/reference/). Detailed exhaustive lists of command-line options, configuration options, API definitions, and procedures.
 
-## Project Status
-Wondering what features are coming next? Please visit [here](/ROADMAP.md).
+We're always looking for help improving our documentation, so please don't hesitate to [file an issue](https://github.com/kubedb/project/issues/new) if you see some problem. Or better yet, submit your own [contributions](/docs/CONTRIBUTING.md) to help make our docs better.
 
 ---
 
-**The KubeDB 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`.
+**KubeDB 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`.
 
 ---
-
-## Support
-If you have any questions, you can reach out to us.
-* [Slack](https://slack.appscode.com)
-* [Twitter](https://twitter.com/AppsCodeHQ)
-* [Website](https://appscode.com)

docs/_index.md

@@ -1,9 +1,9 @@
 ---
 title: KubeDB
 menu:
-  docs_0.8.0:
-    identifier: getting-started
-    name: Getting Started
+  docs_0.8.0-beta.0:
+    identifier: welcome
+    name: Welcome
     weight: 10
-menu_name: docs_0.8.0
+menu_name: docs_0.8.0-beta.0
 ---

docs/concepts/README.md

@@ -0,0 +1,18 @@
+---
+title: Concepts | KubeDB
+menu:
+  docs_0.8.0-beta.0:
+    identifier: concepts-readme
+    name: Readme
+    parent: concepts
+    weight: -1
+menu_name: docs_0.8.0-beta.0
+section_menu_id: concepts
+url: /docs/0.8.0-beta.0/concepts/
+aliases:
+  - /docs/0.8.0-beta.0/concepts/README/
+---
+
+# Concepts
+
+Concepts help you learn about the different parts of the CLI and the abstractions it uses.

docs/concepts/_index.md

@@ -1,9 +1,10 @@
 ---
-title: KubeDB Concepts
+title: Concepts
+description: Concepts
 menu:
-  docs_0.8.0:
+  docs_0.8.0-beta.0:
     identifier: concepts
     name: Concepts
     weight: 20
-menu_name: docs_0.8.0
+menu_name: docs_0.8.0-beta.0
 ---

docs/concepts/elasticsearch.md

@@ -1,18 +1,16 @@
 ---
 title: Elasticsearch Concepts
 menu:
-  docs_0.8.0:
+  docs_0.8.0-beta.0:
     identifier: concepts-elasticsearch
     name: Elasticsearch
     parent: concepts
     weight: 10
-menu_name: docs_0.8.0
+menu_name: docs_0.8.0-beta.0
 section_menu_id: concepts
-aliases:
-  - /docs/0.8.0/concepts/
 ---
 
-> New to KubeDB? Please start [here](/docs/tutorials/README.md).
+> New to KubeDB? Please start [here](/docs/guides/README.md).
 
 # Elasticsearch
 
@@ -180,7 +178,7 @@ KubeDB supports taking periodic snapshots for Elasticsearch database. This is an
 
  - `spec.backupSchedule.cronExpression` is a required [cron expression](https://github.com/robfig/cron/blob/v2/doc.go#L26). This specifies the schedule for backup operations.
 
- - `spec.backupSchedule.{storage}` is a required field that is used as the destination for storing snapshot data. KubeDB supports cloud storage providers like S3, GCS, Azure and OpenStack Swift. It also supports any locally mounted Kubernetes volumes, like NFS, Ceph , etc. Only one backend can be used at a time. To learn how to configure this, please visit [here](/docs/concepts/snapshots.md).
+ - `spec.backupSchedule.{storage}` is a required field that is used as the destination for storing snapshot data. KubeDB supports cloud storage providers like S3, GCS, Azure and OpenStack Swift. It also supports any locally mounted Kubernetes volumes, like NFS, Ceph , etc. Only one backend can be used at a time. To learn how to configure this, please visit [here](/docs/concepts/snapshot.md).
 
  - `spec.backupSchedule.resources` is an optional field that can request compute resources required by Jobs used to take snapshot or initialize databases from snapshot.  To learn more, visit [here](http://kubernetes.io/docs/user-guide/compute-resources/).
 
@@ -198,9 +196,9 @@ To learn how to monitor Elasticsearch databases, please visit [here](/docs/conce
 
 
 ## Next Steps
-- Learn how to use KubeDB to run an Elasticsearch database [here](/docs/tutorials/elasticsearch/README.md).
+- Learn how to use KubeDB to run an Elasticsearch database [here](/docs/guides/elasticsearch/overview.md).
 - See the list of supported storage providers for snapshots [here](/docs/concepts/snapshot.md).
-- Thinking about monitoring your database? KubeDB works [out-of-the-box with Prometheus](/docs/tutorials/monitoring.md).
-- Learn how to use KubeDB in a [RBAC](/docs/tutorials/rbac.md) enabled cluster.
-- Wondering what features are coming next? Please visit [here](/ROADMAP.md).
-- Want to hack on KubeDB? Check our [contribution guidelines](/CONTRIBUTING.md).
+- Thinking about monitoring your database? KubeDB works [out-of-the-box with Prometheus](/docs/guides/monitoring.md).
+- Learn how to use KubeDB in a [RBAC](/docs/guides/rbac.md) enabled cluster.
+- Wondering what features are coming next? Please visit [here](/docs/roadmap.md).
+- Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md).

docs/concepts/memcached.md

@@ -1,4 +1,16 @@
-> New to KubeDB? Please start [here](/docs/tutorials/README.md).
+---
+title: Memcached Concepts
+menu:
+  docs_0.8.0-beta.0:
+    identifier: concepts-memcached
+    name: Memcached
+    parent: concepts
+    weight: 13
+menu_name: docs_0.8.0-beta.0
+section_menu_id: concepts
+---
+
+> New to KubeDB? Please start [here](/docs/guides/README.md).
 
 # Memcached
 
@@ -60,8 +72,8 @@ To learn how to monitor Memcached databases, please visit [here](/docs/concepts/
 
 
 ## Next Steps
-- Learn how to use KubeDB to run a Memcached database [here](/docs/tutorials/memcached/README.md).
-- Thinking about monitoring your database? KubeDB works [out-of-the-box with Prometheus](/docs/tutorials/monitoring.md).
-- Learn how to use KubeDB in a [RBAC](/docs/tutorials/rbac.md) enabled cluster.
-- Wondering what features are coming next? Please visit [here](/ROADMAP.md).
-- Want to hack on KubeDB? Check our [contribution guidelines](/CONTRIBUTING.md).
+- Learn how to use KubeDB to run a Memcached database [here](/docs/guides/memcached/overview.md).
+- Thinking about monitoring your database? KubeDB works [out-of-the-box with Prometheus](/docs/guides/monitoring.md).
+- Learn how to use KubeDB in a [RBAC](/docs/guides/rbac.md) enabled cluster.
+- Wondering what features are coming next? Please visit [here](/docs/roadmap.md).
+- Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md).

docs/concepts/mongodb.md

@@ -1,4 +1,16 @@
-> New to KubeDB? Please start [here](/docs/tutorials/README.md).
+---
+title: MongoDB Concepts
+menu:
+  docs_0.8.0-beta.0:
+    identifier: concepts-mongodb
+    name: MongoDB
+    parent: concepts
+    weight: 15
+menu_name: docs_0.8.0-beta.0
+section_menu_id: concepts
+---
+
+> New to KubeDB? Please start [here](/docs/guides/README.md).
 
 # MongoDB
 
@@ -143,7 +155,7 @@ KubeDB supports taking periodic snapshots for MongoDB database. This is an optio
 
  - `spec.backupSchedule.cronExpression` is a required [cron expression](https://github.com/robfig/cron/blob/v2/doc.go#L26). This specifies the schedule for backup operations.
 
- - `spec.backupSchedule.{storage}` is a required field that is used as the destination for storing snapshot data. KubeDB supports cloud storage providers like S3, GCS, Azure and OpenStack Swift. It also supports any locally mounted Kubernetes volumes, like NFS, Ceph , etc. Only one backend can be used at a time. To learn how to configure this, please visit [here](/docs/concepts/snapshots.md).
+ - `spec.backupSchedule.{storage}` is a required field that is used as the destination for storing snapshot data. KubeDB supports cloud storage providers like S3, GCS, Azure and OpenStack Swift. It also supports any locally mounted Kubernetes volumes, like NFS, Ceph , etc. Only one backend can be used at a time. To learn how to configure this, please visit [here](/docs/concepts/snapshot.md).
 
  - `spec.backupSchedule.resources` is an optional field that can request compute resources required by Jobs used to take snapshot or initialize databases from snapshot.  To learn more, visit [here](http://kubernetes.io/docs/user-guide/compute-resources/).
 
@@ -161,9 +173,9 @@ To learn how to monitor MongoDB databases, please visit [here](/docs/concepts/mo
 
 
 ## Next Steps
-- Learn how to use KubeDB to run a MongoDB database [here](/docs/tutorials/mongodb/README.md).
+- Learn how to use KubeDB to run a MongoDB database [here](/docs/guides/mongodb/overview.md).
 - See the list of supported storage providers for snapshots [here](/docs/concepts/snapshot.md).
-- Thinking about monitoring your database? KubeDB works [out-of-the-box with Prometheus](/docs/tutorials/monitoring.md).
-- Learn how to use KubeDB in a [RBAC](/docs/tutorials/rbac.md) enabled cluster.
-- Wondering what features are coming next? Please visit [here](/ROADMAP.md).
-- Want to hack on KubeDB? Check our [contribution guidelines](/CONTRIBUTING.md).
+- Thinking about monitoring your database? KubeDB works [out-of-the-box with Prometheus](/docs/guides/monitoring.md).
+- Learn how to use KubeDB in a [RBAC](/docs/guides/rbac.md) enabled cluster.
+- Wondering what features are coming next? Please visit [here](/docs/roadmap.md).
+- Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md).