This is an automated email from the ASF dual-hosted git repository. tison pushed a commit to branch tidy-readme in repository https://gitbox.apache.org/repos/asf/incubator-streampark-website.git
commit 4210c8b1b7a5db1270785c363b321a1805d6c42b Author: tison <[email protected]> AuthorDate: Tue Mar 26 07:30:13 2024 +0800 Polish README wording Signed-off-by: tison <[email protected]> --- README.md | 69 +++++++++++++++++++++++++++++++----------------------------- README_ZH.md | 11 +++------- 2 files changed, 39 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index e4833806..6cc00df8 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 proceed on the dev branch. ## 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 +``` + +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. -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. +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,51 +72,52 @@ 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 +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` +* 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 - -Positive example: `render-dom.js / signup.css / index.html / company-logo.png` +All lowercase, separated by a dash: -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 diff --git a/README_ZH.md b/README_ZH.md index 65edb1fd..8594c448 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -4,18 +4,13 @@ [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 分支上进行开发修改。 -``` -dev 默认分支 -``` - -## 1.预览并生成静态文件 +## 1. 预览并生成静态文件 本网站是使用 Node.js 编译的，使用的是 [Docusaurus(2.4.3)](https://docusaurus.io/) 框架组件：
