You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dolphinscheduler.apache.org by zh...@apache.org on 2022/08/04 08:39:30 UTC
[dolphinscheduler] branch i-doc-migrate created (now d30d6b94c8)
This is an automated email from the ASF dual-hosted git repository.
zhongjiajie pushed a change to branch i-doc-migrate
in repository https://gitbox.apache.org/repos/asf/dolphinscheduler.git
at d30d6b94c8 [doc] migrate some docs into docs folder
This branch includes the following new commits:
new d30d6b94c8 [doc] migrate some docs into docs folder
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[dolphinscheduler] 01/01: [doc] migrate some docs into docs folder
Posted by zh...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
zhongjiajie pushed a commit to branch i-doc-migrate
in repository https://gitbox.apache.org/repos/asf/dolphinscheduler.git
commit d30d6b94c893d53087744d168e75bf20efc534cf
Author: Jiajie Zhong <zh...@gmail.com>
AuthorDate: Thu Aug 4 16:39:14 2022 +0800
[doc] migrate some docs into docs folder
---
docs/configs/docsdev.js | 134 +++++++++++++++++++++
.../en/{development => contribute}/api-standard.md | 0
.../architecture-design.md | 0
.../backend/mechanism/global-parameter.md | 0
.../backend/mechanism/overview.md | 0
.../backend/mechanism/task/switch.md | 0
.../backend/spi/alert.md | 0
.../backend/spi/datasource.md | 0
.../backend/spi/registry.md | 0
.../backend/spi/task.md | 0
.../development-environment-setup.md | 0
.../en/{development => contribute}/e2e-test.md | 0
.../frontend-development.md | 0
.../{development => contribute}/have-questions.md | 0
14 files changed, 134 insertions(+)
diff --git a/docs/configs/docsdev.js b/docs/configs/docsdev.js
index c84d7924ce..3f71361d5c 100644
--- a/docs/configs/docsdev.js
+++ b/docs/configs/docsdev.js
@@ -434,6 +434,73 @@ export default {
},
],
},
+ {
+ title: 'Contribution',
+ children: [
+ {
+ title: 'Development Environment Setup',
+ link: '/en-us/docs/dev/user_doc/guide/development/development-environment-setup.html',
+ },
+ {
+ title: 'Design Document',
+ children: [
+ // TODO not support multiply level for now
+ // {
+ // title: 'SPI',
+ // children: [
+ {
+ title: 'Architecture Design',
+ link: '/en-us/docs/dev/user_doc/guide/development/architecture-design.html',
+ },
+ {
+ title: 'Alert SPI',
+ link: '/en-us/docs/dev/user_doc/guide/development/backend/spi/alert.html',
+ },
+ {
+ title: 'Registry SPI',
+ link: '/en-us/docs/dev/user_doc/guide/development/backend/spi/registry.html',
+ },
+ {
+ title: 'Task SPI',
+ link: '/en-us/docs/dev/user_doc/guide/development/backend/spi/task.html',
+ },
+ {
+ title: 'Datasource SPI',
+ link: '/en-us/docs/dev/user_doc/guide/development/backend/spi/datasource.html',
+ },
+ {
+ title: 'Mechanism Design',
+ link: '/en-us/docs/dev/user_doc/guide/development/backend/mechanism/overview.html',
+ },
+ ],
+ },
+ {
+ title: 'Guidelines',
+ children: [
+ {
+ title: 'Frontend Development',
+ link: '/en-us/docs/dev/user_doc/guide/development/frontend-development.html',
+ },
+ {
+ title: 'API Standard',
+ link: '/en-us/docs/dev/user_doc/guide/development/api-standard.html',
+ },
+ {
+ title: 'E2E Automation Test',
+ link: '/en-us/docs/dev/user_doc/guide/development/e2e-test.html',
+ },
+ {
+ title: 'API Automation Test',
+ link: '/en-us/docs/dev/user_doc/guide/development/api-test.html',
+ },
+ ],
+ },
+ {
+ title: 'Questions & Communications',
+ link: '/en-us/docs/dev/user_doc/guide/development/have-questions.html',
+ },
+ ],
+ },
{
title: 'FAQ',
children: [
@@ -855,6 +922,73 @@ export default {
},
],
},
+ {
+ title: '贡献指南',
+ children: [
+ {
+ title: '环境搭建',
+ link: '/zh-cn/docs/dev/user_doc/guide/development/development-environment-setup.html',
+ },
+ {
+ title: '设计文档',
+ children: [
+ // TODO not support multiply level for now
+ // {
+ // title: 'SPI',
+ // children: [
+ {
+ title: '架构设计',
+ link: '/zh-cn/docs/dev/user_doc/guide/development/architecture-design.html',
+ },
+ {
+ title: 'Alert SPI',
+ link: '/zh-cn/docs/dev/user_doc/guide/development/backend/spi/alert.html',
+ },
+ {
+ title: 'Registry SPI',
+ link: '/zh-cn/docs/dev/user_doc/guide/development/backend/spi/registry.html',
+ },
+ {
+ title: 'Task SPI',
+ link: '/zh-cn/docs/dev/user_doc/guide/development/backend/spi/task.html',
+ },
+ {
+ title: 'Datasource SPI',
+ link: '/zh-cn/docs/dev/user_doc/guide/development/backend/spi/datasource.html',
+ },
+ {
+ title: '组件设计',
+ link: '/zh-cn/docs/dev/user_doc/guide/development/backend/mechanism/overview.html',
+ },
+ ],
+ },
+ {
+ title: '规范',
+ children: [
+ {
+ title: '前端开发',
+ link: '/zh-cn/docs/dev/user_doc/guide/development/frontend-development.html',
+ },
+ {
+ title: 'API规范',
+ link: '/zh-cn/docs/dev/user_doc/guide/development/api-standard.html',
+ },
+ {
+ title: 'E2E 自动化测试',
+ link: '/zh-cn/docs/dev/user_doc/guide/development/e2e-test.html',
+ },
+ {
+ title: 'API 自动化测试',
+ link: '/zh-cn/docs/dev/user_doc/guide/development/api-test.html',
+ },
+ ],
+ },
+ {
+ title: '问题与交流',
+ link: '/zh-cn/docs/dev/user_doc/guide/development/have-questions.html',
+ },
+ ],
+ },
{
title: 'FAQ',
children: [
diff --git a/docs/docs/en/development/api-standard.md b/docs/docs/en/contribute/api-standard.md
similarity index 100%
rename from docs/docs/en/development/api-standard.md
rename to docs/docs/en/contribute/api-standard.md
diff --git a/docs/docs/en/development/architecture-design.md b/docs/docs/en/contribute/architecture-design.md
similarity index 100%
rename from docs/docs/en/development/architecture-design.md
rename to docs/docs/en/contribute/architecture-design.md
diff --git a/docs/docs/en/development/backend/mechanism/global-parameter.md b/docs/docs/en/contribute/backend/mechanism/global-parameter.md
similarity index 100%
rename from docs/docs/en/development/backend/mechanism/global-parameter.md
rename to docs/docs/en/contribute/backend/mechanism/global-parameter.md
diff --git a/docs/docs/en/development/backend/mechanism/overview.md b/docs/docs/en/contribute/backend/mechanism/overview.md
similarity index 100%
rename from docs/docs/en/development/backend/mechanism/overview.md
rename to docs/docs/en/contribute/backend/mechanism/overview.md
diff --git a/docs/docs/en/development/backend/mechanism/task/switch.md b/docs/docs/en/contribute/backend/mechanism/task/switch.md
similarity index 100%
rename from docs/docs/en/development/backend/mechanism/task/switch.md
rename to docs/docs/en/contribute/backend/mechanism/task/switch.md
diff --git a/docs/docs/en/development/backend/spi/alert.md b/docs/docs/en/contribute/backend/spi/alert.md
similarity index 100%
rename from docs/docs/en/development/backend/spi/alert.md
rename to docs/docs/en/contribute/backend/spi/alert.md
diff --git a/docs/docs/en/development/backend/spi/datasource.md b/docs/docs/en/contribute/backend/spi/datasource.md
similarity index 100%
rename from docs/docs/en/development/backend/spi/datasource.md
rename to docs/docs/en/contribute/backend/spi/datasource.md
diff --git a/docs/docs/en/development/backend/spi/registry.md b/docs/docs/en/contribute/backend/spi/registry.md
similarity index 100%
rename from docs/docs/en/development/backend/spi/registry.md
rename to docs/docs/en/contribute/backend/spi/registry.md
diff --git a/docs/docs/en/development/backend/spi/task.md b/docs/docs/en/contribute/backend/spi/task.md
similarity index 100%
rename from docs/docs/en/development/backend/spi/task.md
rename to docs/docs/en/contribute/backend/spi/task.md
diff --git a/docs/docs/en/development/development-environment-setup.md b/docs/docs/en/contribute/development-environment-setup.md
similarity index 100%
rename from docs/docs/en/development/development-environment-setup.md
rename to docs/docs/en/contribute/development-environment-setup.md
diff --git a/docs/docs/en/development/e2e-test.md b/docs/docs/en/contribute/e2e-test.md
similarity index 100%
rename from docs/docs/en/development/e2e-test.md
rename to docs/docs/en/contribute/e2e-test.md
diff --git a/docs/docs/en/development/frontend-development.md b/docs/docs/en/contribute/frontend-development.md
similarity index 100%
rename from docs/docs/en/development/frontend-development.md
rename to docs/docs/en/contribute/frontend-development.md
diff --git a/docs/docs/en/development/have-questions.md b/docs/docs/en/contribute/have-questions.md
similarity index 100%
rename from docs/docs/en/development/have-questions.md
rename to docs/docs/en/contribute/have-questions.md