This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository
https://gitbox.apache.org/repos/asf/incubator-dolphinscheduler-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 2b1b56f Automated deployment: Sun Jul 19 22:44:23 UTC 2020
a36f0d92a1d6db643e879691c6b5f5452cc274c2
2b1b56f is described below
commit 2b1b56fc0c61bc6ef195bcd8bfd73bed34161896
Author: dailidong <[email protected]>
AuthorDate: Sun Jul 19 22:44:23 2020 +0000
Automated deployment: Sun Jul 19 22:44:23 UTC 2020
a36f0d92a1d6db643e879691c6b5f5452cc274c2
---
build/documentation.js | 2 +-
en-us/docs/development/become a committer.html | 2 +-
en-us/docs/development/become a committer.json | 2 +-
.../{become a committer.html => document.html} | 13 +--
en-us/docs/development/document.json | 6 ++
zh-cn/docs/development/become a committer.html | 2 +-
zh-cn/docs/development/become a committer.json | 2 +-
zh-cn/docs/development/contribute.html | 101 +++------------------
zh-cn/docs/development/contribute.json | 2 +-
.../{become a committer.html => document.html} | 85 +++++++++++++++--
zh-cn/docs/development/document.json | 6 ++
zh-cn/docs/development/issue.html | 75 +++++++++++++++
zh-cn/docs/development/issue.json | 2 +-
zh-cn/docs/development/pull-request.html | 2 +
zh-cn/docs/development/pull-request.json | 2 +-
15 files changed, 191 insertions(+), 113 deletions(-)
diff --git a/build/documentation.js b/build/documentation.js
index 1e20fa6..259c103 100644
--- a/build/documentation.js
+++ b/build/documentation.js
@@ -170,4 +170,4 @@ Object.defineProperty(t,"__esModule",{value:!0});var
i="function"==typeof Symbol
* Copyright © 2012-2019 Faisal Salman <[email protected]>
* Licensed under MIT License
*/
-return"string"==typeof e?e.replace(/[^\d\.]/g,"").split(".")[0]:void
0},trim:function(e){return
e.replace(/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,"")}},m={rgx:function(e,t){for(var
n,r,o,i,a,c,s=0;s<t.length&&!a;){var
l=t[s],u=t[s+1];for(n=r=0;n<l.length&&!a;)if(a=l[n++].exec(e))for(o=0;o<u.length;o++)c=a[++r],i=u[o],"object"==typeof
i&&i.length>0?2==i.length?"function"==typeof
i[1]?this[i[0]]=i[1].call(this,c):this[i[0]]=i[1]:3==i.length?"function"!=typeof
i[1]||i[1].exec&&i[1].test?this[i [...]
\ No newline at end of file
+return"string"==typeof e?e.replace(/[^\d\.]/g,"").split(".")[0]:void
0},trim:function(e){return
e.replace(/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,"")}},m={rgx:function(e,t){for(var
n,r,o,i,a,c,s=0;s<t.length&&!a;){var
l=t[s],u=t[s+1];for(n=r=0;n<l.length&&!a;)if(a=l[n++].exec(e))for(o=0;o<u.length;o++)c=a[++r],i=u[o],"object"==typeof
i&&i.length>0?2==i.length?"function"==typeof
i[1]?this[i[0]]=i[1].call(this,c):this[i[0]]=i[1]:3==i.length?"function"!=typeof
i[1]||i[1].exec&&i[1].test?this[i [...]
\ No newline at end of file
diff --git a/en-us/docs/development/become a committer.html
b/en-us/docs/development/become a committer.html
index f93e7ac..aad4552 100644
--- a/en-us/docs/development/become a committer.html
+++ b/en-us/docs/development/become a committer.html
@@ -12,7 +12,7 @@
<link rel="stylesheet" href="/build/documentation.css" />
</head>
<body>
- <div id="root"><div class="documentation-page"
data-reactroot=""><header class="header-container header-container-normal"><div
class="header-body"><a href="/en-us/index.html"><img class="logo"
src="/img/hlogo_colorful.svg"/></a><div class="search search-normal"><span
class="icon-search"></span></div><span class="language-switch
language-switch-normal">中</span><div class="header-menu"><img
class="header-menu-toggle" src="/img/system/menu_gray.png"/><div><ul
class="ant-menu blackClass ant [...]
+ <div id="root"><div class="documentation-page"
data-reactroot=""><header class="header-container header-container-normal"><div
class="header-body"><a href="/en-us/index.html"><img class="logo"
src="/img/hlogo_colorful.svg"/></a><div class="search search-normal"><span
class="icon-search"></span></div><span class="language-switch
language-switch-normal">中</span><div class="header-menu"><img
class="header-menu-toggle" src="/img/system/menu_gray.png"/><div><ul
class="ant-menu blackClass ant [...]
<p>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.</p>
<p>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.</p>
<p>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).</p>
diff --git a/en-us/docs/development/become a committer.json
b/en-us/docs/development/become a committer.json
index 1b52798..1b58f5e 100644
--- a/en-us/docs/development/become a committer.json
+++ b/en-us/docs/development/become a committer.json
@@ -1,6 +1,6 @@
{
"filename": "become a committer.md",
- "__html": "<h1>How to become Dolphinscheduler committer</h1>\n<p>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.</p>\n<p>If you become
a valuable contributor to the project you may well be invited to become a
committer. Committer is a [...]
+ "__html": "<h1>How to become DolphinScheduler committer</h1>\n<p>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.</p>\n<p>If you become
a valuable contributor to the project you may well be invited to become a
committer. Committer is a [...]
"link": "/en-us/docs/development/become a committer.html",
"meta": {}
}
\ No newline at end of file
diff --git a/en-us/docs/development/become a committer.html
b/en-us/docs/development/document.html
similarity index 84%
copy from en-us/docs/development/become a committer.html
copy to en-us/docs/development/document.html
index f93e7ac..2160db5 100644
--- a/en-us/docs/development/become a committer.html
+++ b/en-us/docs/development/document.html
@@ -4,20 +4,15 @@
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0,
maximum-scale=1.0, user-scalable=no">
- <meta name="keywords" content="become a committer" />
- <meta name="description" content="become a committer" />
+ <meta name="keywords" content="document" />
+ <meta name="description" content="document" />
<!-- 网页标签标题 -->
- <title>become a committer</title>
+ <title>document</title>
<link rel="shortcut icon" href="/img/docsite.ico"/>
<link rel="stylesheet" href="/build/documentation.css" />
</head>
<body>
- <div id="root"><div class="documentation-page"
data-reactroot=""><header class="header-container header-container-normal"><div
class="header-body"><a href="/en-us/index.html"><img class="logo"
src="/img/hlogo_colorful.svg"/></a><div class="search search-normal"><span
class="icon-search"></span></div><span class="language-switch
language-switch-normal">中</span><div class="header-menu"><img
class="header-menu-toggle" src="/img/system/menu_gray.png"/><div><ul
class="ant-menu blackClass ant [...]
-<p>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.</p>
-<p>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.</p>
-<p>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).</p>
-<p>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.</p>
-<p>More details could be found <a
href="https://community.apache.org/contributors/">here</a>.</p>
+ <div id="root"><div class="documentation-page"
data-reactroot=""><header class="header-container header-container-normal"><div
class="header-body"><a href="/en-us/index.html"><img class="logo"
src="/img/hlogo_colorful.svg"/></a><div class="search search-normal"><span
class="icon-search"></span></div><span class="language-switch
language-switch-normal">中</span><div class="header-menu"><img
class="header-menu-toggle" src="/img/system/menu_gray.png"/><div><ul
class="ant-menu blackClass ant [...]
</div></section><footer class="footer-container"><div class="footer-body"><img
src="/img/ds_gray.svg"/><div class="cols-container"><div class="col
col-12"><h3>Disclaimer</h3><p>Apache DolphinScheduler (incubating) is an effort
undergoing incubation at The Apache Software Foundation (ASF), sponsored by
Incubator.
Incubation is required of all newly accepted projects until a further review
indicates
that the infrastructure, communications, and decision making process have
stabilized in a manner consistent with other successful ASF projects.
diff --git a/en-us/docs/development/document.json
b/en-us/docs/development/document.json
new file mode 100644
index 0000000..5c9874a
--- /dev/null
+++ b/en-us/docs/development/document.json
@@ -0,0 +1,6 @@
+{
+ "filename": "document.md",
+ "__html": "<h2>TODO</h2>\n",
+ "link": "/en-us/docs/development/document.html",
+ "meta": {}
+}
\ No newline at end of file
diff --git a/zh-cn/docs/development/become a committer.html
b/zh-cn/docs/development/become a committer.html
index aa71bfa..4f1d448 100644
--- a/zh-cn/docs/development/become a committer.html
+++ b/zh-cn/docs/development/become a committer.html
@@ -12,7 +12,7 @@
<link rel="stylesheet" href="/build/documentation.css" />
</head>
<body>
- <div id="root"><div class="documentation-page"
data-reactroot=""><header class="header-container header-container-normal"><div
class="header-body"><a href="/zh-cn/index.html"><img class="logo"
src="/img/hlogo_colorful.svg"/></a><div class="search search-normal"><span
class="icon-search"></span></div><span class="language-switch
language-switch-normal">En</span><div class="header-menu"><img
class="header-menu-toggle" src="/img/system/menu_gray.png"/><div><ul
class="ant-menu blackClass an [...]
+ <div id="root"><div class="documentation-page"
data-reactroot=""><header class="header-container header-container-normal"><div
class="header-body"><a href="/zh-cn/index.html"><img class="logo"
src="/img/hlogo_colorful.svg"/></a><div class="search search-normal"><span
class="icon-search"></span></div><span class="language-switch
language-switch-normal">En</span><div class="header-menu"><img
class="header-menu-toggle" src="/img/system/menu_gray.png"/><div><ul
class="ant-menu blackClass an [...]
<p>每个人都可以成为Apache项目的贡献者。作为一个贡献者只是意味着你对项目感兴趣并以某种方式做出贡献,从提出合理的问题(这些问题记录了项目并向开发人员提供反馈)到提供新的特性作为补丁。</p>
<p>如果你成为对一个项目有价值的贡献者,你有可能被邀请成为一个committer。committer是ASF(Apache软件基金会)中用来表示提交特定项目的人的术语。它给你带来对项目仓库和资源写的权限。</p>
<p>在Dolphinscheduler(incubating)社区,如果一个committer获得大量的优秀成绩,就可以被邀请加入项目管理委员会(PPMC)。</p>
diff --git a/zh-cn/docs/development/become a committer.json
b/zh-cn/docs/development/become a committer.json
index ce64eee..ab9d9dc 100644
--- a/zh-cn/docs/development/become a committer.json
+++ b/zh-cn/docs/development/become a committer.json
@@ -1,6 +1,6 @@
{
"filename": "become a committer.md",
- "__html": "<h1>如何成为Dolphinscheduler
committer</h1>\n<p>每个人都可以成为Apache项目的贡献者。作为一个贡献者只是意味着你对项目感兴趣并以某种方式做出贡献,从提出合理的问题(这些问题记录了项目并向开发人员提供反馈)到提供新的特性作为补丁。</p>\n<p>如果你成为对一个项目有价值的贡献者,你有可能被邀请成为一个committer。committer是ASF(Apache软件基金会)中用来表示提交特定项目的人的术语。它给你带来对项目仓库和资源写的权限。</p>\n<p>在Dolphinscheduler(incubating)社区,如果一个committer获得大量的优秀成绩,就可以被邀请加入项目管理委员会(PPMC)。</p>\n<p>当您不熟悉ASF使用的开源的开发过程时,有时难以理解的一点,就是我们更重视社区而不是代码。一个强大而健康的社区将受到尊重,成为一个有趣和有益的地方。更重要的是,一个多元
化和健康的社区\n可以长时间的持续支持代码,即使个别公司在这个领域来来往往,也是如此。</p>\n<p>更多详 [...]
+ "__html": "<h1>如何成为 DolphinScheduler
committer</h1>\n<p>每个人都可以成为Apache项目的贡献者。作为一个贡献者只是意味着你对项目感兴趣并以某种方式做出贡献,从提出合理的问题(这些问题记录了项目并向开发人员提供反馈)到提供新的特性作为补丁。</p>\n<p>如果你成为对一个项目有价值的贡献者,你有可能被邀请成为一个committer。committer是ASF(Apache软件基金会)中用来表示提交特定项目的人的术语。它给你带来对项目仓库和资源写的权限。</p>\n<p>在Dolphinscheduler(incubating)社区,如果一个committer获得大量的优秀成绩,就可以被邀请加入项目管理委员会(PPMC)。</p>\n<p>当您不熟悉ASF使用的开源的开发过程时,有时难以理解的一点,就是我们更重视社区而不是代码。一个强大而健康的社区将受到尊重,成为一个有趣和有益的地方。更重要的是,一个多�
�化和健康的社区\n可以长时间的持续支持代码,即使个别公司在这个领域来来往往,也是如此。</p>\n<p>更多 [...]
"link": "/zh-cn/docs/development/become a committer.html",
"meta": {}
}
\ No newline at end of file
diff --git a/zh-cn/docs/development/contribute.html
b/zh-cn/docs/development/contribute.html
index b61d53b..3c95eb8 100644
--- a/zh-cn/docs/development/contribute.html
+++ b/zh-cn/docs/development/contribute.html
@@ -23,99 +23,28 @@
<li>为代码添加注释</li>
<li>提交修复 Bug 或者 Feature 的 PR</li>
<li>发表应用案例实践、调度流程分析或者与调度相关的技术文章</li>
-<li>帮助推广 DolphinScheduler,参与技术大会或者meetup的分享等</li>
+<li>帮助推广 DolphinScheduler,参与技术大会或者 meetup 的分享等</li>
</ul>
<p>欢迎加入贡献的队伍,加入开源从提交第一个 PR 开始</p>
<ul>
-<li>比如添加代码注释或找到带有 ”easy to fix” 标记或一些非常简单的 issue(拼写错误等) 等等,先通过第一个简单的PR熟悉提交流程
-注:贡献不仅仅限于 PR 哈,对促进项目发展的都是贡献</li>
+<li>比如添加代码注释或找到带有 ”easy to fix” 标记或一些非常简单的 issue(拼写错误等) 等等,先通过第一个简单的 PR
熟悉提交流程</li>
</ul>
+<p>注:贡献不仅仅限于 PR 哈,对促进项目发展的都是贡献</p>
<p>相信参与 DolphinScheduler,一定会让您从开源中受益!</p>
-<h3>1. 如何提交Bug</h3>
-<p>当您发现一个Bug时,请提交Bug,提交前:</p>
+<h3>1. 参与文档贡献</h3>
+<p>参考<a href="document.md">参与贡献-文档需知</a></p>
+<h3>2. 参与代码贡献</h3>
+<p>参考<a href="issue.md">参与贡献 Issue 需知</a>,<a href="pull-request.md">参与贡献 Pull
Request 需知</a>,<a href="commit_message.md">参与贡献 CommitMessage 需知</a></p>
+<h3>3. 如何领取 Issue,提交 Pull Request</h3>
+<p>如果你想实现某个 Feature 或者修复某个 Bug。请参考以下内容:</p>
<ul>
-<li>请先在issue列表里查找一下是否该bug已经提交,如果已经有此bug,请在此bug下接着回复。</li>
-<li>如果该Bug是可以复现的。请尽量提供完整的重现步骤。</li>
+<li>所有的 Bug 与新 Feature 建议使用 Issues Page 进行管理。</li>
+<li>如果想要开发实现某个 Feature 功能,请先回复该功能所关联的 Issue,表明你当前正在这个 Issue 上工作。
并在回复的时候为自己设置一个 <strong>deadline</strong>,并添加的回复内容中。</li>
+<li>最好在核心贡献者找到一个导师(指导者),导师会在设计与功能实现上给予即时的反馈。</li>
+<li>你应该新建一个分支来开始你的工作,分支的名字参考<a href="pull-request.md">参与贡献 Pull Request
需知</a>。比如,你想完成 feature 功能并提交了 Issue 111,那么你的 branch 名字应为 feature-111。
功能名称可与导师讨论后确定。</li>
+<li>完成后,发送一个 Pull Request 到 incubator-dolphinscheduler,提交过程具体请参考下面《<a
href="submit-code.md">提交代码流程</a>》。</li>
</ul>
-<p>请在issues页面中提交Bug。</p>
-<p>一个高质量的Bug通常有以下特征:</p>
-<ul>
-<li>使用一个清晰并有描述性的标题来定义Bug。</li>
-<li>详细的描述复现Bug的步骤。包括您的配置情况,预计产生的结果,实际产生的结果。并附加详细的TRACE日志。</li>
-<li>如果程序抛出异常,请附加完整的堆栈日志。</li>
-<li>如有可能,请附上屏幕截图或动态的GIF图,这些图片能帮助演示整个问题的产生过程。</li>
-<li>哪个版本。</li>
-<li>需要修复的优先级(危急、重大、次要、细微)。</li>
-</ul>
-<p>下面是Bug的Markdown模板,请按照该模板填写issue。</p>
-<pre><code class="language-shell">**标题**
-标题格式: [BUG][Priority] bug标题
-Priority分为四级: Critical、Major、Minor、Trivial
-
-**问题描述**
-[清晰准确描述遇到的问题]
-
-**问题复现步骤:**
-1. [第一步]
-2. [第二步]
-3. [...]
-
-**期望的表现:**
-[在这里描述期望的表现]
-
-**观察到的表现:**
-[在这里描述观察到的表现]
-
-**屏幕截图和动态GIF图**
-
-
-**DolphinScheduler版本:(以1.1.0为例)**
- -[1.1.0]
-
-**补充的内容:**
-[请描述补充的内容,比如]
-
-**需求或者建议**
-[请描述你的需求或者建议]
-</code></pre>
-<h3>2. 如何提交功能(Feature)建议</h3>
-<p>提交前:</p>
-<ul>
-<li>请确定这不是一个重复的功能增强建议。 查看Issue Page列表,搜索您要提交的功能增强建议是否已经被提交过。</li>
-</ul>
-<p>请在issues页面中提交Feature。</p>
-<p>一个高质量的Feature通常有以下特征:</p>
-<ul>
-<li>一个清晰的标题来定义Feature</li>
-<li>详细描述Feature的行为模式</li>
-<li>说明为什么该Feature对大多数用户是有用的。新功能应该具有广泛的适用性。</li>
-<li>尽量列出其他调度已经具备的类似功能。商用与开源软件均可。</li>
-</ul>
-<p>以下是Feature的Markdown模板,请按照该模板填写issue。</p>
-<pre><code class="language-shell">**标题**
-标题格式: [Feature][Priority] feature标题
-Priority分为四级: Critical、Major、Minor、Trivial
-
-**Feature的描述**
-[描述新Feature应实现的功能]
-
-**为什么这个新功能是对大多数用户有用的**
-[解释这个功能为什么对大多数用户是有用的]
-
-**补充的内容**
-[列出其他的调度是否包含该功能,是如何实现的]
-
-</code></pre>
-<h3>3. 如何领取Bug/Feature</h3>
-<p>如果您想实现某个Feature或者修复某个Bug。请参考以下内容:</p>
-<ul>
-<li>所有的Bug与新Feature建议使用Issues Page进行管理。</li>
-<li>如果想要开发实现某个Feature功能,请先回复该功能所关联的Issue,表明您当前正在这个Issue上工作。
并在回复的时候为自己设置一个deadline,并添加的回复内容中。</li>
-<li>最好在核心贡献者找到一个导师(指导者),导师会在设计与功能实现上给予即时的反馈。</li>
-<li>您应该新建一个分支来开始您的工作,分支的名字为Feature功能名称/issueId。 比如,您想完成依赖功能并提交了Issue
111,那么您的branch名字应为 dependency/111。 功能名称可与导师讨论后确定。</li>
-<li>完成后,发送一个pull request到incubator-dolphinscheduler,提交过程具体请参考下面《<a
href="submit-code.md">提交代码流程</a>》。</li>
-</ul>
-<p>如果是想提交Pull
Request完成某一个Feature或者修复某个Bug,这里都建议大家从小处做起,完成一个小功能就提交一次,每次别改动太多文件(最好6个以下),改动文件太多也会给Reviewer造成很大的心里压力,建议通过多次pr的方式完成。</p>
+<p>如果是想提交 Pull Request 完成某一个 Feature 或者修复某个
Bug,这里都建议大家从小处做起,完成一个小功能就提交一次,每次别改动太多文件,改动文件太多也会给 Reviewer 造成很大的心里压力,建议通过多次
Pull Request 的方式完成。</p>
</div></section><footer class="footer-container"><div class="footer-body"><img
src="/img/ds_gray.svg"/><div class="cols-container"><div class="col
col-12"><h3>Disclaimer</h3><p>Apache DolphinScheduler (incubating) is an effort
undergoing incubation at The Apache Software Foundation (ASF), sponsored by
Incubator.
Incubation is required of all newly accepted projects until a further review
indicates
that the infrastructure, communications, and decision making process have
stabilized in a manner consistent with other successful ASF projects.
diff --git a/zh-cn/docs/development/contribute.json
b/zh-cn/docs/development/contribute.json
index 7c6d953..ca0cfe4 100644
--- a/zh-cn/docs/development/contribute.json
+++ b/zh-cn/docs/development/contribute.json
@@ -1,6 +1,6 @@
{
"filename": "contribute.md",
- "__html": "<h2>贡献</h2>\n<p>首先非常感谢大家选择和使用 DolphinScheduler,非常欢迎大家加入
DolphinScheduler 大家庭,融入开源世界!</p>\n<p>我们鼓励任何形式的参与社区,最终成为 Committer 或
PPMC,如:</p>\n<ul>\n<li>将遇到的问题通过 github 上 <a
href=\"https://github.com/apache/incubator-dolphinscheduler/issues\">issue</a>
的形式反馈出来</li>\n<li>回答别人遇到的 issue
问题</li>\n<li>帮助完善文档</li>\n<li>帮助项目增加测试用例</li>\n<li>为代码添加注释</li>\n<li>提交修复 Bug
或者 Feature 的 PR</li>\n<li>发表应用案例实践、调度流程分析或者与调度相关的技术文章</li>\n<li>帮助推广
DolphinScheduler,参与技术大会或者meetup的分享等</li>\n</ul>\n<p>欢 [...]
+ "__html": "<h2>贡献</h2>\n<p>首先非常感谢大家选择和使用 DolphinScheduler,非常欢迎大家加入
DolphinScheduler 大家庭,融入开源世界!</p>\n<p>我们鼓励任何形式的参与社区,最终成为 Committer 或
PPMC,如:</p>\n<ul>\n<li>将遇到的问题通过 github 上 <a
href=\"https://github.com/apache/incubator-dolphinscheduler/issues\">issue</a>
的形式反馈出来</li>\n<li>回答别人遇到的 issue
问题</li>\n<li>帮助完善文档</li>\n<li>帮助项目增加测试用例</li>\n<li>为代码添加注释</li>\n<li>提交修复 Bug
或者 Feature 的 PR</li>\n<li>发表应用案例实践、调度流程分析或者与调度相关的技术文章</li>\n<li>帮助推广
DolphinScheduler,参与技术大会或者 meetup 的分享等</li>\n</ul>\n<p [...]
"link": "/zh-cn/docs/development/contribute.html",
"meta": {}
}
\ No newline at end of file
diff --git a/zh-cn/docs/development/become a committer.html
b/zh-cn/docs/development/document.html
similarity index 73%
copy from zh-cn/docs/development/become a committer.html
copy to zh-cn/docs/development/document.html
index aa71bfa..4016aa6 100644
--- a/zh-cn/docs/development/become a committer.html
+++ b/zh-cn/docs/development/document.html
@@ -4,21 +4,86 @@
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0,
maximum-scale=1.0, user-scalable=no">
- <meta name="keywords" content="become a committer" />
- <meta name="description" content="become a committer" />
+ <meta name="keywords" content="document" />
+ <meta name="description" content="document" />
<!-- 网页标签标题 -->
- <title>become a committer</title>
+ <title>document</title>
<link rel="shortcut icon" href="/img/docsite.ico"/>
<link rel="stylesheet" href="/build/documentation.css" />
</head>
<body>
- <div id="root"><div class="documentation-page"
data-reactroot=""><header class="header-container header-container-normal"><div
class="header-body"><a href="/zh-cn/index.html"><img class="logo"
src="/img/hlogo_colorful.svg"/></a><div class="search search-normal"><span
class="icon-search"></span></div><span class="language-switch
language-switch-normal">En</span><div class="header-menu"><img
class="header-menu-toggle" src="/img/system/menu_gray.png"/><div><ul
class="ant-menu blackClass an [...]
-<p>每个人都可以成为Apache项目的贡献者。作为一个贡献者只是意味着你对项目感兴趣并以某种方式做出贡献,从提出合理的问题(这些问题记录了项目并向开发人员提供反馈)到提供新的特性作为补丁。</p>
-<p>如果你成为对一个项目有价值的贡献者,你有可能被邀请成为一个committer。committer是ASF(Apache软件基金会)中用来表示提交特定项目的人的术语。它给你带来对项目仓库和资源写的权限。</p>
-<p>在Dolphinscheduler(incubating)社区,如果一个committer获得大量的优秀成绩,就可以被邀请加入项目管理委员会(PPMC)。</p>
-<p>当您不熟悉ASF使用的开源的开发过程时,有时难以理解的一点,就是我们更重视社区而不是代码。一个强大而健康的社区将受到尊重,成为一个有趣和有益的地方。更重要的是,一个多元化和健康的社区
-可以长时间的持续支持代码,即使个别公司在这个领域来来往往,也是如此。</p>
-<p>更多详细信息可以在<a href="https://community.apache.org/contributors/">这里</a>找到</p>
+ <div id="root"><div class="documentation-page"
data-reactroot=""><header class="header-container header-container-normal"><div
class="header-body"><a href="/zh-cn/index.html"><img class="logo"
src="/img/hlogo_colorful.svg"/></a><div class="search search-normal"><span
class="icon-search"></span></div><span class="language-switch
language-switch-normal">En</span><div class="header-menu"><img
class="header-menu-toggle" src="/img/system/menu_gray.png"/><div><ul
class="ant-menu blackClass an [...]
+<p>良好的使用文档对任何类型的软件都是至关重要的。欢迎任何可以改进 DolphinScheduler 文档的贡献。</p>
+<h3>获取文档项目</h3>
+<p>DolphinScheduler 项目的文档维护在独立的 <a
href="https://github.com/apache/incubator-dolphinscheduler-website">git
仓库</a>中。</p>
+<p>首先你需要先将文档项目 fork 到自己的 github 仓库中,然后将 fork 的文档克隆到本地计算机中。</p>
+<pre><code>git clone
https://github.com/<your-github-user-name>/incubator-dolphinscheduler-website
+</code></pre>
+<h3>文档环境</h3>
+<p>DolphinScheduler 网站由 <a
href="https://github.com/txd-team/docsite">docsite</a> 提供支持。</p>
+<p>如果你的 docsite 版本低于 “1.3.3”,请升级到 “1.3.3”。</p>
+<p>请确保你的 node 版本是 8.x,docsite 尚不支持高于 8.x 的版本。</p>
+<h3>文档构建指南</h3>
+<ol>
+<li>
+<p>运行 “npm install docsite-g” 安装开发工具。</p>
+</li>
+<li>
+<p>在根目录中运行 “npm i” 以安装依赖项。</p>
+</li>
+<li>
+<p>在根目录下运行 “docsite start” 启动本地服务器,其将允许在 <a
href="http://127.0.0.1:8080">http://127.0.0.1:8080</a>。</p>
+</li>
+<li>
+<p>运行 “docsite build” 可以生成文档网站源代码。</p>
+</li>
+<li>
+<p>在本地验证你的更改:<code>python -m SimpleHTTPServer 8000</code>,当 python 版本为 3
时,请使用:<code>python3 -m http.server 8000</code>。</p>
+</li>
+</ol>
+<p>如果本地安装了更高版本的 node,可以考虑使用 “nvm” 来允许不同版本的 node 在你的计算机上运行。</p>
+<ol>
+<li>
+<p>参考<a href="http://nvm.sh">说明</a>安装 nvm</p>
+</li>
+<li>
+<p>运行 “nvm install v8.16.0” 安装 node v8</p>
+</li>
+<li>
+<p>运行 “nvm use v8.16.0” 将当前工作环境切换到 node v8</p>
+</li>
+<li>
+<p>运行<code>npm install docsite-g</code></p>
+</li>
+</ol>
+<p>然后你就可以在本地环境运行和建立网站了。</p>
+<h3>文档规范</h3>
+<ol>
+<li>
+<p>汉字与英文、数字之间<strong>需空格</strong>,中文标点符号与英文、数字之间<strong>不需空格</strong>,以增强中英文混排的美观性和可读性。</p>
+</li>
+<li>
+<p>建议在一般情况下使用 “你” 即可。当然必要的时候可以使用 “您” 来称呼,比如有 warning 提示的时候。</p>
+</li>
+</ol>
+<h3>怎样提交文档 Pull Request</h3>
+<ol>
+<li>
+<p>不要使用 “git add.” 提交所有更改。</p>
+</li>
+<li>
+<p>只需推送更改的文件,例如:</p>
+</li>
+</ol>
+<ul>
+<li><code>*.md</code></li>
+<li><code>blog.js or docs.js or site.js</code></li>
+</ul>
+<ol start="3">
+<li>向 <strong>master</strong> 分支提交 Pull Request。</li>
+</ol>
+<h3>参考文档</h3>
+<p><a
href="https://cwiki.apache.org/confluence/display/FLINK/Flink+Translation+Specifications">Apache
Flink 中文文档规范</a></p>
</div></section><footer class="footer-container"><div class="footer-body"><img
src="/img/ds_gray.svg"/><div class="cols-container"><div class="col
col-12"><h3>Disclaimer</h3><p>Apache DolphinScheduler (incubating) is an effort
undergoing incubation at The Apache Software Foundation (ASF), sponsored by
Incubator.
Incubation is required of all newly accepted projects until a further review
indicates
that the infrastructure, communications, and decision making process have
stabilized in a manner consistent with other successful ASF projects.
diff --git a/zh-cn/docs/development/document.json
b/zh-cn/docs/development/document.json
new file mode 100644
index 0000000..ddacb2d
--- /dev/null
+++ b/zh-cn/docs/development/document.json
@@ -0,0 +1,6 @@
+{
+ "filename": "document.md",
+ "__html": "<h2>贡献文档</h2>\n<p>良好的使用文档对任何类型的软件都是至关重要的。欢迎任何可以改进
DolphinScheduler 文档的贡献。</p>\n<h3>获取文档项目</h3>\n<p>DolphinScheduler 项目的文档维护在独立的
<a href=\"https://github.com/apache/incubator-dolphinscheduler-website\">git
仓库</a>中。</p>\n<p>首先你需要先将文档项目 fork 到自己的 github 仓库中,然后将 fork
的文档克隆到本地计算机中。</p>\n<pre><code>git clone
https://github.com/<your-github-user-name>/incubator-dolphinscheduler-website\n</code></pre>\n<h3>文档环境</h3>\n<p>DolphinScheduler
网站由 <a href=\"https://github.com/txd-tea [...]
+ "link": "/zh-cn/docs/development/document.html",
+ "meta": {}
+}
\ No newline at end of file
diff --git a/zh-cn/docs/development/issue.html
b/zh-cn/docs/development/issue.html
index a0e65fc..0507bcf 100644
--- a/zh-cn/docs/development/issue.html
+++ b/zh-cn/docs/development/issue.html
@@ -115,6 +115,81 @@ Issue 中可以讨论的内容包括但不限于 Feature 的包含的功能,
</table>
<h3>Issue 内容模板</h3>
<p><a
href="https://github.com/apache/incubator-dolphinscheduler/tree/dev/.github/ISSUE_TEMPLATE">https://github.com/apache/incubator-dolphinscheduler/tree/dev/.github/ISSUE_TEMPLATE</a></p>
+<h3>Bug 类 Issue</h3>
+<p>当您发现一个 Bug 时,请提交一个 Issue 类的 Bug,提交前:</p>
+<ul>
+<li>请先在 issue 列表里查找一下是否该 Bug 已经提交,如果已经有此 Bug,请在此 Bug 下接着回复。</li>
+<li>如果该 Bug 是可以复现的。请尽量提供完整的重现步骤。</li>
+</ul>
+<p>请在 issues 页面中提交 Bug。</p>
+<p>一个高质量的 Bug 通常有以下特征:</p>
+<ul>
+<li>使用一个清晰并有描述性的标题来定义 Bug。</li>
+<li>详细的描述复现 Bug 的步骤。包括您的配置情况,预计产生的结果,实际产生的结果。并附加详细的 TRACE 日志。</li>
+<li>如果程序抛出异常,请附加完整的堆栈日志。</li>
+<li>如有可能,请附上屏幕截图或动态的 GIF 图,这些图片能帮助演示整个问题的产生过程。</li>
+<li>哪个版本。</li>
+<li>需要修复的优先级(危急、重大、次要、细微)。</li>
+</ul>
+<p>下面是 <strong>Bug 的 Markdown 内容模板</strong>,请按照该模板填写 issue。</p>
+<pre><code class="language-shell">**标题**
+标题格式: [BUG][Priority] bug标题
+Priority分为四级: Critical、Major、Minor、Trivial
+
+**问题描述**
+[清晰准确描述遇到的问题]
+
+**问题复现步骤:**
+1. [第一步]
+2. [第二步]
+3. [...]
+
+**期望的表现:**
+[在这里描述期望的表现]
+
+**观察到的表现:**
+[在这里描述观察到的表现]
+
+**屏幕截图和动态GIF图**
+
+
+**DolphinScheduler版本:(以1.1.0为例)**
+ -[1.1.0]
+
+**补充的内容:**
+[请描述补充的内容,比如]
+
+**需求或者建议**
+[请描述你的需求或者建议]
+</code></pre>
+<h3>Feature 类 Issue</h3>
+<p>提交前:</p>
+<ul>
+<li>请确定这不是一个重复的功能增强建议。 查看 Issue Page 列表,搜索您要提交的功能增强建议是否已经被提交过。</li>
+</ul>
+<p>请在 issues 页面中提交 Feature。</p>
+<p>一个高质量的 Feature 通常有以下特征:</p>
+<ul>
+<li>一个清晰的标题来定义 Feature</li>
+<li>详细描述 Feature 的行为模式</li>
+<li>说明为什么该 Feature 对大多数用户是有用的。新功能应该具有广泛的适用性。</li>
+<li>尽量列出其他调度已经具备的类似功能。商用与开源软件均可。</li>
+</ul>
+<p>以下是 <strong>Feature 的 Markdown 内容模板</strong>,请按照该模板填写 issue 内容。</p>
+<pre><code class="language-shell">**标题**
+标题格式: [Feature][Priority] feature标题
+Priority分为四级: Critical、Major、Minor、Trivial
+
+**Feature的描述**
+[描述新Feature应实现的功能]
+
+**为什么这个新功能是对大多数用户有用的**
+[解释这个功能为什么对大多数用户是有用的]
+
+**补充的内容**
+[列出其他的调度是否包含该功能,是如何实现的]
+
+</code></pre>
<h3>Contributor</h3>
<p>除一些特殊情况之外,在开始完成
Issue 之前,建议先在 Issue 下或者邮件列表中和大家讨论确定设计方案或者提供设计方案,以及代码实现思路。</p>
diff --git a/zh-cn/docs/development/issue.json
b/zh-cn/docs/development/issue.json
index 61cd30f..789563e 100644
--- a/zh-cn/docs/development/issue.json
+++ b/zh-cn/docs/development/issue.json
@@ -1,6 +1,6 @@
{
"filename": "issue.md",
- "__html": "<h2>前言</h2>\n<p>Issues 功能被用来追踪各种特性,Bug,功能等。项目维护者可以通过 Issues
来组织需要完成的任务。</p>\n<p>Issue 是引出一个 Feature 或 Bug 等的重要步骤,在单个\nIssue 中可以讨论的内容包括但不限于
Feature 的包含的功能,存在的 Bug 产生原因,前期方案的调研,以及其对应的实现设计和代码思路。</p>\n<p>并且只有当 Issue 被
approve 之后才需要有对应的 Pull Request 去实现。</p>\n<p>如果是一个 Issue 对应的是一个大
Feature,建议先将其按照功能模块等维度分成多个小的 Issue。</p>\n<h2>规范</h2>\n<h3>Issue
标题</h3>\n<p>标题格式:[<code>Issue 类型</code>][<code>模块名</code>] <code>Issue
描述</code></p>\n<p>其中<code>Issue 类型</code>如下:</p>\n<table>\n <th [...]
+ "__html": "<h2>前言</h2>\n<p>Issues 功能被用来追踪各种特性,Bug,功能等。项目维护者可以通过 Issues
来组织需要完成的任务。</p>\n<p>Issue 是引出一个 Feature 或 Bug 等的重要步骤,在单个\nIssue 中可以讨论的内容包括但不限于
Feature 的包含的功能,存在的 Bug 产生原因,前期方案的调研,以及其对应的实现设计和代码思路。</p>\n<p>并且只有当 Issue 被
approve 之后才需要有对应的 Pull Request 去实现。</p>\n<p>如果是一个 Issue 对应的是一个大
Feature,建议先将其按照功能模块等维度分成多个小的 Issue。</p>\n<h2>规范</h2>\n<h3>Issue
标题</h3>\n<p>标题格式:[<code>Issue 类型</code>][<code>模块名</code>] <code>Issue
描述</code></p>\n<p>其中<code>Issue 类型</code>如下:</p>\n<table>\n <th [...]
"link": "/zh-cn/docs/development/issue.html",
"meta": {}
}
\ No newline at end of file
diff --git a/zh-cn/docs/development/pull-request.html
b/zh-cn/docs/development/pull-request.html
index 1c5685c..7da0dcb 100644
--- a/zh-cn/docs/development/pull-request.html
+++ b/zh-cn/docs/development/pull-request.html
@@ -58,6 +58,8 @@ waste time。</p>
</tbody>
</table>
<p>其中 <code>Issue 号</code>是指当前 Pull Request 对应要解决的 Issue 号,<code>模块名</code>同
Issue 的模块名。</p>
+<h3>Pull Request 分支名</h3>
+<p>分支名格式:<code>Pull Request 类型</code>-<code>Issue 号</code>,举例:Feature-3333。</p>
<h3>Pull Request 内容</h3>
<p>请参阅到 commit message 篇。</p>
<h3>相关问题</h3>
diff --git a/zh-cn/docs/development/pull-request.json
b/zh-cn/docs/development/pull-request.json
index 22ce31d..bc94f0e 100644
--- a/zh-cn/docs/development/pull-request.json
+++ b/zh-cn/docs/development/pull-request.json
@@ -1,6 +1,6 @@
{
"filename": "pull-request.md",
- "__html": "<h2>前言</h2>\n<p>Pull Request
本质上是一种软件的合作方式,是将涉及不同功能的代码,纳入主干的一种流程。这个过程中,可以进行讨论、审核和修改代码。</p>\n<p>在 Pull
Request 中尽量不讨论代码的实现方案,代码及其逻辑的大体实现方案应该尽量在\nIssue 或者邮件列表中被讨论确定,在 Pull Request
中我们尽量只关注代码的格式以及代码规范等信息,从而避免实现方式的意见不同而导致\nwaste time。</p>\n<h2>规范</h2>\n<h3>Pull
Request 标题</h3>\n<p>标题格式:[<code>Pull Request 类型</code>-<code>Issue
号</code>][<code>模块名</code>] <code>Pull Request 描述</code></p>\n<p>其中<code>Pull
Request 类型</code>和<code>Issue 类型</code>的对应关系如下:</p>\n<table>\n <thead>\n
[...]
+ "__html": "<h2>前言</h2>\n<p>Pull Request
本质上是一种软件的合作方式,是将涉及不同功能的代码,纳入主干的一种流程。这个过程中,可以进行讨论、审核和修改代码。</p>\n<p>在 Pull
Request 中尽量不讨论代码的实现方案,代码及其逻辑的大体实现方案应该尽量在\nIssue 或者邮件列表中被讨论确定,在 Pull Request
中我们尽量只关注代码的格式以及代码规范等信息,从而避免实现方式的意见不同而导致\nwaste time。</p>\n<h2>规范</h2>\n<h3>Pull
Request 标题</h3>\n<p>标题格式:[<code>Pull Request 类型</code>-<code>Issue
号</code>][<code>模块名</code>] <code>Pull Request 描述</code></p>\n<p>其中<code>Pull
Request 类型</code>和<code>Issue 类型</code>的对应关系如下:</p>\n<table>\n <thead>\n
[...]
"link": "/zh-cn/docs/development/pull-request.html",
"meta": {}
}
\ No newline at end of file