This is an automated email from the ASF dual-hosted git repository.
cdmikechen 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 82cc8bd03 SUBMARINE-1410. Update website node to 18
82cc8bd03 is described below
commit 82cc8bd034d8fd9277da529553f579b288203e9b
Author: cdmikechen <[email protected]>
AuthorDate: Sat Sep 23 11:37:05 2023 +0800
SUBMARINE-1410. Update website node to 18
### What is this PR for?
Update website node to 18(lts)
### What type of PR is it?
Documentation
### Todos
* [x] - Set node to 18 in git workflow
### What is the Jira issue?
https://issues.apache.org/jira/browse/SUBMARINE-1410
### How should this be tested?
CI
### 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: cdmikechen <[email protected]>
Signed-off-by: cdmikechen <[email protected]>
Closes #1106 from cdmikechen/SUBMARINE-1410 and squashes the following
commits:
69cdb1ad [cdmikechen] update node to 18
---
.github/workflows/deploy_website.yml | 5 +++--
website/README.md | 11 ++++++-----
2 files changed, 9 insertions(+), 7 deletions(-)
diff --git a/.github/workflows/deploy_website.yml
b/.github/workflows/deploy_website.yml
index 35faaf6cd..47a3e9d79 100644
--- a/.github/workflows/deploy_website.yml
+++ b/.github/workflows/deploy_website.yml
@@ -19,6 +19,7 @@ name: Deploy Submarine documentation
on:
pull_request:
push:
+ branches: [master]
paths:
- 'website/**'
@@ -29,7 +30,7 @@ jobs:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
- node-version: '14'
+ node-version: '18'
- name: Test Build
working-directory: ./website
run: |
@@ -42,7 +43,7 @@ jobs:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
- node-version: '14'
+ node-version: '18'
- name: Add key to allow access to repository
env:
SSH_AUTH_SOCK: /tmp/ssh_agent.sock
diff --git a/website/README.md b/website/README.md
index 9e2336d4b..db11993a2 100644
--- a/website/README.md
+++ b/website/README.md
@@ -23,13 +23,14 @@ This website is built using [Docusaurus
2](https://v2.docusaurus.io/), a modern
## Installation
-```console
+```shell
+# We recommend using node 18(LTS).
yarn install
```
## Local Development
-```console
+```shell
yarn start
```
@@ -37,13 +38,13 @@ This command starts a local development server and open up
a browser window. Mos
If you want to switch to zh-cn, you can use the following command to start.
-```console
+```shell
yarn start -- --locale zh-cn
```
## Build
-```console
+```shell
yarn build
```
@@ -51,7 +52,7 @@ This command generates static content into the `build`
directory and can be serv
## Deployment
-```console
+```shell
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
```
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
