This project keeps all sources used for building up InLong official website which's served at https://inlong.apache.org/
InLong website is powered by Docusaurus.
If your version of Docusaurus is less than 2.0.0
,please upgrade to 2.0.0
.
Please also make sure your node version is 16.14.x, versions higher than 16.14.x is not supported by Docusaurus yet.
- Run
npm i
in the root directory to install the dependencies. - Run
npm start
in the root directory to start a local server, you will see the website in 'http://127.0.0.1:3000'. - Run
npm run build
to build source code.
If you need to see the documentation in simplified Chinese, first npm run build
, then use npm run start-zh
.
If you have higher version of node installed, you may consider nvm
to allow different versions of node
coexisting on your machine.
- Follow the instructions to install nvm
- Run
nvm install v16.14.0
to install node v16 - Run
nvm use v16.14.0
to switch the working environment to node v16
Then you are all set to run and build the website. Follow the build instruction above for the details.
Make sure you have submit issue for tracking PR: https://github.com/apache/inlong/issues
- Do not use
git add .
to commit all the changes. - Just push your changed files, such as:
*.md
- blog.js or docs.js or site.js
- Send a PR to master branch.
- Add new .md file under
docs
ori18n
. - Run dev server locally to verify the article can be displayed correctly.
- Send the pull request contains the *.md and development.js only.
- Modify the document in
docs
, then runnpm run docusaurus docs:version replace_by_target_version
locally to copy a document. - Add a label to DOC's item in
docusaurus.config.js
file. - Modify the last table version in
/src/pages/version/index.js
.