Oreoxmt / pingcap-docs-website-scaffold

This repository is deprecated. Use pingcap-docsite-preview https://pdp.oreo.life instead.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

image

How Docs Staging Update Itself

1. Trigger by event from Docs Source Repo

image

2. Trigger by event manually

image

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.

About

This repository is deprecated. Use pingcap-docsite-preview https://pdp.oreo.life instead.


Languages

Language:JavaScript 66.7%Language:Shell 26.7%Language:TypeScript 6.6%