PingCAP Docs Website Scaffold

This scaffold helps you to deploy a PingCAP documentation website easily.

To create a production build, you can run the ./build.sh script.

To create a development build, you can run the ./build.sh script with dev or develop argument.

Workflow

Overview

How Docs Staging Update Itself

1. Trigger by event from Docs Source Repo

2. Trigger by event manually

Config Actions Secrets

1. Install Surge.sh CLI

npm install --global surge

2. Login Surge.sh

surge login

3. Create Surge.sh Token

surge token

4. Config Surge.sh Token

Visit <Your Repo URL>/settings/secrets/actions and add SURGE_TOKEN with the token you just created.