This is an automated email from the ASF dual-hosted git repository.
benjobs pushed a commit to branch dev
in repository
https://gitbox.apache.org/repos/asf/incubator-streampark-website.git
The following commit(s) were added to refs/heads/dev by this push:
new 24b1a95 [Improve] Localization document and submit-code (#262)
24b1a95 is described below
commit 24b1a95548eb8b5c81f1d415b49a780b68e1a5f5
Author: VampireAchao <[email protected]>
AuthorDate: Sun Oct 1 10:40:30 2023 +0800
[Improve] Localization document and submit-code (#262)
---
community/submit_guide/document.md | 8 +-
.../current/submit_guide/document.md | 145 +++++++++++++++++++++
.../current/submit_guide/submit-code.md | 88 +++++++++++++
3 files changed, 237 insertions(+), 4 deletions(-)
diff --git a/community/submit_guide/document.md
b/community/submit_guide/document.md
index a29821d..9329bb7 100644
--- a/community/submit_guide/document.md
+++ b/community/submit_guide/document.md
@@ -39,10 +39,10 @@ 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-streampark-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.
+3. Run `npm install` to install the required dependent libraries.
+4. Run `npm run start` in the root directory, you can visit
http://localhost:3000 to view the English mode preview of the site
+5. Run `npm run start-zh` in the root directory, you can visit
http://localhost:3000 to view the Chinese mode preview of the site
+6. To generate static website resource files, run `npm run build`. The static
resources of the build are in the build directory.
## Directory structure
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..52bdded
--- /dev/null
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/submit_guide/document.md
@@ -0,0 +1,145 @@
+---
+id: 'document'
+title: '文档说明'
+sidebar_position: 1
+---
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+对于任何类型的软件来说，良好的文档都是至关重要的。任何能够改进 StreamPark 文档的贡献都是受欢迎的。
+
+## 获取文档项目
+
+StreamPark 项目的文档在一个单独的 [git
仓库](https://github.com/apache/incubator-streampark-website) 中维护。
+
+首先，您需要将文档项目 fork 到您自己的 github 仓库，然后将文`clone`到您的本地计算机。
+
+```shell
+git clone [email protected]:<your-github-user-name>/incubator-streampark-website
+```
+
+## 预览和生成静态文件
+
+此网站使用 node 进行编译，使用 Docusaurus 框架组件。
+
+1. 下载并安装 nodejs (版本>12.5.0)
+2. 将代码克隆到本地 `git clone [email protected]:apache/incubator-streampark-website.git`
+3. 运行 `npm install` 来安装所需的依赖库。
+4. 在根目录中运行 `npm run start`，您可以访问 http://localhost:3000 查看站点的英文模式预览
+5. 在根目录中运行 `npm run start-zh`，您可以访问 http://localhost:3000 查看站点的中文模式预览
+6. 若要生成静态网站资源文件，请运行 `npm run build`。构建的静态资源位于 build 目录中。
+
+## 目录结构
+
+```html
+|-- community
+|-- docs // 即将发布的下一个版本的文档
+|-- download
+|-- faq // 常见问题与回答
+|-- 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
+| | `-- versions
+| |-- 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>所有版本模块页面外，其他所有页面都可以通过底部的'编辑此页面'按钮直接跳转到相应的 github 资源修改页面。
+
+### 主页修改
+
+访问页面 https://streampark.apache.org/
+位于 `src/pages/home`
+
+```
+├─home
+│ languages.json // 主页中英文配置
+│ index.less // 主页样式
+```
+
+### 团队页面修改
+
+访问页面 https://streampark.apache.org/team
+位于 `src/pages/team`
+
+```
+├─team
+│ languages.json
+│ index.js
+│ index.less
+```
+
+### 用户列表页面修改
+
+访问页面 https://streampark.apache.org/user
+
+```
+位于 `src/pages/user`
+└─versions
+ data.json
+ images.json
+ index.js
+ index.less
+ languages.json
+```
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..43e8704
--- /dev/null
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/submit_guide/submit-code.md
@@ -0,0 +1,88 @@
+---
+id: 'submit_code'
+title: '提交代码'
+sidebar_position: 2
+---
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+* 首先从远程仓库 <https://github.com/apache/incubator-streampark.git> 将代码的一份副本 fork
到您自己的仓库
+
+* 远程仓库目前有三个分支：
+ * **dev** 每日开发分支
+ > 每天的 dev 开发分支，新提交的代码可以向这个分支发起 pull request。
+
+ * **1.0.0-release** 发布版本分支
+ > 发布版本的分支，未来还会有 2.0... 等其他版本分支。
+
+* 将您的仓库clone到您的本地设备
+
+ ```shell
+ git clone [email protected]:apache/incubator-streampark.git
+ ```
+
+* 添加远程仓库地址，命名为 upstream
+
+ ```shell
+ git remote add upstream [email protected]:apache/incubator-streampark.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 '提交内容'
+ git push
+ ```
+
+* 将更改提交到远程仓库
+
+* 在github页面，点击“New pull request”。
+
+* 选择修改过的本地分支和过去要合并的分支，点击“Create pull request”。
+
+* 然后社区的 Committers 将进行
CodeReview，并与您讨论一些细节（包括设计、实现、性能等）。当团队的每个成员都对此修改感到满意时，提交将被合并到 dev 分支。
+
+* 最后，恭喜您，您已经成为 StreamPark 的官方贡献者！
