From 69cdb1ad929bc9d91ef24a04c77fae31e776c5ee Mon Sep 17 00:00:00 2001 From: cdmikechen Date: Sat, 23 Sep 2023 11:37:05 +0800 Subject: [PATCH] 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 35faaf6cd7..47a3e9d79c 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 9e2336d4ba..db11993a25 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= USE_SSH=true yarn deploy ```