Skip to content

Commit

Permalink
docs: Getting Started document structure (#68)
Browse files Browse the repository at this point in the history
Signed-off-by: zhaoxinxin <[email protected]>
  • Loading branch information
Liam-Zhao committed Feb 6, 2024
1 parent ff21ee3 commit b289c1d
Show file tree
Hide file tree
Showing 17 changed files with 32 additions and 230 deletions.
2 changes: 1 addition & 1 deletion docs/concepts/terminology/dfstore.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ objectStorage:
### Step 4: Install dragofly system
Install dragonfly system with object storage, refer to [install dragonfly](../../setup/install/helm-charts.md).
Install dragonfly system with object storage, refer to [install dragonfly](../../getting-started/installation/helm-charts.md).
### Step 5: Install the dfstore command-line tool
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: source
title: Source
id: binaries
title: Binaries
---

There are installation methods to install
Expand Down
File renamed without changes.
1 change: 0 additions & 1 deletion docs/getting-started/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,5 @@ slug: /getting-started/quick-start/

Table of contents:

- [Docker Compose](./quick-start/docker-compose.md)
- [Kubernetes](./quick-start/kubernetes.md)
- [Multi-cluster Kubernetes](./quick-start/multi-cluster-kubernetes.md)
106 changes: 0 additions & 106 deletions docs/getting-started/quick-start/docker-compose.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/getting-started/quick-start/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ slug: /getting-started/quick-start/kubernetes/

Documentation for deploying dragonfly on kubernetes using helm.

You can have a quick start following [Helm Charts](../../setup/install/helm-charts.md).
You can have a quick start following [Helm Charts](../installation/helm-charts.md).
We recommend to use `Containerd with CRI` and `CRI-O` client.

This table describes some container runtimes version and documents.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ and internal peers can only schedule and transmit data in a kubernetes cluster.

## Runtime

You can have a quick start following [Helm Charts](../../setup/install/helm-charts.md).
You can have a quick start following [Helm Charts](../../installation/helm-charts).
We recommend to use `Containerd with CRI` and `CRI-O` client.

This table describes some container runtimes version and documents.
Expand Down
4 changes: 4 additions & 0 deletions i18n/zh/docusaurus-plugin-content-docs/current.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,10 @@
"message": "快速开始",
"description": "The label for category Quick Start in sidebar docs"
},
"sidebar.docs.category.Installation": {
"message": "安装",
"description": "The label for category Quick Start in sidebar docs"
},
"sidebar.docs.category.Containerd": {
"message": "Containerd",
"description": "The label for category Containerd in sidebar docs"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ objectStorage:
### 步骤 4: 安装 Dragonfly 系统
安装 Dragonfly 系统参考文档 [install dragonfly](../../setup/install/helm-charts.md)。[]
安装 Dragonfly 系统参考文档 [install dragonfly](../../getting-started/installation/helm-charts.md)。
### 步骤 5: 安装 dfstore 命令行工具
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: source
title: 源码安装
id: binaries
title: 使用二进制文件安装
---

通过可执行文件分模块进行安装。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,5 @@ slug: /getting-started/quick-start/

部署方式:

- [Docker Compose](quick-start/docker-compose.md)
- [Kubernetes](quick-start/kubernetes.md)
- [Multi-cluster Kubernetes](./quick-start/multi-cluster-kubernetes.md)

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ slug: /getting-started/quick-start/kubernetes/

文档的目标是帮助您快速开始使用 Helm 部署 Dragonfly。

您可以根据 [Helm Charts](../../setup/install/helm-charts.md)
您可以根据 [Helm Charts](../installation/helm-charts.md)
文档中的内容快速搭建 Dragonfly 的 Kubernetes 集群。
我们推荐使用 `Containerd with CRI``CRI-O` 客户端。

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Peers 只能在当前 Dragonfly 集群内 P2P 传输数据,所以一定要保

## Runtime

您可以根据 [Helm Charts](../../setup/install/helm-charts.md)
您可以根据 [Helm Charts](../installation/helm-charts.md)
文档中的内容快速搭建 Dragonfly 的 Kubernetes 集群。
我们推荐使用 `Containerd with CRI``CRI-O` 客户端。

Expand Down
14 changes: 9 additions & 5 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,25 +23,29 @@ module.exports = {
{
type: 'category',
label: 'Quick Start',
link: {
type: 'doc',
id: 'getting-started/quick-start',
},
items: [
{
type: 'autogenerated',
dirName: 'getting-started/quick-start',
},
],
},
{
type: 'category',
label: 'Installation',
items: ['getting-started/installation/helm-charts', 'getting-started/installation/binaries'],
},
],
},
{
type: 'category',
label: 'Setup',
collapsed: false,
items: [
{
type: 'category',
label: 'Install',
items: ['setup/install/helm-charts', 'getting-started/quick-start/docker-compose', 'setup/install/source'],
},
{
type: 'category',
label: 'Runtime',
Expand Down
14 changes: 9 additions & 5 deletions sidebars/docs.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,25 +12,29 @@ module.exports = {
{
type: 'category',
label: 'Quick Start',
link: {
type: 'doc',
id: 'getting-started/quick-start',
},
items: [
{
type: 'autogenerated',
dirName: 'getting-started/quick-start',
},
],
},
{
type: 'category',
label: 'Installation',
items: ['getting-started/installation/helm-charts', 'getting-started/installation/binaries'],
},
],
},
{
type: 'category',
label: 'Setup',
collapsed: false,
items: [
{
type: 'category',
label: 'Install',
items: ['setup/install/helm-charts', 'getting-started/quick-start/docker-compose', 'setup/install/source'],
},
{
type: 'category',
label: 'Runtime',
Expand Down

0 comments on commit b289c1d

Please sign in to comment.