website-docs

The next generation of PingCAP Docs. Powered by Gatsby ⚛️.

Note: Currently WIP

How to develop

After clone this repo, run yarn to get all deps:

yarn

We have pre-defined some commands to download the docs and clear docs, these commands are:

{
  "scripts": {
    "clean:docs:docs-tidb:en": "rimraf ./markdown-pages/contents/en/docs-tidb/**/*.md",
    "clean:docs:docs-tidb:zh": "rimraf ./markdown-pages/contents/zh/docs-tidb/**/*.md",
    "clean:docs:docs-tidb-operator:en": "rimraf ./markdown-pages/contents/en/docs-tidb-operator/**/*.md",
    "clean:docs:docs-tidb-operator:zh": "rimraf ./markdown-pages/contents/zh/docs-tidb-operator/**/*.md",
    "clean:docs:docs-dm:en": "rimraf ./markdown-pages/contents/en/docs-dm/**/*.md",
    "clean:docs:docs-dm:zh": "rimraf ./markdown-pages/contents/zh/docs-dm/**/*.md",
    "download:docs-tidb:en": "node markdown-pages/cli.js download docs",
    "download:docs-tidb:en:all": "./scripts/download-docs-tidb-en.sh",
    "download:docs-tidb:zh": "node markdown-pages/cli.js download docs-cn",
    "download:docs-tidb:zh:all": "./scripts/download-docs-tidb-zh.sh",
    "download:docs-tidb-operator": "node markdown-pages/cli.js download docs-tidb-operator",
    "download:docs-tidb-operator:all": "./scripts/download-docs-tidb-operator.sh",
    "download:docs-tidb-operator:en:all": "./scripts/download-docs-tidb-operator-en.sh",
    "download:docs-tidb-operator:zh:all": "./scripts/download-docs-tidb-operator-zh.sh",
    "download:docs-dm": "node markdown-pages/cli.js download docs-dm",
    "download:docs-dm:all": "./scripts/download-docs-dm.sh",
    "download:docs-dm:en:all": "./scripts/download-docs-dm-en.sh",
    "download:docs-dm:zh:all": "./scripts/download-docs-dm-zh.sh"
  }
}

But the download commands must pass some parameters to work properly. You can understand that it is just a partial command. For example, run:

node markdown-pages/cli.js help

You will see:

cli.js [command]

Commands:
  cli.js download <repo> [path] [ref]  specify which repo of docs you want to
                                       download
  cli.js sync <repo> <ref> <sha>       Sync the docs' changes by a single commit

Options:
  --help     Show help                                                 [boolean]
  --version  Show version number                                       [boolean]

Let us explain with this example: yarn download:docs-tidb-operator en master.

This will expand as: node markdown-pages/cli.js download docs-tidb-operator en master.

The <repo> is docs-tidb-operator, which is required. It means we will download the docs from this repo.

The second, [path] is a subpath of the repo. In https://github.com/pingcap/docs-tidb-operator, we want to download all docs under the en.

The last, [ref] is the branch of the repo. In this example, we want to download All documents in the master branch, under the en folder.

Other usage methods can refer to scripts/download-*.sh.

After download

Run yarn start to develop:

yarn start

CI

We use GitHub actions to serve the build and deploy.

The core of the CI is using repository_dispatch event which described at https://help.github.com/en/actions/reference/events-that-trigger-workflows#external-events-repository_dispatch.

Once outside repo post this event, the master branch workflow will start to update the website.

For more details, view: https://github.com/pingcap/website-docs/blob/master/.github/workflows/update.yml

GitHub Outh2 token

Because of most of our text data stored in GitHub. So, It's needed to apply a GitHub API token in development when you are prompted for rate-limiting.

For more details, view https://developer.github.com/v3/#rate-limiting

You must set the token as an env when you start some commands, defined as:

GITHUB_AUTHORIZATION_TOKEN=token

Some scripts will need this env variable, for example:

GITHUB_AUTHORIZATION_TOKEN=token yarn download:docs-tidb-operator en master

The rules we followed

For better collaboration and review, we have developed a few rules to help us develop better.

JS
Styles
Be Compact
Necessary Test

Before you contribute, you must read the following carefully.

JS

First, we use husky and lint-staged to make prettier format our code automatically before commit.

And also, because some of us use vscode to develop the dashboard, we recommend to use sort-imports to format all imports. (This is optional, we will not force you to use)

Styles

Currently, we use sass to style each pages and components.

We hope you can follow this order (Don't care about their value) to organize all styles:

// Position first
position: relative;
top: 0;
bottom: 0;
left: 0;
right: 0;
// Then display
display: flex;
flex-direction: column;
justify-content: center;
align-items: center;
// Layout
width: 0;
height: 0;
margin: 0;
padding: 0;
// Colors
background: #fff;
color: #000;
// Outside
border: 0;
box-shadow: none;
// Finally, not often used values can be in any order

Be Compact

Don't include no used deps.

Don't let your code be too long-winded, there will be a lot of elegant writing.

Necessary Test

Every new features must have a unit test.

Shortcodes

Currently, you can use these shortcodes into docs:

<Note>This is a note.</Note>

<Warning>This is a warning.</Warning>

<Tips>This is a tip.</Tips>

<Error>This is an error</Error>

Everything you needed is just to write a JSX tag, put the text into it. Then we will use mdx to convert it to JS code.

Landing page for TiDB

Edit file _index.md in each doc repo to custom its landing page.

All columns have to be wrapped by tag <NavColumns></NavColumns>, each column has to be wrapped by tag <NavColumn></NavColumn>and column title has to be wrapped by tag <ColumnTitle></ColumnTitle>. For example:

<NavColumns>
<NavColumn>
<ColumnTitle>Column title</ColumnTitle>
- [This is nav](/fileName.md)
- [This is nav](/fileName.md)
- [This is nav](/fileName.md)
- [This is nav](/fileName.md)
</NavColumn>

<NavColumn>
<ColumnTitle>Column title</ColumnTitle>
- [This is nav](/fileName.md)
- [This is nav](/fileName.md)
- [This is nav](/fileName.md)
- [This is nav](/fileName.md)
</NavColumn>
</NavColumns>

Authors

PingCAP FE

lilianzhu / website-docs