This is an automated email from the ASF dual-hosted git repository.
kirs pushed a commit to branch main
in repository
https://gitbox.apache.org/repos/asf/incubator-seatunnel-website.git
The following commit(s) were added to refs/heads/main by this push:
new 38144f2 Add contributor guide (#27)
38144f2 is described below
commit 38144f286e9fb739a3cb332eb332fd2761d2e452
Author: Kerwin <[email protected]>
AuthorDate: Wed Dec 29 18:05:04 2021 +0800
Add contributor guide (#27)
* Add contributor guide
* fix code style
---
community/contribution_guide/_category_.json | 4 +
community/contribution_guide/contribute.md | 45 +++++++
community/contribution_guide/subscribe.md | 28 +++++
community/submit_guide/_category_.json | 4 +
community/submit_guide/document.md | 131 +++++++++++++++++++++
community/submit_guide/license.md | 35 ++++++
community/submit_guide/submit-code.md | 72 +++++++++++
docusaurus.config.js | 16 ++-
.../current.json | 14 +++
.../current/contribution_guide/contribute.md | 45 +++++++
.../current/contribution_guide/subscribe.md | 30 +++++
.../current/submit_guide/document.md | 131 +++++++++++++++++++++
.../current/submit_guide/license.md | 37 ++++++
.../current/submit_guide/submit-code.md | 72 +++++++++++
14 files changed, 663 insertions(+), 1 deletion(-)
diff --git a/community/contribution_guide/_category_.json
b/community/contribution_guide/_category_.json
new file mode 100644
index 0000000..8334e89
--- /dev/null
+++ b/community/contribution_guide/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Contribution Guide",
+ "position": 1
+}
diff --git a/community/contribution_guide/contribute.md
b/community/contribution_guide/contribute.md
new file mode 100644
index 0000000..4943053
--- /dev/null
+++ b/community/contribution_guide/contribute.md
@@ -0,0 +1,45 @@
+---
+title: Participate in Contributing
+sidebar_position: 1
+---
+
+# Participate in Contributing
+
+First of all, thank you very much for choosing and using Apache Seatunnel, and
welcome to join the Apache Seatunnel family!
+
+We encourage any form of participation in the community that will eventually
become Committer or PPMC Such as:
+* Problems will be encountered via github on the
[issue](https://github.com/apache/incubator-seatunnel/issues) form feedback out.
+* Answer the issue questions that others are asking.
+* Help improve the documentation.
+* Help your project add test cases.
+* Add comments to the code.
+* Submit a PR that fixes the bug or Feature.
+* Publish application case practice, scheduling process analysis, or technical
articles related to scheduling.
+* Help promote Apache Seatunnel, participate in technical conferences or
meetup, sharing and more.
+
+Welcome to the contributing team and join open source starting with submitting
your first PR.
+ - For example, add code comments or find "easy to fix" tags or some very
simple issue (misspellings, etc.) and so on, first familiarize yourself with
the submission process through the first simple PR.
+
+Note: Contributions are not limited to PR Only, but contribute to the
development of the project.
+
+I'm sure you'll benefit from open source by participating in Apache Seatunnel!
+
+### 1. Participate in documentation contributions.
+
+Refer to the [Submit Guide-Document Notice](submit_guide/document.md)
+
+### 2. Participate in code contributions.
+
+**TODO**
+
+### 3. How to pick up an Issue and submit a Pull Request.
+
+If you want to implement a Feature or fix a Bug. Please refer to the following:
+
+* All Bugs and the new Features are recommended and managed using the Issues
Page.
+* If you want to develop a Feature, first reply to the Issue associated with
that feature, indicating that you are currently working on it. And set yourself
a "deadline" when to Submit the Feature, and add it in the reply comment.
+* It's a good idea to find a mentor (or an instructor) in the core
contributors who gives immediate feedback on design and functional
implementation.
+* You should create a new branch to start your work, to get the name of the
branch refer to the [Submit Guide-Pull Request Notice](pull-request.md). For
example, if you want to complete the feature and submit Issue 111, your branch
name should be feature-111. The feature name can be determined after discussion
with the instructor.
+* When you're done, send a Pull Request to Seatunnel, please refer to
the《[Submit Guide-Submit Pull Request Process](submit_guide/submit-code.md)》
+
+If you want to submit a Pull Request to complete a Feature or fix a Bug, it is
recommended that you start with the `good first issue`, `easy-to-fix` issues,
complete a small function to submit, do not change too many files at a time,
changing too many files will also put a lot of pressure on Reviewers, it is
recommended to submit them through multiple Pull Requests, not all at once.
diff --git a/community/contribution_guide/subscribe.md
b/community/contribution_guide/subscribe.md
new file mode 100644
index 0000000..db95f3b
--- /dev/null
+++ b/community/contribution_guide/subscribe.md
@@ -0,0 +1,28 @@
+---
+title: Subscribe Mailing Lists
+sidebar_position: 2
+---
+
+# Subscribe Mailing Lists
+
+It is highly recommended to subscribe to the development mailing list to keep
up-to-date with the community.
+
+In the process of using Seatunnel, if you have any questions or ideas,
suggestions, you can participate in the Seatunnel 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 [email protected] with your own email
address, subject and content are arbitrary.
+
+2. Receive confirmation email and reply. After completing step 1, you will
receive a confirmation email from [email protected] (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 [email protected], and you
have successfully subscribed to the Apache Seatunnel mailing list.
+
+# Unsubscribe Mailing Lists
+
+If you do not need to know what's going on with Seatunnel, you can unsubscribe
from the mailing list.
+
+Unsubscribe from the mailing list steps are as follows:
+
+1. Send an email to [email protected] with your subscribed
email address, subject and content are arbitrary.
+
+2. Receive confirmation email and reply. After completing step 1, you will
receive a confirmation email from [email protected] (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 goodbye email. After completing the above steps, you will receive
a goodbye email with the subject GOODBYE from [email protected], and
you have successfully unsubscribed to the Apache Seatunnel mailing list, and
you will not receive emails from [email protected].
diff --git a/community/submit_guide/_category_.json
b/community/submit_guide/_category_.json
new file mode 100644
index 0000000..8ce7887
--- /dev/null
+++ b/community/submit_guide/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Submit Guide",
+ "position": 2
+}
diff --git a/community/submit_guide/document.md
b/community/submit_guide/document.md
new file mode 100644
index 0000000..796c212
--- /dev/null
+++ b/community/submit_guide/document.md
@@ -0,0 +1,131 @@
+---
+title: Documentation Notice
+sidebar_position: 1
+---
+
+# Documentation Notice
+
+Good documentation is critical for any type of software. Any contribution that
can improve the Seatunnel documentation is welcome.
+
+## Get the document project
+
+Documentation for the Seatunnel project is maintained in a separate [git
repository](https://github.com/apache/incubator-seatunnel-website).
+
+First you need to fork the document project into your own github repository,
and then clone the document to your local computer.
+
+```shell
+git clone
https://github.com/<your-github-user-name>/incubator-seatunnel-website
+```
+
+## Preview and generate static files
+
+This website is compiled using node, using Docusaurus framework components
+
+1. Download and install nodejs (version>12.5.0)
+2. Clone the code to the local `git clone
[email protected]:apache/incubator-seatunnel-website.git`
+2. Run `npm install` to install the required dependent libraries.
+3. Run `npm run start` in the root directory, you can visit
http://localhost:3000 to view the English mode preview of the site
+4. Run `npm run start-zh` in the root directory, you can visit
http://localhost:3000 to view the Chinese mode preview of the site
+5. To generate static website resource files, run `npm run build`. The static
resources of the build are in the build directory.
+
+## Directory structure
+```html
+|-- community
+|-- docs // The next version of the document that will be released soon
+|-- download
+|-- faq // Q&A
+|-- i18n
+| `-- zh-CN //Internationalized Chinese
+| |-- code.json
+| |-- docusaurus-plugin-content-docs
+| |-- docusaurus-plugin-content-docs-community
+| |-- docusaurus-plugin-content-docs-download
+| |-- docusaurus-plugin-content-docs-faq
+| `-- docusaurus-theme-classic
+|-- resource // Original project files for architecture/timing diagram/flow
chart, etc.
+|-- src
+| |-- components
+| |-- css
+| |-- js
+| |-- pages
+| | |-- home
+| | |-- index.jsx
+| | |-- team
+| | |-- user
+| | `-- versions
+| |-- styles
+|-- static // Picture static resource
+| |-- doc // document picture
+| |-- user // users picture
+| |-- home // homepage picture
+| |-- img // common picture
+|-- docusaurus.config.js
+
+```
+
+## Specification
+
+### Directory naming convention
+
+Use all lowercase, separated by underscores. If there is a plural structure,
use plural nomenclature, and do not use plural abbreviations
+
+Positive example: `scripts / styles / components / images / utils / layouts /
demo_styles / demo-scripts / img / doc`
+
+Counter example: `script / style / demoStyles / imgs / docs`
+
+### Vue and the naming convention of static resource files
+
+All lowercase, separated by a dash
+
+Positive example: `render-dom.js / signup.css / index.html / company-logo.png`
+
+Counter example: `renderDom.js / UserManagement.html`
+
+### Resource Path
+
+Image resources are unified under `static/{module name}`
+
+css and other style files are placed in the `src/css` directory
+
+### Page content modification
+> Except for the homepage, team, user, Docs>All Version module page, all other
pages can be directly jumped to the corresponding github resource modification
page through the'Edit this page' button at the bottom
+
+### Home page modification
+Visit the page https://seatunnel.apache.org
+Located in `src/pages/home`
+
+```
+├─home
+│ languages.json // Home page Chinese and English configuration
+│ index.less // homepage style
+```
+### Team page modification
+Visit the page https://seatunnel.apache.org/team
+Located in `src/pages/team`
+```
+├─team
+│ languages.json
+│ index.js
+│ index.less
+```
+### User list page modification
+Visit the page https://seatunnel.apache.org/user
+```
+Located in `src/pages/user`
+└─versions
+ data.json
+ images.json
+ index.js
+ index.less
+ languages.json
+```
+
+### version List page modification
+Visit the page https://seatunnel.apache.org/versions
+```
+Located in `src/pages/versions`
+└─versions
+ languages.json
+ index.jsorchestrator/overview.md
+ index.less
+```
diff --git a/community/submit_guide/license.md
b/community/submit_guide/license.md
new file mode 100644
index 0000000..692334b
--- /dev/null
+++ b/community/submit_guide/license.md
@@ -0,0 +1,35 @@
+---
+title: License Notice
+sidebar_position: 3
+---
+
+# License Notice
+
+As we know that Seatunnel is an open-source undergoing project at The Apache
Software Foundation (ASF), which means that you have to follow the Apache way
to become the Seatunnel contributor. Furthermore, Apache has extremely strict
rules according to the License. This passage will explain the ASF license and
how to avoid License risks at the early stage when you participate in Seatunnel.
+
+Note: This article only applies to the Apache projects.
+
+### Licenses Could be Accepted to the Apache Project
+
+You have to pay attention to the following open-source software protocols
which Apache projects support when you intend to add a new feature to the
Seatunnel (or other Apache projects), which functions refers to other
open-source software references.
+
+[ASF 3RD PARTY LICENSE POLICY](https://apache.org/legal/resolved.html)
+
+If the 3rd party software is not present at the above policy, we are sorry
that your code can not pass the audit and we suggest searching for other
substitute plans.
+
+Besides, when you demand new dependencies in the project, please email us
about the reason and the outcome of the influence to [email protected]
to discuss. Besides, you need at least 3 positive votes from the PPMC to finish
the whole step.
+
+### How to Legally Use 3rd Party Open-source Software in the Seatunnel
+
+Moreover, when we intend to refer a new software ( not limited to 3rd party
jar, text, CSS, js, pics, icons, audios etc and modifications based on 3rd
party files) to our project, we need to use them legally in addition to the
permission of ASF. Refer to the following article:
+
+* [COMMUNITY-LED DEVELOPMENT "THE APACHE
WAY"](https://apache.org/dev/licensing-howto.html)
+
+
+For example, we should contain the NOTICE file (every open-source project has
NOTICE file, generally under root directory) of ZooKeeper in our project when
we are using ZooKeeper. As the Apache explains, "Work" shall mean the work of
authorship, whether in Source or Object form, made available under the License,
as indicated by a copyright notice that is included in or attached to the work.
+
+We are not going to dive into every 3rd party open-source license policy, you
may look up them if interested.
+
+### Seatunnel-License Check Rules
+
+**TODO**
diff --git a/community/submit_guide/submit-code.md
b/community/submit_guide/submit-code.md
new file mode 100644
index 0000000..53d07e5
--- /dev/null
+++ b/community/submit_guide/submit-code.md
@@ -0,0 +1,72 @@
+---
+title: Submit Code
+sidebar_position: 2
+---
+
+# Submit Code
+
+* First from the remote repository
<https://github.com/apache/incubator-seatunnel.git> fork a copy of the code
into your own repository
+
+* There are currently three branches in the remote repository:
+ * **dev** daily development branch
+ > Every day dev development branch, newly submitted code can pull
request to this branch.
+
+ * **1.0.0-release** release version branch
+ > The release version branch, there will be 2.0...and other version
branches in the future.
+
+* Clone your repository to your local
+
+ ```shell
+ git clone [email protected]:apache/incubator-seatunnel.git
+ ```
+
+* Add remote repository address, named upstream
+
+ ```shell
+ git remote add upstream [email protected]:apache/incubator-seatunnel.git
+ ```
+
+* View repository
+
+ ```shell
+ git remote -v
+ ```
+
+ > At this time, there will be two repositories: origin (your own repository)
and upstream (remote repository)
+
+* Get/Update remote repository code
+
+ ```shell
+ git fetch upstream
+ ```
+
+* Synchronize remote repository code to local repository
+
+ ```shell
+ git checkout origin/dev
+ git merge --no-ff upstream/dev
+ ```
+
+* If remote branch has a new branch such as `dev-1.0`, you need to synchronize
this branch to the local repository
+
+ ```shell
+ git checkout -b dev-1.0 upstream/dev-1.0
+ git push --set-upstream origin dev-1.0
+ ```
+
+* After modifying the code locally, submit it to your own repository:
+
+ ```shell
+ git commit -m 'commit content'
+ git push
+ ```
+
+* Submit changes to the remote repository
+
+* On the github page, click "New pull request".
+
+* Select the modified local branch and the branch you want to merge with the
past, click "Create pull request".
+
+* Then the community Committers will do CodeReview, and then he will discuss
some details (including design, implementation, performance, etc.) with you.
When everyone on the team is satisfied with this modification, the commit will
be merged into the dev branch
+
+* Finally, congratulations, you have become an official contributor to Apache
Seatunnel !
diff --git a/docusaurus.config.js b/docusaurus.config.js
index 45e64ab..5ef5d77 100644
--- a/docusaurus.config.js
+++ b/docusaurus.config.js
@@ -86,6 +86,11 @@ const config = {
label: 'Download'
},
{
+ label: 'Community',
+ position: 'right',
+ to: '/community/contribution_guide/contribute'
+ },
+ {
to: '/team',
label: 'Team',
position: 'right',
@@ -179,7 +184,16 @@ const config = {
}),
plugins: [
- 'docusaurus-plugin-less'
+ 'docusaurus-plugin-less',
+ [
+ '@docusaurus/plugin-content-docs',
+ {
+ id: 'community',
+ path: 'community',
+ routeBasePath: 'community',
+ sidebarPath: require.resolve('./sidebars.js'),
+ },
+ ],
]
};
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current.json
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current.json
new file mode 100644
index 0000000..0c17278
--- /dev/null
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current.json
@@ -0,0 +1,14 @@
+{
+ "version.label": {
+ "message": "Next",
+ "description": "The label for version current"
+ },
+ "sidebar.tutorialSidebar.category.Contribution Guide": {
+ "message": "贡献指南",
+ "description": "The label for category Contribution Guide in sidebar
tutorialSidebar"
+ },
+ "sidebar.tutorialSidebar.category.Submit Guide": {
+ "message": "提交指南",
+ "description": "The label for category Submit Guide in sidebar
tutorialSidebar"
+ }
+}
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/contribution_guide/contribute.md
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/contribution_guide/contribute.md
new file mode 100644
index 0000000..3770938
--- /dev/null
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/contribution_guide/contribute.md
@@ -0,0 +1,45 @@
+---
+title: 参与贡献
+sidebar_position: 1
+---
+
+# 参与贡献
+
+首先非常感谢大家选择和使用 Seatunnel，非常欢迎大家加入 Seatunnel 大家庭，融入开源世界！
+
+我们鼓励任何形式的参与社区，最终成为 Committer 或 PPMC，如：
+* 将遇到的问题通过 github 上
[issue](https://github.com/apache/incubator-seatunnel/issues) 的形式反馈出来
+* 回答别人遇到的 issue 问题
+* 帮助完善文档
+* 帮助项目增加测试用例
+* 为代码添加注释
+* 提交修复 Bug 或者 Feature 的 PR
+* 发表应用案例实践、调度流程分析或者与调度相关的技术文章
+* 帮助推广 Seatunnel，参与技术大会或者 meetup 的分享等
+
+欢迎加入贡献的队伍，加入开源从提交第一个 PR 开始
+ - 比如添加代码注释或找到带有 ”easy to fix” 标记或一些非常简单的 issue(拼写错误等) 等等，先通过第一个简单的 PR 熟悉提交流程
+
+注：贡献不仅仅限于 PR 哈，对促进项目发展的都是贡献
+
+相信参与 Seatunnel，一定会让您从开源中受益！
+
+### 1. 参与文档贡献
+
+参考[参与贡献-文档需知](submit_guide/document.md)
+
+### 2. 参与代码贡献
+
+**TODO**
+
+### 3. 如何领取 Issue，提交 Pull Request
+
+如果你想实现某个 Feature 或者修复某个 Bug。请参考以下内容：
+
+* 所有的 Bug 与新 Feature 建议使用 Issues Page 进行管理。
+* 如果想要开发实现某个 Feature 功能，请先回复该功能所关联的 Issue，表明你当前正在这个 Issue 上工作。 并在回复的时候为自己设置一个
**deadline**，并添加的回复内容中。
+* 最好在核心贡献者找到一个导师（指导者），导师会在设计与功能实现上给予即时的反馈。
+* 你应该新建一个分支来开始你的工作，分支的名字参考[参与贡献 Pull Request 需知](pull-request.md)。比如，你想完成
feature 功能并提交了 Issue 111，那么你的 branch 名字应为 feature-111。 功能名称可与导师讨论后确定。
+* 完成后，发送一个 Pull Request 到 Apache
Seatunnel，提交过程具体请参考下面《[提交代码流程](submit_guide/document.md)》。
+
+如果是想提交 Pull Request 完成某一个 Feature 或者修复某个
Bug，这里都建议大家从小处做起，完成一个小功能就提交一次，每次别改动太多文件，改动文件太多也会给 Reviewer 造成很大的心理压力，建议通过多次
Pull Request 的方式完成。
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/contribution_guide/subscribe.md
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/contribution_guide/subscribe.md
new file mode 100644
index 0000000..462d775
--- /dev/null
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/contribution_guide/subscribe.md
@@ -0,0 +1,30 @@
+---
+title: 订阅邮件列表
+sidebar_position: 2
+---
+
+# 订阅邮件列表
+
+强烈推荐订阅开发邮件列表，与社区保持最新信息同步，这一点非常重要。
+
+在使用 Seatunnel 的过程中，如果您有任何问题或者想法、建议，都可以通过 Apache 邮件列表参与到 Seatunnel 的社区建设中来。
+
+发送订阅邮件也非常简单，步骤如下:
+
+1. 用自己的邮箱向
[[email protected]](mailto:[email protected])
发送一封邮件，主题和内容任意。
+
+2. 接收确认邮件并回复。 完成步骤1后，您将收到一封来自 [email protected]
的确认邮件（如未收到，请确认邮件是否被自动归入垃圾邮件、推广邮件、订阅邮件等文件夹）。然后直接回复该邮件，或点击邮件里的链接快捷回复即可，主题和内容任意。
+
+3. 接收欢迎邮件。 完成以上步骤后，您会收到一封主题为 WELCOME to [email protected]
的欢迎邮件，至此您已成功订阅 Apache Seatunnel 的邮件列表。
+
+# 取消订阅邮件列表
+
+如果您不再需要了解 Seatunnel 的动态，可以取消订阅邮件列表。
+
+取消订阅邮件列表步骤如下:
+
+1. 用已经订阅的邮箱向
[[email protected]](mailto:[email protected])
发送一封邮件，主题和内容任意。
+
+2. 接收确认邮件并回复。 完成步骤1后，您将收到一封来自 [email protected]
的确认邮件（如未收到，请确认邮件是否被自动归入垃圾邮件、推广邮件、订阅邮件等文件夹）。然后直接回复该邮件，或点击邮件里的链接快捷回复即可，主题和内容任意。
+
+3. 接收告别邮件。 完成以上步骤后，您会收到一封主题为 GOODBYE from [email protected]
的告别邮件，至此您已成功取消订阅 Apache Seatunnel 的邮件列表，以后将不会再接收来自 [email protected]
的邮件通知。
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/submit_guide/document.md
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/submit_guide/document.md
new file mode 100644
index 0000000..c4ad927
--- /dev/null
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/submit_guide/document.md
@@ -0,0 +1,131 @@
+---
+title: 文档须知
+sidebar_position: 1
+---
+
+# 文档须知
+
+良好的使用文档对任何类型的软件都是至关重要的。欢迎任何可以改进 Seatunnel 文档的贡献。
+
+## 获取文档项目
+
+Seatunnel 项目的文档维护在独立的 [git 仓库]
(https://github.com/apache/incubator-seatunnel-website) 中。
+
+首先你需要先将文档项目 fork 到自己的 github 仓库中，然后将 fork 的文档克隆到本地计算机中。
+
+```
+git clone
https://github.com/<your-github-user-name>/incubator-seatunnel-website
+```
+
+## 预览并生成静态文件
+
+本网站是使用node编译的，使用的是Docusaurus框架组件
+
+1. 下载并安装 nodejs(version>12.5.0)
+2. 克隆代码到本地 `git clone [email protected]:apache/incubator-seatunnel-website.git`
+2. 运行 `npm install` 来安装所需的依赖库。
+3. 在根目录运行`npm run start`，可以访问http://localhost:3000查看站点英文模式预览
+4. 在根目录运行`npm run start-zh`，可以访问http://localhost:3000查看站点的中文模式预览
+5. 要生成静态网站资源文件，运行 `npm run build`。构建的静态资源在build目录中。
+
+## 目录结构
+```html
+
+|-- community //社区
+|-- docs //文档 存方下一个即将发布的版本
+|-- download //下载
+|-- faq //Q&A
+|-- i18n
+| -- zh-CN //国际化中文
+| |-- code.json
+| |-- docusaurus-plugin-content-docs
+| |-- docusaurus-plugin-content-docs-community
+| |-- docusaurus-plugin-content-docs-download
+| |-- docusaurus-plugin-content-docs-faq
+| `-- docusaurus-theme-classic
+|-- resource // 架构/时序/流程图等的原始工程文件
+|-- src
+| |-- components
+| |-- css
+| |-- js
+| |-- pages
+| | |-- home
+| | |-- index.jsx
+| | |-- team
+| | |-- user
+| |-- styles
+|-- static //图片静态资源
+| |-- doc //文档的图片
+| |-- user //用户的图片
+| |-- home //首页的图片
+| |-- img //公用图片
+|-- docusaurus.config.js
+
+```
+
+## 规范
+
+### 目录命名规范
+
+全部采用小写方式， 以中下划线分隔，有复数结构时，要采用复数命名法， 缩写不用复数
+
+正例： `scripts / styles / components / images / utils / layouts / demo_styles /
demo-scripts / img / doc`
+
+反例： `script / style / demoStyles / imgs / docs`
+
+### vue以及静态资源文件命名规范
+
+全部采用小写方式， 以中划线分隔
+
+正例： `render-dom.js / signup.css / index.html / company-logo.png`
+
+反例： `renderDom.js / UserManagement.html`
+
+### 资源路径
+
+图片资源统一放在`static/{模块名}`下
+
+css等样式文件放在`src/css`目录下
+
+### 页面内容修改
+> 除了首页、团队、用户、Docs>All Version 模块页面外，其余页面都能通过底部的'Edit this page'按钮
直接跳转至对应的github的资源修改页
+
+### 首页页面修改
+访问页面 https://seatunnel.apache.org/
+位于 `src/pages/home`
+
+```
+├─home
+│ languages.json 首页中英文的配置
+│ index.less 首页样式
+```
+### 团队页面修改
+访问页面 https://seatunnel.apache.org/zh-CN/team
+位于 `src/pages/team`
+```
+├─team
+│ languages.json
+│ index.js
+│ index.less
+```
+### 用户 列表页面修改
+访问页面 https://seatunnel.apache.org/zh-CN/user/
+```
+位于 `src/pages/user`
+└─versions
+ data.json
+ images.json
+ index.js
+ index.less
+ languages.json
+```
+
+### version 列表页面修改
+访问页面 https://seatunnel.apache.org/zh-CN/versions/
+```
+位于 `src/pages/versions`
+└─versions
+ languages.json
+ index.jsorchestrator/overview.md
+ index.less
+```
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/submit_guide/license.md
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/submit_guide/license.md
new file mode 100644
index 0000000..16c8a58
--- /dev/null
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/submit_guide/license.md
@@ -0,0 +1,37 @@
+---
+title: License 须知
+sidebar_position: 3
+---
+
+# License 须知
+
+如您所知，Seatunnel 现属于 ASF ( Apache 基金会)下的开源项目，这意味着当您想要成为 Seatunnel 的贡献者的时候，就必须按照
Apache 的规则来，而 Apache 对于 License 有着极其严苛的规则，为了避免贡献者在 License 上浪费过多的时间，
+本文将为您讲解 ASF—License 以及参与 Seatunnel 如何过早的规避掉 License 风险。
+
+注：本文仅适用于 Apache 项目。
+
+### Apache 项目可接受的 License
+
+当您想要为 Seatunnel（亦或其他 Apache 项目）增添一个新的功能，这个功能涉及到其他开源软件的引用，那么您必须注意，目前 Apache
项目支持遵从以下协议的开源软件（如果有遗漏，欢迎补充）：
+
+[ASF第三方许可证策](https://apache.org/legal/resolved.html)
+
+如果您所使用的第三方软件并不在以上协议之中，那么很抱歉，您的代码将无法通过审核，建议您找寻其他替代方案。
+
+另外，当您需要使用新的软件的时候，请将您这样做的原因、最终产出结果发邮件至 [email protected] 讨论，当得到至少3票
PPMC 认同的时候，您方可以引入。
+
+### 如何在 Seatunnel 合法的使用第三方开源软件
+
+当我们想要引入一个新的第三方软件(包含但不限于第三方的jar、文本、css、js、图片、图标、音视频等及在第三方基础上做的修改)至我们的项目中的时候，除了他们所遵从的协议是
Apache 允许的，另外一点很重要，就是合法的使用。您可以参考以下文章
+
+* [COMMUNITY-LED DEVELOPMENT "THE APACHE
WAY"](https://apache.org/dev/licensing-howto.html)
+
+
+以 Apache 为例，当我们使用了 ZooKeeper，那么 ZooKeeper 的 NOTICE 文件（每个开源项目都会有 NOTICE
文件，一般位于根目录）则必须在我们的项目中体现，用Apache的话来讲，就是 "Work" shall mean the work of
authorship, whether in Source or Object form, made available under the License,
as indicated by a
+copyright notice that is included in or attached to the work.
+
+关于具体的各个开源协议使用协议，在此不做过多篇幅一一介绍，有兴趣可以自行查询了解。
+
+### Seatunnel-License 检测规则
+
+**TODO**
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/submit_guide/submit-code.md
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/submit_guide/submit-code.md
new file mode 100644
index 0000000..ca7b77a
--- /dev/null
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/submit_guide/submit-code.md
@@ -0,0 +1,72 @@
+---
+title: 提交代码
+sidebar_position: 2
+---
+
+# 提交代码
+
+* 首先从远端仓库 <https://github.com/apache/incubator-seatunnel.git> fork一份代码到自己的仓库中
+
+* 远端仓库中目前有三个分支：
+ * **dev** 日常开发分支
+ > 日常dev开发分支，新提交的代码都可以pull request到这个分支上。
+
+ * **1.0.0-release** 发布版本分支
+ > 发布版本分支，后续会有2.0...等版本分支。
+
+* 把自己仓库clone到本地
+
+ ```shell
+ git clone [email protected]:apache/incubator-seatunnel.git
+ ```
+
+* 添加远端仓库地址，命名为upstream
+
+ ```shell
+ git remote add upstream [email protected]:apache/incubator-seatunnel.git
+ ```
+
+* 查看仓库：
+
+ ```shell
+ git remote -v
+ ```
+
+ > 此时会有两个仓库：origin(自己的仓库)和upstream（远端仓库）
+
+* 获取/更新远端仓库代码（已经是最新代码，就跳过）
+
+ ```shell
+ git fetch upstream
+ ```
+
+* 同步远端仓库代码到本地仓库
+
+ ```shell
+ git checkout origin/dev
+ git merge --no-ff upstream/dev
+ ```
+
+* 如果远端分支有新加的分支比如`dev-1.0`,需要同步这个分支到本地仓库
+
+ ```shell
+ git checkout -b dev-1.0 upstream/dev-1.0
+ git push --set-upstream origin dev-1.0
+ ```
+
+* 在本地修改代码以后，提交到自己仓库：
+
+ ```shell
+ git commit -m 'commit content'
+ git push
+ ```
+
+* 将修改提交到远端仓库
+
+ * 在 github 的 PullRequest 页面，点击 "New pull request".
+
+ * 选择修改完的本地分支和要合并的目的分支，点击 "Create pull request".
+
+* 接着社区 Committer 们会做
CodeReview，然后他会与您讨论一些细节（包括设计，实现，性能等）。当团队中所有人员对本次修改满意后，会将提交合并到dev分支
+
+* 最后，恭喜您已经成为了 Apache Seatunnel 的官方贡献者！
