commit	1c0b7fb2970f4e9e2c7c857490b1dc7726d677b0	[log] [tgz]
author	macksonmu <macksonmu0@gmail.com>	Wed May 24 18:17:38 2023 +0800
committer	GitHub <noreply@github.com>	Wed May 24 18:17:38 2023 +0800
tree	34b57bf72f0598fe8c526c1605567471ba4fc3aa
parent	55fb57eeb66054fa06f5856322df414d2f766c2c [diff]

tree: 34b57bf72f0598fe8c526c1605567471ba4fc3aa

README.md

StreamPark Website

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.

Branch

dev is the default branch. For all modifications, please fork first, and then proceed on the main branch.

dev #default branch

1. Preview and generate static files

This website is compiled using node, using Docusaurus framework components

Download and install nodejs (version>12.5.0)
Clone the code to the local git clone git@github.com:apache/incubator-streampark-website.git
Run npm install to install the required dependent libraries.
Run npm run start in the root directory, you can visit http://localhost:3000 to view the English mode preview of the site
Run npm run start-zh in the root directory, you can visit http://localhost:3000 to view the Chinese mode preview of the site
To generate static website resource files, run npm run build. The static resources of the build are in the build directory.

2. Directory structure

|-- 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
|        |-- image //document common picture
|        |-- image_en //English document picture
|        |-- image_zh //Chinese document picture
|   |-- user // users picture
|   |-- home // homepage picture
|   |-- image  // common picture
|-- docusaurus.config.js

3. Specification

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

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

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

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

3.5 Home page modification

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

├─team
│ languages.json
│ index.js
│ index.less

3.7 User list page modification

Visit the page http://streampark.apache.org/user

Located in `src/pages/user`
└─versions
        data.json
        images.json
        index.js
        index.less
        languages.json