Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,28 @@ In order to debug algolia searches, you need to provide two additional environme

Put them in `.env.development` to make them take effect. (Ref: <https://www.gatsbyjs.com/docs/how-to/local-development/environment-variables/>)

## Filesystem Documentation

TiDB Cloud Filesystem appears after TiDB Cloud Lake in the Product menu. Its
English documentation is published at `/tidbcloud-filesystem/` with its own
sidebar and Preview badge.

The source content comes from `pingcap/docs` and is published by
`pingcap/docs-staging` under
`markdown-pages/en/tidb-cloud-filesystem/master/`. The staging tree contains
`tidb-cloud-filesystem/` and `TOC-tidb-cloud-filesystem.md`, and requires a
separate `tidb-cloud-filesystem` entry in the `pingcap/docs-staging`
`docs.json`, similar to TiDB Cloud Lake. After the staging submodule is
updated, that file is available in this checkout as `docs/docs.json`. The
source pages and staging configuration must reach `docs-staging` before a
website deployment can publish them. The menu links to English without
changing the selected Cloud database plan or implying that translated
Filesystem pages exist.

`gatsby/__tests__/filesystem-routing.test.ts` checks published URLs, sidebar
selection, TOC membership, and links to the existing AI command reference.
`gatsby/__tests__/filesystem-header.test.ts` checks menu order and selection.

## Workflow

Because of most of our text data stored in GitHub. It's needed to apply a GitHub API token in development **when you are prompted for `rate-limiting`**.
Expand Down
2 changes: 1 addition & 1 deletion gatsby-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ module.exports = {
{
matchPath: `/:lang?/(${Object.keys(docs.docs).join(
"|"
)}|developer|best-practices|api|ai|releases|tidbcloudlake)/(.*)`,
)}|developer|best-practices|api|ai|releases|tidbcloudlake|tidbcloud-filesystem)/(.*)`,
getLanguageFromPath: true,
},
{
Expand Down
Loading