This is an automated email from the ASF dual-hosted git repository.
gosonzhang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-inlong-website.git
The following commit(s) were added to refs/heads/master by this push:
new da4cb33 [INLONG-1771] Website readme error (#180)
da4cb33 is described below
commit da4cb33a20a2ba350ff18b3fe67ab5b5277f1426
Author: Daniel <[email protected]>
AuthorDate: Tue Nov 9 10:37:18 2021 +0800
[INLONG-1771] Website readme error (#180)
---
README.md | 49 ++++++++++++++++++-------------------------------
1 file changed, 18 insertions(+), 31 deletions(-)
diff --git a/README.md b/README.md
index 4ea6915..3b10566 100644
--- a/README.md
+++ b/README.md
@@ -1,34 +1,31 @@
-# TubeMQ Official Website
+# InLong Official Website
-This project keeps all sources used for building up TubeMQ official website
which's served at
-https://tubemq.apache.org/
+This project keeps all sources used for building up InLong official website
which's served at
+https://inlong.apache.org/
## Prerequisite
-TubeMQ website is powered by [docsite](https://github.com/txd-team/docsite).
-If your version of docsite is less than `1.3.3`,please upgrade to `1.3.3`.
-Please also make sure your node version is 10.16.x, versions higher than
10.16.x is not supported by docsite yet.
+InLong website is powered by [docsite](https://docusaurus.io/).
+If your version of docsite is less than `2.0.0`,please upgrade to `2.0.0`.
+Please also make sure your node version is 14.x, versions higher than 14.x is
not supported by docsite yet.
## Build instruction
-1. Run `npm install docsite -g` to install the dev tool.
-2. Run `npm i` in the root directory to install the dependencies.
-3. Run `docsite start` in the root directory to start a local server, you will
see the website in 'http://127.0.0.1:8080'.
-4. Run `docsite build` to build source code.
+1. Run `npm i` in the root directory to install the dependencies.
+2. Run `npm start` in the root directory to start a local server, you will see
the website in 'http://127.0.0.1:3000'.
+3. Run `npm run build` to build source code.
If you have higher version of node installed, you may consider `nvm` to allow
different versions of `node` coexisting on your machine.
1. Follow the [instructions](http://nvm.sh) to install nvm
-2. Run `nvm install v8.16.0` to install node v8
-3. Run `nvm use v8.16.0` to switch the working environment to node v8
-4. Run `npm install docsite -g`
+2. Run `nvm install v14.13.0` to install node v14
+3. Run `nvm use v14.13.0` to switch the working environment to node v14
Then you are all set to run and build the website. Follow the build
instruction above for the details.
-
## How to send a PR
-Make sure you have submit issue for tracking PR:
[https://issues.apache.org/jira/projects/TUBEMQ/issues](https://issues.apache.org/jira/projects/TUBEMQ/issues)
+Make sure you have submit issue for tracking PR:
[https://github.com/apache/incubator-inlong/issues](https://github.com/apache/incubator-inlong/issues)
1. Do not use `git add .` to commit all the changes.
2. Just push your changed files, such as:
@@ -39,25 +36,15 @@ Make sure you have submit issue for tracking PR:
[https://issues.apache.org/jira
## Guide for adding new document
-### Add a new blog
-
-1. Add new .md file under blog/en-us or blog/zh-cn.
-2. Update site_config/blog.js, add a new entry to the blog in either en-us or
zh-cn.
-3. Run docsite start locally to verify the blog can be displayed correctly.
-4. Send the pull request contains the .md and blog.js only.
-
-
### Add a new article for development
-1. Add new .md file under docs/en-us/development or docs/zh-cn/development.
-2. Update site_config/development.js, add a new entry in either en-us or zh-cn.
-3. Run docsite start locally to verify the article can be displayed correctly.
-4. Send the pull request contains the *.md and development.js only.
+1. Add new .md file under `development` or `i18n`.
+2. Run docsite start locally to verify the article can be displayed correctly.
+3. Send the pull request contains the *.md and development.js only.
### Add a new article for docs
-1. Add new .md file under docs/en-us or docs/zh-cn.
-2. Update site_config/docs.js, add a new entry in either en-us or zh-cn.
-3. Run docsite start locally to verify the article can be displayed correctly.
-4. Send the pull request contains the *.md and development.js only.
+1. Add new .md file under `docs` or `i18n`.
+2. Run docsite start locally to verify the article can be displayed correctly.
+3. Send the pull request contains the *.md and development.js only.
