You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@dolphinscheduler.apache.org by li...@apache.org on 2019/11/30 10:04:49 UTC
[incubator-dolphinscheduler-website] branch master updated: update
document add subscribe
This is an automated email from the ASF dual-hosted git repository.
lidongdai 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 50342c2 update document add subscribe
50342c2 is described below
commit 50342c22135107f9d2df4f33eaa52affcb5f57dc
Author: lidongdai <do...@google.com>
AuthorDate: Sat Nov 30 18:04:31 2019 +0800
update document add subscribe
---
docs/en-us/user_doc/subscribe.md | 9 ++
docs/zh-cn/development/code-conduct.md | 67 +++++++++
docs/zh-cn/user_doc/subscribe.md | 10 ++
md_json/docs.json | 10 ++
site_config/development.js | 10 +-
site_config/docs.js | 250 ++++++++++++++++++---------------
6 files changed, 235 insertions(+), 121 deletions(-)
diff --git a/docs/en-us/user_doc/subscribe.md b/docs/en-us/user_doc/subscribe.md
new file mode 100644
index 0000000..f6ea916
--- /dev/null
+++ b/docs/en-us/user_doc/subscribe.md
@@ -0,0 +1,9 @@
+It is highly recommended to subscribe to the development mailing list to keep up-to-date with the community.
+
+In the process of using DolphinScheduler, if you have any questions or ideas, suggestions, you can participate in the DolphinScheduler community building through the Apache mailing list. Sending a subscription email is also very simple, the steps are as follows:
+
+1. Send an email to dev-subscribe@dolphinscheduler.apache.org with your own email address, subject and content.
+
+2. Receive confirmation email and reply. After completing step 1, you will receive a confirmation email from dev-help@dolphinscheduler.apache.org (if not received, please confirm whether the email is automatically classified as spam, promotion email, subscription email, etc.) . Then reply directly to the email, or click on the link in the email to reply quickly, the subject and content are arbitrary.
+
+3. Receive a welcome email. After completing the above steps, you will receive a welcome email with the subject WELCOME to dev@dolphinscheduler.apache.org, and you have successfully subscribed to the Apache DolphinScheduler (Incubating) mailing list.
diff --git a/docs/zh-cn/development/code-conduct.md b/docs/zh-cn/development/code-conduct.md
new file mode 100644
index 0000000..4024d9e
--- /dev/null
+++ b/docs/zh-cn/development/code-conduct.md
@@ -0,0 +1,67 @@
+
+以下行为准则以完全遵循[Apache软件基金会行为准则](https://www.apache.org/foundation/policies/conduct.html)为前提。
+
+## 开发理念
+ - **一致** 代码风格、命名以及使用方式保持一致。
+ - **易读** 代码无歧义，易于阅读和理解而非调试手段才知晓代码意图。
+ - **整洁** 认同《重构》和《代码整洁之道》的理念，追求整洁优雅代码。
+ - **抽象** 层次划分清晰，概念提炼合理。保持方法、类、包以及模块处于同一抽象层级。
+ - **用心** 保持责任心，持续以工匠精神雕琢。
+
+## 开发规范
+
+ - 执行`mvn -U clean package -Prelease`可以编译和测试通过全部测试用例。
+ - 测试覆盖率工具检查不低于dev分支覆盖率。
+ - 请使用Checkstyle检查代码，违反验证规则的需要有特殊理由。模板位置在根目录下ds_check_style.xml。
+ - 遵守编码规范。
+
+## 编码规范
+
+ - 使用linux换行符。
+ - 缩进（包含空行）和上一行保持一致。
+ - 类声明后与下面的变量或方法之间需要空一行。
+ - 不应有无意义的空行。
+ - 类、方法和变量的命名要做到顾名思义，避免使用缩写。
+ - 返回值变量使用`result`命名；循环中使用`each`命名循环变量；map中使用`entry`代替`each`。
+ - 捕获的异常名称命名为`e`；捕获异常且不做任何事情，异常名称命名为`ignored`。
+ - 配置文件使用驼峰命名，文件名首字母小写。
+ - 需要注释解释的代码尽量提成小方法，用方法名称解释。
+ - `equals`和`==`条件表达式中，常量在左，变量在右；大于小于等条件表达式中，变量在左，常量在右。
+ - 除了用于继承的抽象类之外，尽量将类设计为`final`。
+ - 嵌套循环尽量提成方法。
+ - 成员变量定义顺序以及参数传递顺序在各个类和方法中保持一致。
+ - 优先使用卫语句。
+ - 类和方法的访问权限控制为最小。
+ - 方法所用到的私有方法应紧跟该方法，如果有多个私有方法，书写私有方法应与私有方法在原方法的出现顺序相同。
+ - 方法入参和返回值不允许为`null`。
+ - 优先使用三目运算符代替if else的返回和赋值语句。
+ - 优先考虑使用`LinkedList`，只有在需要通过下标获取集合中元素值时再使用`ArrayList`。
+ - `ArrayList`，`HashMap`等可能产生扩容的集合类型必须指定集合初始大小，避免扩容。
+ - 日志与注释一律使用英文。
+ - 注释只能包含javadoc，todo和fixme。
+ - 公开的类和方法必须有javadoc，其他类和方法以及覆盖自父类的方法无需javadoc。
+
+## 单元测试规范
+
+ - 测试代码和生产代码需遵守相同代码规范。
+ - 单元测试需遵循AIR（Automatic, Independent, Repeatable）设计理念。
+ - 自动化（Automatic）：单元测试应全自动执行，而非交互式。禁止人工检查输出结果，不允许使用`System.out`，`log`等，必须使用断言进行验证。
+ - 独立性（Independent）：禁止单元测试用例间的互相调用，禁止依赖执行的先后次序。每个单元测试均可独立运行。
+ - 可重复执行（Repeatable）：单元测试不能受到外界环境的影响，可以重复执行。
+ - 单元测试需遵循BCDE（Border, Correct, Design, Error）设计原则。
+ - 边界值测试（Border）：通过循环边界、特殊数值、数据顺序等边界的输入，得到预期结果。
+ - 正确性测试（Correct）：通过正确的输入，得到预期结果。
+ - 合理性设计（Design）：与生产代码设计相结合，设计高质量的单元测试。
+ - 容错性测试（Error）：通过非法数据、异常流程等错误的输入，得到预期结果。
+ - 如无特殊理由，测试需全覆盖。
+ - 每个测试用例需精确断言。
+ - 准备环境的代码和测试代码分离。
+ - 只有junit `Assert`，hamcrest `CoreMatchers`，Mockito相关可以使用static import。
+ - 单数据断言，应使用`assertTrue`，`assertFalse`，`assertNull`和`assertNotNull`。
+ - 多数据断言，应使用`assertThat`。
+ - 精确断言，尽量不使用`not`，`containsString`断言。
+ - 测试用例的真实值应名为为actualXXX，期望值应命名为expectedXXX。
+ - 测试类和`@Test`标注的方法无需javadoc。
+
+ - 公共规范
+ - 每行长度不超过`200`个字符，保证每一行语义完整以便于理解。
diff --git a/docs/zh-cn/user_doc/subscribe.md b/docs/zh-cn/user_doc/subscribe.md
new file mode 100644
index 0000000..b5788a9
--- /dev/null
+++ b/docs/zh-cn/user_doc/subscribe.md
@@ -0,0 +1,10 @@
+强烈推荐订阅开发邮件列表，与社区保持最新信息同步。
+
+在使用DolphinScheduler的过程中，如果您有任何问题或者想法、建议，都可以通过Apache邮件列表参与到DolphinScheduler的社区建设中来。
+
+发送订阅邮件也非常简单，步骤如下:
+1、用自己的邮箱向dev-subscribe@dolphinscheduler.apache.org发送一封邮件，主题和内容任意。
+
+2、接收确认邮件并回复。 完成步骤1后，您将收到一封来自dev-help@dolphinscheduler.apache.org的确认邮件（如未收到，请确认邮件是否被自动归入垃圾邮件、推广邮件、订阅邮件等文件夹）。然后直接回复该邮件，或点击邮件里的链接快捷回复即可，主题和内容任意。
+
+3、接收欢迎邮件。 完成以上步骤后，您会收到一封主题为WELCOME to dev@dolphinscheduler.apache.org的欢迎邮件，至此您已成功订阅Apache DolphinScheduler（Incubating）的邮件列表。
\ No newline at end of file
diff --git a/md_json/docs.json b/md_json/docs.json
index 0b8a72f..fa867b3 100755
--- a/md_json/docs.json
+++ b/md_json/docs.json
@@ -51,6 +51,11 @@
"meta": {}
},
{
+ "filename": "subscribe.md",
+ "link": "/en-us/docs/user_doc/subscribe.html",
+ "meta": {}
+ },
+ {
"filename": "quick-start.md",
"link": "/en-us/docs/user_doc/quick-start.html",
"meta": {}
@@ -113,6 +118,11 @@
"meta": {}
},
{
+ "filename": "subscribe.md",
+ "link": "/zh-cn/docs/user_doc/subscribe.html",
+ "meta": {}
+ },
+ {
"filename": "quick-start.md",
"link": "/zh-cn/docs/user_doc/quick-start.html",
"meta": {}
diff --git a/site_config/development.js b/site_config/development.js
index 9a591af..3b45a7a 100755
--- a/site_config/development.js
+++ b/site_config/development.js
@@ -13,13 +13,13 @@ export default {
link: '/en-us/docs/development/backend-development.html',
},
{
- title: 'plugin-development',
- link: '/en-us/docs/development/plugin-development.html',
- },
- {
title: 'Frontend Development',
link: '/en-us/docs/development/frontend-development.html',
- }
+ },
+ {
+ title: 'plugin-development',
+ link: '/en-us/docs/development/plugin-development.html',
+ },
],
},
{
diff --git a/site_config/docs.js b/site_config/docs.js
index b95dfb6..6d656d8 100755
--- a/site_config/docs.js
+++ b/site_config/docs.js
@@ -1,120 +1,138 @@
export default {
- 'en-us': {
- sidemenu: [
- {
- title: 'Deployment Document',
- children: [
- {
- title: 'Backend deploy',
- link: '/en-us/docs/user_doc/backend-deployment.html',
- },
- {
- title: 'Frontend deploy',
- link: '/en-us/docs/user_doc/frontend-deployment.html',
- }
- ]
- },
- {
- title: 'User Manual',
- children: [
- {
- title: 'Quick Start',
- link: '/en-us/docs/user_doc/quick-start.html',
- },
- {
- title: 'User Manual',
- link: '/en-us/docs/user_doc/system-manual.html',
- }
- ]
- },
- {
- title: 'Api Document',
- children: [
- {
- title: 'Api Document',
- target: '_blank',
- link: 'http://106.75.43.194:8888/easyscheduler/doc.html?language=en&lang=en'
- }
- ]
- },
- {
- title: 'Upgrade',
- children: [
- {
- title: 'Upgrade',
- link: '/en-us/docs/release/upgrade.html',
- }
- ]
- },
- {
- title: 'FAQ',
- children: [
- {
- title: 'FAQ',
- link: '/en-us/docs/faq.html',
- }
- ]
- }
- ],
- barText: 'Documentation',
- },
- 'zh-cn': {
- sidemenu: [
- {
- title: '部署文档',
- children: [
- {
- title: '后端部署',
- link: '/zh-cn/docs/user_doc/backend-deployment.html',
- },
- {
- title: '前端部署',
- link: '/zh-cn/docs/user_doc/frontend-deployment.html',
- }
+ 'en-us': {
+ sidemenu: [
+ {
+ title: 'Deployment Document',
+ children: [
+ {
+ title: 'Backend deploy',
+ link: '/en-us/docs/user_doc/backend-deployment.html',
+ },
+ {
+ title: 'Frontend deploy',
+ link: '/en-us/docs/user_doc/frontend-deployment.html',
+ }
+ ]
+ },
+ {
+ title: 'User Manual',
+ children: [
+ {
+ title: 'Quick Start',
+ link: '/en-us/docs/user_doc/quick-start.html',
+ },
+ {
+ title: 'User Manual',
+ link: '/en-us/docs/user_doc/system-manual.html',
+ }
+ ]
+ },
+ {
+ title: 'Api Document',
+ children: [
+ {
+ title: 'Api Document',
+ target: '_blank',
+ link: 'http://106.75.43.194:8888/easyscheduler/doc.html?language=en&lang=en'
+ }
+ ]
+ },
+ {
+ title: 'Subscribe',
+ children: [
+ {
+ title: 'Subscribe',
+ link: '/en-us/docs/user_doc/subscribe.html',
+ }
+ ]
+ },
+ {
+ title: 'Upgrade',
+ children: [
+ {
+ title: 'Upgrade',
+ link: '/en-us/docs/release/upgrade.html',
+ }
+ ]
+ },
+ {
+ title: 'FAQ',
+ children: [
+ {
+ title: 'FAQ',
+ link: '/en-us/docs/faq.html',
+ }
+ ]
+ }
],
- },
- {
- title: '用户手册',
- children: [
- {
- title: '快速上手',
- link: '/zh-cn/docs/user_doc/quick-start.html',
- },
- {
- title: '用户手册',
- link: '/zh-cn/docs/user_doc/system-manual.html',
- },
- ],
- },
- {
- title: 'API文档',
- children: [
- {
- title: 'API文档',
- target: '_blank',
- link: 'http://106.75.43.194:8888/easyscheduler/doc.html?language=zh_CN&lang=zh'
- }
- ]
- },
- {
- title: '版本升级',
- children: [
- {
- title: '升级',
- link: '/zh-cn/docs/release/upgrade.html',
- }
+ barText: 'Documentation',
+ },
+ 'zh-cn': {
+ sidemenu: [
+ {
+ title: '部署文档',
+ children: [
+ {
+ title: '后端部署',
+ link: '/zh-cn/docs/user_doc/backend-deployment.html',
+ },
+ {
+ title: '前端部署',
+ link: '/zh-cn/docs/user_doc/frontend-deployment.html',
+ }
+ ],
+ },
+ {
+ title: '用户手册',
+ children: [
+ {
+ title: '快速上手',
+ link: '/zh-cn/docs/user_doc/quick-start.html',
+ },
+ {
+ title: '用户手册',
+ link: '/zh-cn/docs/user_doc/system-manual.html',
+ },
+ ],
+ },
+ {
+ title: 'API文档',
+ children: [
+ {
+ title: 'API文档',
+ target: '_blank',
+ link: 'http://106.75.43.194:8888/easyscheduler/doc.html?language=zh_CN&lang=zh'
+ }
+ ]
+ },
+ {
+ title: '订阅',
+ children: [
+ {
+ title: '订阅(强烈建议)',
+ link: '/zh-cn/docs/user_doc/subscribe.html',
+ }
+ ]
+ },
+ {
+ title: '版本升级',
+ children: [
+ {
+ title: '升级',
+ link: '/zh-cn/docs/release/upgrade.html',
+ }
+ ],
+ },
+ {
+ title: 'FAQ',
+ children: [
+ {
+ title: 'FAQ',
+ link: '/zh-cn/docs/faq.html',
+ }
+ ]
+ }
],
- },
- {
- title: 'FAQ',
- children: [
- {
- title: 'FAQ',
- link: '/zh-cn/docs/faq.html',
- }
- ]
- }
- ],
- barText: '文档'
- }
+ barText: '文档'
+ }
};