Apache Linkis Website

English | 中文

This is the repository containing all the source code of https://linkis.apache.org. This guide will guide you how to contribute to the Linkis website.

Branch

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

master 
dev #development branch
asf-site   #The official environment of asf-site official website is accessed through https://linkis.apache.org
asf-staging #The asf-staging official website test environment is accessed through https://linkis.staged.apache.org

1. 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-linkis-website.git
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.

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
|   |-- Images
|   |-- Images-zh
|   |-- faq
|   |-- home
|   `-- img
|-- docusaurus.config.js
|-- versioned_docs //Historical version archive
|   `-- version-1.0.2
|-- versioned_sidebars
|   `-- version-1.0.2-sidebars.json
`-- versions.json

The following table illustrates how versioned files are mapped to their version and generated URL.

file Path	Version	http URL
versioned_docs/version-1.0.1/hello.md	1.0.1	/docs/1.0.1/hello
versioned_docs/version-1.0.2/hello.md	1.0.2 (latest current stable version)	/docs/latest/hello
docs/hello.md	current (the next version 1.0.3 to be released)	/docs/1.0.3/hello

Current version information

Version	Access Path	English Document Path	Chinese Document Path
1.0.2	https://linkis.apache.org/docs/latest/xxx (https://linkis.apache.org/zh-CN/docs/latest/xxx)	versioned_docs/version-1.0.2/	i18n/zh-CN/docusaurus-plugin-content-docs/version-1.0.2
1.0.3	https://linkis.apache.org/docs/1.0.3/xxx (https://linkis.apache.org/zh-CN/docs/1.0.3/xxx)	/docs	i18n/zh-CN/docusaurus-plugin-content-docs/current

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 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

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 https://linkis.apache.org Located in src/pages/home

├─home
│ config.json Home page Chinese and English configuration
│ index.less homepage style

3.6 Team page modification

Visit the page https://linkis.apache.org/team Located in src/pages/team

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

3.7 User list page modification

Visit the page https://linkis.apache.org/user

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

3.8 version List page modification

Visit the page https://linkis.apache.org/versions

Located in `src/pages/versions`
└─versions
        config.json
        index.jsorchestrator/overview.md
        index.less

4. New documents

The md document is recommended to be viewed by visiting the official website and viewing the md document through github. There is a problem that static resources such as pictures cannot be displayed correctly

• The English document docs/ corresponds to the next Next version to be released, and the historical archive version is stored in the versioned_docs/version-${versionno} directory.
• Chinese documents are placed in the corresponding directory of i18n/zh-CN/docusaurus-plugin-content-docs/, current is the next version to be released. version-${versionno} is the historical archive version.
• Image resources are placed in the static/ directory

5. Other

The naming convention refers to "Alibaba Front-end Development Specification"