This is an automated email from the ASF dual-hosted git repository.
pingsutw pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/submarine.git
The following commit(s) were added to refs/heads/master by this push:
new 01bdd46 SUBMARINE-919. Add develop submarine website guide
01bdd46 is described below
commit 01bdd46edcd18e2f8ce285eaada492e28fc8224f
Author: Kevin Su <[email protected]>
AuthorDate: Thu Jul 15 11:47:41 2021 +0800
SUBMARINE-919. Add develop submarine website guide
### What is this PR for?
<!-- A few sentences describing the overall goals of the pull request's
commits.
First time? Check out the contributing guide -
https://submarine.apache.org/contribution/contributions.html
-->
We need to add a develop submarine website guide in
https://submarine.apache.org/docs/devDocs/Development#develop-workbench
- How to build the website
- How to launch the website in local
- How to add a new page (Need to update
https://github.com/apache/submarine/blob/master/website/sidebars.js)
### What type of PR is it?
[Documentation]
### Todos
No
### What is the Jira issue?
<!-- * Open an issue on Jira
https://issues.apache.org/jira/browse/SUBMARINE/
* Put link here, and add [SUBMARINE-*Jira number*] in PR title, eg.
`SUBMARINE-23. PR title`
-->
https://issues.apache.org/jira/browse/SUBMARINE-919
### How should this be tested?
<!--
* First time? Setup Travis CI as described on
https://submarine.apache.org/contribution/contributions.html#continuous-integration
* Strongly recommended: add automated unit tests for any new or changed
behavior
* Outline any manual steps to test the PR here.
-->
Pass the CIs.
### Screenshots (if appropriate)
### Questions:
* Do the license files need updating? No
* Are there breaking changes for older versions? No
* Does this need new documentation? No
Author: Kevin Su <[email protected]>
Author: Kevin Su <[email protected]>
Signed-off-by: Kevin <[email protected]>
Closes #677 from pingsutw/SUBMARINE-919 and squashes the following commits:
11fda048 [Kevin Su] Merge branch 'master' into SUBMARINE-919
ea4b65d2 [Kevin Su] Update Development.md
52e2f4bf [Kevin Su] Update Development.md
1a41fd4e [Kevin Su] Update Development.md
ba493757 [Kevin Su] Update Development.md
3e31f0ca [Kevin Su] Update Development.md
7300b18f [Kevin Su] Add develop submarine website guide
---
website/docs/devDocs/Development.md | 33 +++++++++++++++++++++++++++++++--
1 file changed, 31 insertions(+), 2 deletions(-)
diff --git a/website/docs/devDocs/Development.md
b/website/docs/devDocs/Development.md
index dfb82d0..ffa1c0b 100644
--- a/website/docs/devDocs/Development.md
+++ b/website/docs/devDocs/Development.md
@@ -147,8 +147,7 @@ Checkstyle plugin may help to detect violations directly
from the IDE.
```bash
helm upgrade --set submarine.database.dev=true submarine
./helm-charts/submarine
```
-
-## Develop operator
+ ## Develop operator
- Before building
@@ -210,3 +209,33 @@ Checkstyle plugin may help to detect violations directly
from the IDE.
Press ctrl+c to stop the operator.
For other details, please check out the
[README](https://github.com/apache/submarine/blob/master/submarine-cloud-v2/README.md)
and [Developer
Guide](https://github.com/apache/submarine/blob/master/submarine-cloud-v2/docs/developer-guide.md)
on GitHub.
+
+## 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.
+
+To update the website, 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
+We use the yarn package manager to install all dependencies for the website
+```console
+yarn install
+```
+
+### Build
+Make sure you can successfully build the website before creating a pull
request.
+```console
+yarn build
+```
+
+### Local Development
+This command starts a local development server and open up a browser window.
Most changes are reflected live without having to restart the server.
+```console
+yarn start
+```
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
