update docs

Signed-off-by: bo.jiang <bo.jiang@daocloud.io>
kubean-io · May 14, 2023 · 9dd0523 · 9dd0523
1 parent cfb102e
commit 9dd0523
Show file tree

Hide file tree

Showing 11 changed files with 34 additions and 16 deletions.
diff --git a/.github/workflows/call-build-docs.yaml b/.github/workflows/call-build-docs.yaml
@@ -24,6 +24,7 @@ jobs:
       - name: Install mkdocs-material
         run: |
           pip install mkdocs-material
+          pip install mkdocs-glightbox
           pip install mkdocs-awesome-pages-plugin
       - name: Build en docs
         run: |

diff --git a/README.md b/README.md
@@ -89,9 +89,4 @@ You can use the example in folder `examples/install/1.minimal` which uses online
 
 ## :book: Documents
 
-- [Architecture](docs/en/architecture.md)
-- [Kubean vs Kubespray](docs/en/comparisons.md)
-- [CRD Outline](docs/en/crds.md)
-- [Deploy cluster using SSH secret key method](docs/en/sshkey_deploy_cluster.md)
-- [Cluster deployment for air gap environments](docs/en/offline.md)
-- [Generate and use incremental offline packages](docs/en/airgap_patch_usage.md)
+Please visit: [kubean-io.github.io/kubean/](https://kubean-io.github.io/kubean/)
diff --git a/README_zh.md b/README_zh.md
@@ -93,10 +93,4 @@ $ kubectl get pods -n kubean-system | grep 'kubean'
 
 ## :book: 参考文档
 
-- [架构](docs/zh/architecture.md)
-- [Kubean 与 Kubespray](docs/zh/comparisons.md)
-- [CRD 概述](docs/zh/crds.md)
-- [使用 SSH Secret 密钥方法部署集群](docs/zh/sshkey_deploy_cluster.md)
-- [为离线环境部署集群](docs/zh/offline.md)
-- [自定义操作](docs/zh/custom_action.md)
-- [增量离线包的生成和使用](docs/zh/airgap_patch_usage.md)
+请浏览: [kubean-io.github.io/kubean/](https://kubean-io.github.io/kubean/)
diff --git a/docs/en/index.md b/docs/en/index.md
@@ -1 +1,14 @@
-hello world
+# :seedling: Kubean
+
+![Image title](/kubean/en/assets/images/kubean_logo_3.svg){ width="400"}
+
+kubean is a cluster lifecycle management tool based on [kubespray](https://github.com/kubernetes-sigs/kubespray).
+
+---
+
+## :anchor: Awesome features
+
+- **Simplicity:** Deploying of Kubean and powerful lifecycle management of kubernetes cluster implementing by declarative API.
+- **Offline Supported**: Offline packages(os-pkgs, images, binarys) are released with the release. You won't have to worry about how to gather all the resources you need.
+- **Compatibility**: Multi-arch delivery Supporting. Such as AMD, ARM with common Linux distributions. Also include Kunpeng with Kylin.
+- **Expandability**: Allowing custom actions be added to cluster without any changes for Kubespray. 
diff --git a/docs/mkdocs.en.yml b/docs/mkdocs.en.yml
@@ -8,6 +8,7 @@ site_dir: './site/en'
 plugins:
 - tags
 - search
+- glightbox
 - awesome-pages
 
 theme:
@@ -61,7 +62,7 @@ nav:
   - usage/uninstall.md
   - usage/airgap.md
   - usage/airgap_patch_usage.md
-- Development Guide:
+- Development:
   - develop/roadmap.md
 
 markdown_extensions:

diff --git a/docs/mkdocs.zh.yml b/docs/mkdocs.zh.yml
@@ -8,6 +8,7 @@ site_dir: './site/zh'
 plugins:
 - tags
 - search
+- glightbox
 - awesome-pages
 
 theme:

diff --git a/docs/test/kubean_testcase.md → docs/overrides/test/kubean_testcase.md b/docs/test/kubean_testcase.md → docs/overrides/test/kubean_testcase.md
diff --git a/...est/testcase_details/cluster_operation.md → ...est/testcase_details/cluster_operation.md b/...est/testcase_details/cluster_operation.md → ...est/testcase_details/cluster_operation.md
diff --git a/docs/test/testcase_details/create_cluster.md → ...s/test/testcase_details/create_cluster.md b/docs/test/testcase_details/create_cluster.md → ...s/test/testcase_details/create_cluster.md
diff --git a/docs/test/testcase_details/kubean_func.md → ...ides/test/testcase_details/kubean_func.md b/docs/test/testcase_details/kubean_func.md → ...ides/test/testcase_details/kubean_func.md
diff --git a/docs/zh/index.md b/docs/zh/index.md
@@ -1 +1,14 @@
-hello world
+# :seedling: Kubean
+
+![Image title](/kubean/zh/assets/images/kubean_logo_3.svg){ width="400"}
+
+Kubean 是一款基于 [kubespray](https://github.com/kubernetes-sigs/kubespray) 的集群生命周期管理工具。
+
+---
+
+## :anchor: 功能超赞
+
+- **简单易用**：通过声明式 API 实现 Kubean 和 K8s 集群强劲生命周期管理的部署。
+- **支持离线**：每个版本都会发布离线包（os-pkgs、镜像、二进制包）。你不必担心如何收集所需的资源。
+- **兼容性**：支持多架构交付：AMD、ARM；常见的 Linux 发行版；以及基于鲲鹏构建的麒麟操作系统。
+- **可扩展性**：允许使用原生 Kubespray 自定义集群。