Skip to content

Commit

Permalink
Fix docs (#150)
Browse files Browse the repository at this point in the history
  • Loading branch information
tamalsaha authored Jan 7, 2018
1 parent 75a1a02 commit e62cb48
Show file tree
Hide file tree
Showing 11 changed files with 83 additions and 47 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).

---

Expand Down
20 changes: 1 addition & 19 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
11 changes: 11 additions & 0 deletions docs/concepts/databases/_index.md
Original file line number Diff line number Diff line change
@@ -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
---
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
6 changes: 3 additions & 3 deletions docs/concepts/mysql.md → docs/concepts/databases/mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
---
Expand Down
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
6 changes: 3 additions & 3 deletions docs/concepts/redis.md → docs/concepts/databases/redis.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
---
Expand Down
11 changes: 11 additions & 0 deletions docs/concepts/what-is-kubedb/_index.md
Original file line number Diff line number Diff line change
@@ -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
---
32 changes: 32 additions & 0 deletions docs/concepts/what-is-kubedb/overview.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit e62cb48

Please sign in to comment.