You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@celeborn.apache.org by zh...@apache.org on 2023/03/31 13:21:02 UTC
[incubator-celeborn-website] 01/01: refine doc
This is an automated email from the ASF dual-hosted git repository.
zhouky pushed a commit to branch 499
in repository https://gitbox.apache.org/repos/asf/incubator-celeborn-website.git
commit 43d338de4806ccc7b2e8b119f7caf4e627d67786
Author: zky.zhoukeyong <zk...@alibaba-inc.com>
AuthorDate: Fri Mar 31 21:16:00 2023 +0800
refine doc
---
.github/workflows/site.yaml | 7 ++++-
docs/configuration/.gitkeep | 0
.../0.2.1}/celeborn_ratis_shell.md | 0
docs/{user_guide => docs/0.2.1}/deploy.md | 0
docs/{user_guide => docs/0.2.1}/monitoring.md | 0
docs/{user_guide => docs/0.2.1}/upgrade.md | 0
.../latest}/celeborn_ratis_shell.md | 0
docs/{user_guide => docs/latest}/deploy.md | 0
docs/{user_guide => docs/latest}/monitoring.md | 0
docs/{user_guide => docs/latest}/upgrade.md | 0
mkdocs.yml | 34 +++++++++++++++++-----
11 files changed, 33 insertions(+), 8 deletions(-)
diff --git a/.github/workflows/site.yaml b/.github/workflows/site.yaml
index 8c3bcbd..2e61a5a 100644
--- a/.github/workflows/site.yaml
+++ b/.github/workflows/site.yaml
@@ -32,7 +32,12 @@ jobs:
- run: |
wget https://github.com/apache/incubator-celeborn/archive/refs/heads/main.zip
unzip main.zip
- cp incubator-celeborn-main/docs/configuration/* docs/configuration/
+ mkdir -p docs/docs/latest/configuration/
+ cp incubator-celeborn-main/docs/configuration/* docs/docs/latest/configuration/
+ wget https://github.com/apache/incubator-celeborn/archive/refs/tags/v0.2.1-incubating.zip
+ unzip v0.2.1-incubating.zip
+ mkdir -p docs/docs/0.2.1/configuration/
+ cp incubator-celeborn-0.2.1-incubating/docs/configuration/* docs/docs/0.2.1/configuration/
- run: pip install -r requirements.txt
- run: mkdocs gh-deploy --force --remote-branch asf-site
- run: |
diff --git a/docs/configuration/.gitkeep b/docs/configuration/.gitkeep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/user_guide/celeborn_ratis_shell.md b/docs/docs/0.2.1/celeborn_ratis_shell.md
similarity index 100%
copy from docs/user_guide/celeborn_ratis_shell.md
copy to docs/docs/0.2.1/celeborn_ratis_shell.md
diff --git a/docs/user_guide/deploy.md b/docs/docs/0.2.1/deploy.md
similarity index 100%
copy from docs/user_guide/deploy.md
copy to docs/docs/0.2.1/deploy.md
diff --git a/docs/user_guide/monitoring.md b/docs/docs/0.2.1/monitoring.md
similarity index 100%
copy from docs/user_guide/monitoring.md
copy to docs/docs/0.2.1/monitoring.md
diff --git a/docs/user_guide/upgrade.md b/docs/docs/0.2.1/upgrade.md
similarity index 100%
copy from docs/user_guide/upgrade.md
copy to docs/docs/0.2.1/upgrade.md
diff --git a/docs/user_guide/celeborn_ratis_shell.md b/docs/docs/latest/celeborn_ratis_shell.md
similarity index 100%
rename from docs/user_guide/celeborn_ratis_shell.md
rename to docs/docs/latest/celeborn_ratis_shell.md
diff --git a/docs/user_guide/deploy.md b/docs/docs/latest/deploy.md
similarity index 100%
rename from docs/user_guide/deploy.md
rename to docs/docs/latest/deploy.md
diff --git a/docs/user_guide/monitoring.md b/docs/docs/latest/monitoring.md
similarity index 100%
rename from docs/user_guide/monitoring.md
rename to docs/docs/latest/monitoring.md
diff --git a/docs/user_guide/upgrade.md b/docs/docs/latest/upgrade.md
similarity index 100%
rename from docs/user_guide/upgrade.md
rename to docs/docs/latest/upgrade.md
diff --git a/mkdocs.yml b/mkdocs.yml
index f067e64..d13e0d2 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -76,13 +76,33 @@ copyright: >
nav:
- Home: index.md
- Download: download.md
- - User Guide:
- - Deploy: user_guide/deploy.md
- - Upgrade: user_guide/upgrade.md
- - Ratis Shell: user_guide/celeborn_ratis_shell.md
- - Monitoring: user_guide/monitoring.md
- - Configuration:
- - configuration/index.md
+ - Documentation:
+ - Latest:
+ - Deploy: docs/latest/deploy.md
+ - Configuration:
+ - client: docs/latest/configuration/client.md
+ - master: docs/latest/configuration/master.md
+ - worker: docs/latest/configuration/worker.md
+ - metrics: docs/latest/configuration/metrics.md
+ - network: docs/latest/configuration/network.md
+ - quota: docs/latest/configuration/quota.md
+ - columnar-shuffle: docs/latest/configuration/columnar-shuffle.md
+ - Monitoring: docs/latest/monitoring.md
+ - Upgrade: docs/latest/upgrade.md
+ - Ratis Shell: docs/latest/celeborn_ratis_shell.md
+ - 0.2.1:
+ - Deploy: docs/0.2.1/deploy.md
+ - Configuration:
+ - client: docs/0.2.1/configuration/client.md
+ - master: docs/0.2.1/configuration/master.md
+ - worker: docs/0.2.1/configuration/worker.md
+ - metrics: docs/0.2.1/configuration/metrics.md
+ - network: docs/0.2.1/configuration/network.md
+ - quota: docs/0.2.1/configuration/quota.md
+ - columnar-shuffle: docs/0.2.1/configuration/columnar-shuffle.md
+ - Upgrade: docs/0.2.1/upgrade.md
+ - Ratis Shell: docs/0.2.1/celeborn_ratis_shell.md
+ - Monitoring: docs/0.2.1/monitoring.md
- Community:
- Join the Mailing Lists: community/maillist.md
- Project Management Committee: community/project_management_committee.md