From e62cb48fcb938e4a8fe56f2b2a1bbd9b4668cf40 Mon Sep 17 00:00:00 2001 From: Tamal Saha Date: Sat, 6 Jan 2018 22:56:15 -0800 Subject: [PATCH] Fix docs (#150) --- README.md | 14 ++++---- docs/README.md | 20 +----------- docs/concepts/databases/_index.md | 11 +++++++ .../concepts/{ => databases}/elasticsearch.md | 6 ++-- docs/concepts/{ => databases}/memcached.md | 8 ++--- docs/concepts/{ => databases}/mongodb.md | 8 ++--- docs/concepts/{ => databases}/mysql.md | 6 ++-- docs/concepts/{ => databases}/postgres.md | 8 ++--- docs/concepts/{ => databases}/redis.md | 6 ++-- docs/concepts/what-is-kubedb/_index.md | 11 +++++++ docs/concepts/what-is-kubedb/overview.md | 32 +++++++++++++++++++ 11 files changed, 83 insertions(+), 47 deletions(-) create mode 100644 docs/concepts/databases/_index.md rename docs/concepts/{ => databases}/elasticsearch.md (99%) rename docs/concepts/{ => databases}/memcached.md (96%) rename docs/concepts/{ => databases}/mongodb.md (98%) rename docs/concepts/{ => databases}/mysql.md (99%) rename docs/concepts/{ => databases}/postgres.md (99%) rename docs/concepts/{ => databases}/redis.md (98%) create mode 100644 docs/concepts/what-is-kubedb/_index.md create mode 100644 docs/concepts/what-is-kubedb/overview.md diff --git a/README.md b/README.md index 2ef56a509..82d210382 100644 --- a/README.md +++ b/README.md @@ -24,19 +24,19 @@ KubeDB is developed at [AppsCode](https://twitter.com/AppsCodeHQ) to run their S ## Supported Versions Please pick a version of KubeDB that matches your Kubernetes installation. -| 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 | +| KubeDB Version | Docs | Kubernetes Version | +|------------------------------------------------------------------------------------|-------------------------------------------------------------|--------------------| +| [0.8.0-beta.0](https://github.com/kubedb/cli/releases/tag/0.8.0-beta.0) (uses CRD) | [User Guide](https://kubedb.com/docs/0.8.0-beta.0/) | 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 | ## Installation -To install KubeDB, please follow the guide [here](/docs/setup/install.md). +To install KubeDB, please follow the guide [here](https://kubedb.com/docs/latest/setup/install/). ## Using KubeDB -Want to learn how to use KubeDB? Please start [here](/docs/guides//README.md). +Want to learn how to use KubeDB? Please start [here](https://kubedb.com/docs/latest/guides/). ## Contribution guidelines -Want to help improve KubeDB? Please start [here](/docs/CONTRIBUTING.md). +Want to help improve KubeDB? Please start [here](https://kubedb.com/docs/latest/welcome/contributing/). --- diff --git a/docs/README.md b/docs/README.md index 30ef5e97a..7354fdf89 100644 --- a/docs/README.md +++ b/docs/README.md @@ -15,25 +15,7 @@ aliases: - /docs/0.8.0-beta.0/README/ --- -# KubeDB - -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. - - Restore from backup or clone any database. - - Native integration with Prometheus for monitoring via [CoreOS Prometheus Operator](https://github.com/coreos/prometheus-operator). - - Apply deletion lock to avoid accidental deletion of database. - - Keep track of deleted databases, cleanup prior snapshots with a single command. - - Use cli to manage databases like kubectl for Kubernetes. - -Currently KubeDB includes support for following datastores: - - Postgres - - Elasticsearch - - MySQL - - MongoDB - - Redis - - Memcached +# Welcome From here you can learn all about KubeDB's architecture and how to deploy and use KubeDB. diff --git a/docs/concepts/databases/_index.md b/docs/concepts/databases/_index.md new file mode 100644 index 000000000..0ec0200d3 --- /dev/null +++ b/docs/concepts/databases/_index.md @@ -0,0 +1,11 @@ +--- +title: Supported Databases | KubeDB +description: Supported Databases +menu: + docs_0.8.0-beta.0: + identifier: databases + parent: concepts + name: Supported Databases + weight: 15 +menu_name: docs_0.8.0-beta.0 +--- diff --git a/docs/concepts/elasticsearch.md b/docs/concepts/databases/elasticsearch.md similarity index 99% rename from docs/concepts/elasticsearch.md rename to docs/concepts/databases/elasticsearch.md index e2bef4c8b..b9408f9dc 100644 --- a/docs/concepts/elasticsearch.md +++ b/docs/concepts/databases/elasticsearch.md @@ -1,10 +1,10 @@ --- -title: Elasticsearch Concepts +title: Elasticsearch menu: docs_0.8.0-beta.0: - identifier: concepts-elasticsearch + identifier: elasticsearch-db name: Elasticsearch - parent: concepts + parent: databases weight: 10 menu_name: docs_0.8.0-beta.0 section_menu_id: concepts diff --git a/docs/concepts/memcached.md b/docs/concepts/databases/memcached.md similarity index 96% rename from docs/concepts/memcached.md rename to docs/concepts/databases/memcached.md index 8cc88769f..2ada352c4 100644 --- a/docs/concepts/memcached.md +++ b/docs/concepts/databases/memcached.md @@ -1,11 +1,11 @@ --- -title: Memcached Concepts +title: Memcached menu: docs_0.8.0-beta.0: - identifier: concepts-memcached + identifier: memcached-db name: Memcached - parent: concepts - weight: 13 + parent: databases + weight: 15 menu_name: docs_0.8.0-beta.0 section_menu_id: concepts --- diff --git a/docs/concepts/mongodb.md b/docs/concepts/databases/mongodb.md similarity index 98% rename from docs/concepts/mongodb.md rename to docs/concepts/databases/mongodb.md index f757c694c..85cd33d23 100644 --- a/docs/concepts/mongodb.md +++ b/docs/concepts/databases/mongodb.md @@ -1,11 +1,11 @@ --- -title: MongoDB Concepts +title: MongoDB menu: docs_0.8.0-beta.0: - identifier: concepts-mongodb + identifier: mongodb-db name: MongoDB - parent: concepts - weight: 15 + parent: databases + weight: 20 menu_name: docs_0.8.0-beta.0 section_menu_id: concepts --- diff --git a/docs/concepts/mysql.md b/docs/concepts/databases/mysql.md similarity index 99% rename from docs/concepts/mysql.md rename to docs/concepts/databases/mysql.md index 15969b016..914db3195 100644 --- a/docs/concepts/mysql.md +++ b/docs/concepts/databases/mysql.md @@ -2,10 +2,10 @@ title: MySQL menu: docs_0.8.0-beta.0: - identifier: mysql-concepts + identifier: mysql-db name: MySQL - parent: concepts - weight: 20 + parent: databases + weight: 25 menu_name: docs_0.8.0-beta.0 section_menu_id: concepts --- diff --git a/docs/concepts/postgres.md b/docs/concepts/databases/postgres.md similarity index 99% rename from docs/concepts/postgres.md rename to docs/concepts/databases/postgres.md index a67818727..27b039db2 100644 --- a/docs/concepts/postgres.md +++ b/docs/concepts/databases/postgres.md @@ -1,11 +1,11 @@ --- -title: Postgres Concepts +title: Postgres menu: docs_0.8.0-beta.0: - identifier: concepts-postgres + identifier: postgres-db name: Postgres - parent: concepts - weight: 25 + parent: databases + weight: 30 menu_name: docs_0.8.0-beta.0 section_menu_id: concepts --- diff --git a/docs/concepts/redis.md b/docs/concepts/databases/redis.md similarity index 98% rename from docs/concepts/redis.md rename to docs/concepts/databases/redis.md index 08f93a763..ea0fb4558 100644 --- a/docs/concepts/redis.md +++ b/docs/concepts/databases/redis.md @@ -2,10 +2,10 @@ title: Redis menu: docs_0.8.0-beta.0: - identifier: redis-concepts + identifier: redis-db name: Redis - parent: concepts - weight: 30 + parent: databases + weight: 35 menu_name: docs_0.8.0-beta.0 section_menu_id: concepts --- diff --git a/docs/concepts/what-is-kubedb/_index.md b/docs/concepts/what-is-kubedb/_index.md new file mode 100644 index 000000000..91afd7112 --- /dev/null +++ b/docs/concepts/what-is-kubedb/_index.md @@ -0,0 +1,11 @@ +--- +title: What is KubeDB +description: What is KubeDB +menu: + docs_0.8.0-beta.0: + identifier: what-is-kubedb + parent: concepts + name: What is KubeDB + weight: 10 +menu_name: docs_0.8.0-beta.0 +--- diff --git a/docs/concepts/what-is-kubedb/overview.md b/docs/concepts/what-is-kubedb/overview.md new file mode 100644 index 000000000..78db9eba9 --- /dev/null +++ b/docs/concepts/what-is-kubedb/overview.md @@ -0,0 +1,32 @@ +--- +title: KubeDB Overview +description: KubeDB Overview +menu: + docs_0.8.0-beta.0: + identifier: overview-concepts + name: Overview + parent: what-is-kubedb + weight: 10 +menu_name: docs_0.8.0-beta.0 +section_menu_id: concepts +--- + +# KubeDB + +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. + - Restore from backup or clone any database. + - Native integration with Prometheus for monitoring via [CoreOS Prometheus Operator](https://github.com/coreos/prometheus-operator). + - Apply deletion lock to avoid accidental deletion of database. + - Keep track of deleted databases, cleanup prior snapshots with a single command. + - Use cli to manage databases like kubectl for Kubernetes. + +Currently KubeDB includes support for following datastores: + - Postgres + - Elasticsearch + - MySQL + - MongoDB + - Redis + - Memcached