This is an automated email from the ASF dual-hosted git repository.
cancai 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 ddcdf961 Polish README wording (#343)
ddcdf961 is described below
commit ddcdf961313cf4c727cff4ae2caf6cdeba2b23a9
Author: tison <[email protected]>
AuthorDate: Tue Mar 26 08:04:46 2024 +0800
Polish README wording (#343)
* Polish README wording
Signed-off-by: tison <[email protected]>
* Finish
Signed-off-by: tison <[email protected]>
---------
Signed-off-by: tison <[email protected]>
---
README.md | 81 ++++++++++++++++++++++++++++--------------------------
README_ZH.md | 89 ++++++++++++++++++++++++++++--------------------------------
2 files changed, 83 insertions(+), 87 deletions(-)
diff --git a/README.md b/README.md
index e4833806..a49e3caf 100644
--- a/README.md
+++ b/README.md
@@ -1,35 +1,37 @@
# Apache StreamPark™ WebSite
+
[](https://www.apache.org/licenses/LICENSE-2.0.html)
[English](README.md) | [中文](README_ZH.md)
This is the repository containing all the source code of
`http://streampark.apache.org`.
-This guide will guide you how to contribute to the Apache
StreamPark™(Incubating) website.
+This guide will guide you how to contribute to the Apache StreamPark™
(Incubating) website.
## Branch
-dev is the default branch. For all modifications, please fork first, and then
proceed on the main branch.
-
-```
-dev #default branch
-```
+dev is the default branch. For all modifications, please fork first, and then
check out a new branch to proceed.
## 1. Preview and generate static files
-This website is compiled using node, using
[Docusaurus(2.4.3)](https://docusaurus.io/) framework components
+This website is compiled using Node.js (version >=16.14 <=18), using
[Docusaurus (2.4.3)](https://docusaurus.io/) framework components.
+
+To download and preview the website:
-1. Download and install nodejs, The supported versions are as follows:
+```shell
+git clone https://github.com/apache/incubator-streampark-website.git
streampark-website
+cd streampark-website
+npm install
+npm run start
+```
-1. Download and install nodejs (version>=16.14 and version<=18)
-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.
+It'll open http://localhost:3000 for you to view the English preview of the
site. Instead, run `npm run start-zh` to preview the Chinese version.
+
+To generate static website resource files, run `npm run build`. The static
resources of the build are in the `build` directory.
## 2. Directory structure
-```html
+
+```text
|-- community
|-- docs // The next version of the document that will be released soon
|-- download
@@ -70,55 +72,56 @@ This website is compiled using node, using
[Docusaurus(2.4.3)](https://docusauru
### 3.1 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`
+Use all lowercase, separated by underscores. If there is a plural structure,
use plural nomenclature, and do not use plural abbreviations:
-Counter example: `script / style / demoStyles / imgs / docs`
+* Positive example: `scripts / styles / components / images / utils / layouts
/ demo_styles / demo-scripts / img / doc`
+* Counter example: `script / style / demoStyles / imgs / docs`
### 3.2 javascript and the naming convention of static resource files
-All lowercase, separated by a dash
+All lowercase, separated by a dash:
-Positive example: `render-dom.js / signup.css / index.html / company-logo.png`
-
-Counter example: `renderDom.js / UserManagement.html`
+* Positive example: `render-dom.js / signup.css / index.html /
company-logo.png`
+* Counter example: `renderDom.js / UserManagement.html`
### 3.3 Resource Path
-Image resources are unified under `static/{module name}`
-
-css and other style files are placed in the `src/css` directory
+Image resources are unified under `static/{module name}`; CSS and other style
files are placed in the `src/css` directory.
### 3.4 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
+
+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.
### 3.5 Home page modification
-Visit the page http://streampark.apache.org
-Located in `src/pages/home`
+
+Visit the page http://streampark.apache.org; located in `src/pages/home`:
```
├─home
│ languages.json // Home page Chinese and English configuration
│ index.less // homepage style
```
+
### 3.6 Team page modification
-Visit the page http://streampark.apache.org/team
-Located in `src/pages/team`
+
+Visit the page http://streampark.apache.org/team; located in `src/pages/team`:
+
```
├─team
│ languages.json
│ index.js
│ index.less
```
+
### 3.7 User list page modification
-Visit the page http://streampark.apache.org/user
+
+Visit the page http://streampark.apache.org/user; located in `src/pages/user`:
+
```
-Located in `src/pages/user`
-└─versions
- data.json
- images.json
- index.js
- index.less
- languages.json
+├─user
+│ data.json
+│ images.json
+│ index.js
+│ index.less
+│ languages.json
```
diff --git a/README_ZH.md b/README_ZH.md
index 65edb1fd..837ece5d 100644
--- a/README_ZH.md
+++ b/README_ZH.md
@@ -4,36 +4,36 @@
[English](README.md) | [中文](README_ZH.md)
-这是包含 `http://streampark.apache.org` 的所有源代码的存储库。
-本指南将指导您如何为 Apache StreamPark™(Incubating) 的网站做出贡献。
+这是包含 `http://streampark.apache.org` 的所有源代码的存储库。本指南将指导您如何为 Apache StreamPark™
(Incubating) 的网站做出贡献。
## 分支
-dev 为默认主分支，修改请先 fork 到自己的仓库，然后在 main 分支上进行开发修改。
+dev 为默认主分支，修改请先 fork 到自己的仓库，然后切换到自己的开发分支上进行开发修改。
-```
-dev 默认分支
-```
+## 1. 预览并生成静态文件
-## 1.预览并生成静态文件
+本网站使用 Node.js 编译（>=16.14 <=18），并基于 [Docusaurus
(2.4.3)](https://docusaurus.io/) 框架构建。
-本网站是使用 Node.js 编译的，使用的是 [Docusaurus(2.4.3)](https://docusaurus.io/) 框架组件：
+运行以下命令下载网站源代码并在本地预览：
+
+```shell
+git clone https://github.com/apache/incubator-streampark-website.git
streampark-website
+cd streampark-website
+npm install
+npm run start
+```
-1. 下载并安装 Node.js（version>=16.14 and version<=18)）
-2. 克隆代码到本地 `git clone [email protected]:apache/incubator-streampark-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 目录中。
+这段命令将在浏览器打开 http://localhost:3000 页面提供英文预览版。如果想预览中文版本，请使用 `npm run start-zh`
命令。
-## 2.目录结构
+运行 `npm run build` 命令可以生成静态网站资源文件，构建出来的静态资源在 build 目录中。
-```html
+## 2. 目录结构
+```text
|-- community //社区
-|-- docs //文档 存放下一个即将发布的版本
-|-- download //下载
-|-- faq //Q&A
+|-- docs //文档 存放下一个即将发布的版本
+|-- download //下载
+|-- faq //Q&A
|-- i18n
| -- zh-CN //国际化中文
| |-- code.json
@@ -62,53 +62,47 @@ dev 默认分支
| |-- home //首页的图片
| |-- image //模块公用图片
|-- docusaurus.config.js
-
```
-## 3.规范
+## 3. 规范
### 3.1 目录命名规范
-全部采用小写方式，以中下划线分隔，有复数结构时，要采用复数命名法，缩写不用复数
-
-正例： `scripts / styles / components / images / utils / layouts / demo_styles /
demo-scripts / img / doc`
+全部采用小写方式，以中下划线分隔，有复数结构时，要采用复数命名法，缩写不用复数：
-反例： `script / style / demoStyles / imgs / docs`
+* 正例： `scripts / styles / components / images / utils / layouts / demo_styles
/ demo-scripts / img / doc`
+* 反例： `script / style / demoStyles / imgs / docs`
### 3.2 JavaScript 以及静态资源文件命名规范
-全部采用小写方式， 以中划线分隔
-
-正例： `render-dom.js / signup.css / index.html / company-logo.png`
+全部采用小写方式， 以中划线分隔：
-反例： `renderDom.js / UserManagement.html`
+* 正例： `render-dom.js / signup.css / index.html / company-logo.png`
+* 反例： `renderDom.js / UserManagement.html`
### 3.3 资源路径
-* 图片资源统一放在 `static/{模块名}` 下
-* CSS 等样式文件放在 `src/css` 目录下
+图片资源统一放在 `static/{模块名}` 下，CSS 等样式文件放在 `src/css` 目录下。
### 3.4 页面内容修改
-> 除了首页、团队、用户、Docs>All Version 模块页面外，其余页面都能通过底部的 'Edit this page' 按钮，直接跳转至对应的
GitHub 的资源修改页
+除了首页、团队、用户、Docs>All Version 模块页面外，其余页面都能通过底部的 'Edit this page' 按钮，直接跳转至对应的
GitHub 的资源修改页。
### 3.5 首页页面修改
-访问页面：[http://streampark.apache.org/](http://streampark.apache.org/)
-
-位于 `src/pages/home`：
+* 对应页面 http://streampark.apache.org/zh-CN
+* 源码位于 `src/pages/home`
```
├─home
│ languages.json 首页中英文的配置
-│ index.less 首页样式
+│ index.less 首页样式
```
### 3.6 团队页面修改
-访问页面：[http://streampark.apache.org/zh-CN/team](http://streampark.apache.org/zh-CN/team)
-
-位于 `src/pages/team`：
+* 对应页面 http://streampark.apache.org/zh-CN/team
+* 源码位于 `src/pages/team`
```
├─team
@@ -119,15 +113,14 @@ dev 默认分支
### 3.7 用户列表页面修改
-访问页面：[http://streampark.apache.org/zh-CN/user/](http://streampark.apache.org/zh-CN/user/)
-
-位于 `src/pages/user`：
+* 对应页面 http://streampark.apache.org/zh-CN/user/
+* 源码位于 `src/pages/user`
```
-└─versions
- data.json
- images.json
- index.js
- index.less
- languages.json
+├─user
+│ data.json
+│ images.json
+│ index.js
+│ index.less
+│ languages.json
```
