You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dolphinscheduler.apache.org by le...@apache.org on 2020/01/17 08:32:32 UTC
[incubator-dolphinscheduler-website] branch master updated: change
structure of documents (#76)
This is an automated email from the ASF dual-hosted git repository.
leonbao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-dolphinscheduler-website.git
The following commit(s) were added to refs/heads/master by this push:
new 22d4bcb change structure of documents (#76)
22d4bcb is described below
commit 22d4bcb79ec10219451743d728c152a64b9cd75c
Author: bao liang <29...@users.noreply.github.com>
AuthorDate: Fri Jan 17 16:32:25 2020 +0800
change structure of documents (#76)
* test
* test
* change structure of documents
* add how to become a committer
* update documents
* update documents
---
docs/en-us/1.2.0/release/upgrade.md | 39 --------------
.../user_doc}/architecture-design.md | 0
.../user_doc}/backend-development.md | 0
.../user_doc}/frontend-development.md | 0
.../user_doc}/plugin-development.md | 0
docs/en-us/{release => 1.2.0/user_doc}/upgrade.md | 0
docs/en-us/development/become a committer.md | 11 ++++
.../{1.2.0/user_doc => development}/subscribe.md | 0
docs/en-us/{user_doc => release}/download.md | 0
docs/en-us/{1.2.0 => release}/faq.md | 0
.../user_doc}/architecture-design.md | 0
.../user_doc}/backend-development.md | 0
.../user_doc}/dolphin-scheduler-setup.md | 0
.../user_doc}/frontend-development.md | 0
.../user_doc}/plugin-development.md | 0
docs/zh-cn/1.2.0/{release => user_doc}/upgrade.md | 0
docs/zh-cn/development/become a committer.md | 13 +++++
.../{1.2.0/user_doc => development}/subscribe.md | 0
docs/zh-cn/{user_doc => release}/download.md | 0
docs/zh-cn/{1.2.0 => release}/faq.md | 0
md_json/docs.json | 6 +--
site_config/development.js | 55 ++++----------------
site_config/docs.js | 60 +++++++++++++++-------
site_config/site.js | 4 +-
24 files changed, 81 insertions(+), 107 deletions(-)
diff --git a/docs/en-us/1.2.0/release/upgrade.md b/docs/en-us/1.2.0/release/upgrade.md
deleted file mode 100755
index 7118acc..0000000
--- a/docs/en-us/1.2.0/release/upgrade.md
+++ /dev/null
@@ -1,39 +0,0 @@
-
-# DolphinScheduler upgrade documentation
-
-## 1. Back up the previous version of the files and database
-
-## 2. Stop all services of dolphinscheduler
-
- `sh ./script/stop-all.sh`
-
-## 3. Download the new version of the installation package
-
-- [download](https://dolphinscheduler.apache.org/en-us/docs/user_doc/download.html), download the latest version of the front and back installation packages (backend referred to as dolphinscheduler-backend, front end referred to as dolphinscheduler-front)
-- The following upgrade operations need to be performed in the new version of the directory
-
-## 4. Database upgrade
-- Modify the following properties in conf/application-dao.properties
-
-```
- spring.datasource.url
- spring.datasource.username
- spring.datasource.password
-```
-
-- Execute database upgrade script
-
-`sh ./script/upgrade-dolphinscheduler.sh`
-
-## 5. Backend service upgrade
-
-- Modify the content of the install.sh configuration and execute the upgrade script
-
- `sh install.sh`
-
-## 6. Frontend service upgrade
-
-- Overwrite the previous version of the dist directory
-- Restart the nginx service
-
- `systemctl restart nginx`
diff --git a/docs/en-us/development/architecture-design.md b/docs/en-us/1.2.0/user_doc/architecture-design.md
similarity index 100%
rename from docs/en-us/development/architecture-design.md
rename to docs/en-us/1.2.0/user_doc/architecture-design.md
diff --git a/docs/en-us/development/backend-development.md b/docs/en-us/1.2.0/user_doc/backend-development.md
similarity index 100%
rename from docs/en-us/development/backend-development.md
rename to docs/en-us/1.2.0/user_doc/backend-development.md
diff --git a/docs/en-us/development/frontend-development.md b/docs/en-us/1.2.0/user_doc/frontend-development.md
similarity index 100%
rename from docs/en-us/development/frontend-development.md
rename to docs/en-us/1.2.0/user_doc/frontend-development.md
diff --git a/docs/en-us/development/plugin-development.md b/docs/en-us/1.2.0/user_doc/plugin-development.md
similarity index 100%
rename from docs/en-us/development/plugin-development.md
rename to docs/en-us/1.2.0/user_doc/plugin-development.md
diff --git a/docs/en-us/release/upgrade.md b/docs/en-us/1.2.0/user_doc/upgrade.md
similarity index 100%
rename from docs/en-us/release/upgrade.md
rename to docs/en-us/1.2.0/user_doc/upgrade.md
diff --git a/docs/en-us/development/become a committer.md b/docs/en-us/development/become a committer.md
new file mode 100644
index 0000000..ab79d68
--- /dev/null
+++ b/docs/en-us/development/become a committer.md
@@ -0,0 +1,11 @@
+# How to become Dolphinscheduler committer
+
+Anyone can be a contributor to an Apache project. Being a contributor simply means that you take an interest in the project and contribute in some way, ranging from asking sensible questions (which documents the project and provides feedback to developers) through to providing new features as patches.
+
+If you become a valuable contributor to the project you may well be invited to become a committer. Committer is a term used at the ASF to signify someone who is committed to a particular project. It brings with it the privilege of write access to the project repository and resources.
+
+In Dolphinscheduler(incubating) community, if a committer who have earned even more merit, can be invited to be a part of the Podling Project Management Committee (PPMC).
+
+One thing that is sometimes hard to understand when you are new to the open development process used at the ASF, is that we value the community more than the code. A strong and healthy community will be respectful and be a fun and rewarding place. More importantly, a diverse and healthy community can continue to support the code over the longer term, even as individual companies come and go from the field.
+
+More details could be found [here](https://community.apache.org/contributors/).
\ No newline at end of file
diff --git a/docs/en-us/1.2.0/user_doc/subscribe.md b/docs/en-us/development/subscribe.md
similarity index 100%
rename from docs/en-us/1.2.0/user_doc/subscribe.md
rename to docs/en-us/development/subscribe.md
diff --git a/docs/en-us/user_doc/download.md b/docs/en-us/release/download.md
similarity index 100%
rename from docs/en-us/user_doc/download.md
rename to docs/en-us/release/download.md
diff --git a/docs/en-us/1.2.0/faq.md b/docs/en-us/release/faq.md
similarity index 100%
rename from docs/en-us/1.2.0/faq.md
rename to docs/en-us/release/faq.md
diff --git a/docs/zh-cn/development/architecture-design.md b/docs/zh-cn/1.2.0/user_doc/architecture-design.md
similarity index 100%
rename from docs/zh-cn/development/architecture-design.md
rename to docs/zh-cn/1.2.0/user_doc/architecture-design.md
diff --git a/docs/zh-cn/development/backend-development.md b/docs/zh-cn/1.2.0/user_doc/backend-development.md
similarity index 100%
rename from docs/zh-cn/development/backend-development.md
rename to docs/zh-cn/1.2.0/user_doc/backend-development.md
diff --git a/docs/zh-cn/developer_guide/dolphin-scheduler-setup.md b/docs/zh-cn/1.2.0/user_doc/dolphin-scheduler-setup.md
similarity index 100%
rename from docs/zh-cn/developer_guide/dolphin-scheduler-setup.md
rename to docs/zh-cn/1.2.0/user_doc/dolphin-scheduler-setup.md
diff --git a/docs/zh-cn/development/frontend-development.md b/docs/zh-cn/1.2.0/user_doc/frontend-development.md
similarity index 100%
rename from docs/zh-cn/development/frontend-development.md
rename to docs/zh-cn/1.2.0/user_doc/frontend-development.md
diff --git a/docs/zh-cn/development/plugin-development.md b/docs/zh-cn/1.2.0/user_doc/plugin-development.md
similarity index 100%
rename from docs/zh-cn/development/plugin-development.md
rename to docs/zh-cn/1.2.0/user_doc/plugin-development.md
diff --git a/docs/zh-cn/1.2.0/release/upgrade.md b/docs/zh-cn/1.2.0/user_doc/upgrade.md
similarity index 100%
rename from docs/zh-cn/1.2.0/release/upgrade.md
rename to docs/zh-cn/1.2.0/user_doc/upgrade.md
diff --git a/docs/zh-cn/development/become a committer.md b/docs/zh-cn/development/become a committer.md
new file mode 100644
index 0000000..3ca6d15
--- /dev/null
+++ b/docs/zh-cn/development/become a committer.md
@@ -0,0 +1,13 @@
+# 如何成为Dolphinscheduler committer
+
+
+每个人都可以成为Apache项目的贡献者。作为一个贡献者只是意味着你对项目感兴趣并以某种方式做出贡献，从提出合理的问题（这些问题记录了项目并向开发人员提供反馈）到提供新的特性作为补丁。
+
+如果你成为对一个项目有价值的贡献者，你有可能被邀请成为一个committer。committer是ASF（Apache软件基金会）中用来表示提交特定项目的人的术语。它给你带来对项目仓库和资源写的权限。
+
+在Dolphinscheduler(incubating)社区，如果一个committer获得大量的优秀成绩，就可以被邀请加入项目管理委员会（PPMC）。
+
+当您不熟悉ASF使用的开源的开发过程时，有时难以理解的一点，就是我们更重视社区而不是代码。一个强大而健康的社区将受到尊重，成为一个有趣和有益的地方。更重要的是，一个多元化和健康的社区
+可以长时间的持续支持代码，即使个别公司在这个领域来来往往，也是如此。
+
+更多详细信息可以在[这里](https://community.apache.org/contributors/)找到
\ No newline at end of file
diff --git a/docs/zh-cn/1.2.0/user_doc/subscribe.md b/docs/zh-cn/development/subscribe.md
similarity index 100%
rename from docs/zh-cn/1.2.0/user_doc/subscribe.md
rename to docs/zh-cn/development/subscribe.md
diff --git a/docs/zh-cn/user_doc/download.md b/docs/zh-cn/release/download.md
similarity index 100%
rename from docs/zh-cn/user_doc/download.md
rename to docs/zh-cn/release/download.md
diff --git a/docs/zh-cn/1.2.0/faq.md b/docs/zh-cn/release/faq.md
similarity index 100%
rename from docs/zh-cn/1.2.0/faq.md
rename to docs/zh-cn/release/faq.md
diff --git a/md_json/docs.json b/md_json/docs.json
index ae529a2..f2ac16a 100755
--- a/md_json/docs.json
+++ b/md_json/docs.json
@@ -42,7 +42,7 @@
},
{
"filename": "faq.md",
- "link": "/en-us/docs/faq.html",
+ "link": "/en-us/docs/release/faq.html",
"meta": {}
},
{
@@ -62,7 +62,7 @@
},
{
"filename": "subscribe.md",
- "link": "/en-us/docs/user_doc/subscribe.html",
+ "link": "/en-us/docs/development/subscribe.html",
"meta": {}
},
{
@@ -139,7 +139,7 @@
},
{
"filename": "subscribe.md",
- "link": "/zh-cn/docs/user_doc/subscribe.html",
+ "link": "/zh-cn/docs/development/subscribe.html",
"meta": {}
},
{
diff --git a/site_config/development.js b/site_config/development.js
index 1e248a6..9201653 100755
--- a/site_config/development.js
+++ b/site_config/development.js
@@ -5,9 +5,12 @@ export default {
title: 'Contribution Guide',
children: [
{
+ title: '如何成为Dolphinscheduler的committer',
+ link: '/en-us/docs/development/become a committer.html',
+ },
+ {
title: 'Subscribe mail list',
- target: '_blank',
- link: '/en-us/docs/1.2.0/user_doc/subscribe.html',
+ link: '/en-us/docs/development/subscribe.html',
},
{
title: 'Participate in contributing',
@@ -16,27 +19,6 @@ export default {
],
},
{
- title: 'Developer guide',
- children: [
- {
- title: 'Architecture Design',
- link: '/en-us/docs/development/architecture-design.html',
- },
- {
- title: 'Backend Development',
- link: '/en-us/docs/development/backend-development.html',
- },
- {
- title: 'Frontend Development',
- link: '/en-us/docs/development/frontend-development.html',
- },
- {
- title: 'plugin-development',
- link: '/en-us/docs/development/plugin-development.html',
- },
- ],
- },
- {
title: 'Submit Guide',
children: [
{
@@ -58,9 +40,13 @@ export default {
title: '贡献指南',
children: [
{
+ title: '如何成为Dolphinscheduler的committer',
+ link: '/zh-cn/docs/development/become a committer.html',
+ },
+ {
title: '订阅邮件列表',
target: '_blank',
- link: '/zh-cn/docs/1.2.0/user_doc/subscribe.html',
+ link: '/zh-cn/docs/development/subscribe.html',
},
{
title: '参与贡献',
@@ -69,27 +55,6 @@ export default {
],
},
{
- title: '开发者指南',
- children: [
- {
- title: '架构设计',
- link: '/zh-cn/docs/development/architecture-design.html',
- },
- {
- title: '后端开发',
- link: '/zh-cn/docs/development/backend-development.html',
- },
- {
- title: '前端开发',
- link: '/zh-cn/docs/development/frontend-development.html',
- },
- {
- title: '插件开发',
- link: '/zh-cn/docs/development/plugin-development.html',
- },
- ],
- },
- {
title: '提交者向导',
children: [
{
diff --git a/site_config/docs.js b/site_config/docs.js
index facd3fb..8964854 100755
--- a/site_config/docs.js
+++ b/site_config/docs.js
@@ -33,34 +33,46 @@ export default {
{
title: 'Api Document',
target: '_blank',
- link: 'http://106.75.43.194:8888/dolphinscheduler/doc.html?language=en&lang=en'
+ link: 'http://106.75.43.194:8888/dolphinscheduler/doc.html?language=en&lang=enn'
}
]
},
{
- title: 'Subscribe',
+ title: 'Upgrade',
children: [
{
- title: 'Subscribe',
- link: '/en-us/docs/1.2.0/user_doc/subscribe.html',
+ title: 'Upgrade',
+ link: '/en-us/docs/1.2.0/user_doc/upgrade.html',
}
]
},
{
- title: 'Upgrade',
+ title: 'Developer guide',
children: [
{
- title: 'Upgrade',
- link: '/en-us/docs/1.2.0/release/upgrade.html',
- }
- ]
+ title: 'Architecture Design',
+ link: '/en-us/docs/1.2.0/user_doc/architecture-design.html',
+ },
+ {
+ title: 'Backend Development',
+ link: '/en-us/docs/1.2.0/user_doc/backend-development.html',
+ },
+ {
+ title: 'Frontend Development',
+ link: '/en-us/docs/1.2.0/user_doc/frontend-development.html',
+ },
+ {
+ title: 'plugin-development',
+ link: '/en-us/docs/1.2.0/user_doc/plugin-development.html',
+ },
+ ],
},
{
title: 'FAQ',
children: [
{
title: 'FAQ',
- link: '/en-us/docs/1.2.0/faq.html',
+ link: '/en-us/docs/release/faq.html',
}
]
}
@@ -106,21 +118,33 @@ export default {
]
},
{
- title: '订阅',
+ title: '版本升级',
children: [
{
- title: '订阅(强烈建议)',
- link: '/zh-cn/docs/1.2.0/user_doc/subscribe.html',
+ title: '升级',
+ link: '/zh-cn/docs/1.2.0/user_doc/upgrade.html',
}
- ]
+ ],
},
{
- title: '版本升级',
+ title: '开发者指南',
children: [
{
- title: '升级',
- link: '/zh-cn/docs/1.2.0/release/upgrade.html',
- }
+ title: '架构设计',
+ link: '/zh-cn/docs/1.2.0/user_doc/architecture-design.html',
+ },
+ {
+ title: '后端开发',
+ link: '/zh-cn/docs/1.2.0/user_doc/backend-development.html',
+ },
+ {
+ title: '前端开发',
+ link: '/zh-cn/docs/1.2.0/user_doc/frontend-development.html',
+ },
+ {
+ title: '插件开发',
+ link: '/zh-cn/docs/1.2.0/user_doc/plugin-development.html',
+ },
],
},
{
diff --git a/site_config/site.js b/site_config/site.js
index cfe245e..90882aa 100755
--- a/site_config/site.js
+++ b/site_config/site.js
@@ -31,7 +31,7 @@ export default {
{
key: 'download',
text: 'DOWNLOAD',
- link: '/en-us/docs/user_doc/download.html',
+ link: '/en-us/docs/release/download.html',
},
{
key: 'blog',
@@ -41,7 +41,7 @@ export default {
{
key: 'development',
text: 'DEVELOPMENT',
- link: '/en-us/docs/development/architecture-design.html',
+ link: '/en-us/docs/development/subscribe.html',
},
{
key: 'community',