jojochuang commented on a change in pull request #677:
URL: https://github.com/apache/submarine/pull/677#discussion_r670101319
##########
File path: website/docs/devDocs/Development.md
##########
@@ -146,3 +146,33 @@ Checkstyle plugin may help to detect violations directly
from the IDE.
```bash
helm upgrade --set submarine.database.dev=true submarine
./helm-charts/submarine
```
+
+## Develop Submarine Website
+Submarine website is built using [Docusaurus 2](https://v2.docusaurus.io/), a
modern static website generator.
+
+We store all the website content in markdown format in the
`submarine/website/docs`. When committing a new patch to the `submarine` repo,
Docusaurus will help us generate the `html` and `javascript` files and push
them to https://github.com/apache/submarine-site/tree/asf-site.
+
+If you want to update the website, you can click “Edit this page” on the
website.
+
+
+
+### Add a new page
+If you want to add a new page to the website, make sure to add the file path
to
[sidebars.js](https://github.com/apache/submarine/blob/master/website/sidebars.js).
+
+### Installation
+It's used to install all dependencies for the website.
Review comment:
We use the yarn package manager to install all dependencies for the
website
##########
File path: website/docs/devDocs/Development.md
##########
@@ -146,3 +146,33 @@ Checkstyle plugin may help to detect violations directly
from the IDE.
```bash
helm upgrade --set submarine.database.dev=true submarine
./helm-charts/submarine
```
+
+## Develop Submarine Website
+Submarine website is built using [Docusaurus 2](https://v2.docusaurus.io/), a
modern static website generator.
+
+We store all the website content in markdown format in the
`submarine/website/docs`. When committing a new patch to the `submarine` repo,
Docusaurus will help us generate the `html` and `javascript` files and push
them to https://github.com/apache/submarine-site/tree/asf-site.
+
+If you want to update the website, you can click “Edit this page” on the
website.
Review comment:
"To update the website, click “Edit this page” on the website."
##########
File path: website/docs/devDocs/Development.md
##########
@@ -146,3 +146,33 @@ Checkstyle plugin may help to detect violations directly
from the IDE.
```bash
helm upgrade --set submarine.database.dev=true submarine
./helm-charts/submarine
```
+
+## Develop Submarine Website
+Submarine website is built using [Docusaurus 2](https://v2.docusaurus.io/), a
modern static website generator.
+
+We store all the website content in markdown format in the
`submarine/website/docs`. When committing a new patch to the `submarine` repo,
Docusaurus will help us generate the `html` and `javascript` files and push
them to https://github.com/apache/submarine-site/tree/asf-site.
+
+If you want to update the website, you can click “Edit this page” on the
website.
+
+
Review comment:
is this an empty ink?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
