Overview
pingcap-docsite-preview is a tool designed for previewing changes to PingCAP documentation website before merging pull requests. It enables you to:
Validate document updates without affecting the official website.
Collaborate with reviewers by sharing a preview link.
Verify the accurate rendering of changes before merging them into the production website.
Achieve consistent preview results that match the official website.
Key features
Ease of use: preview a PR by simply creating a new branch.
Cross-repository preview: simultaneously preview changes from multiple PRs across different repositories.
Centralized preview schedule management: organize and manage preview schedules in a unified workflow.
Customizability: customize the preview process to meet your requirements.
Scope
pingcap-docsite-preview supports previewing documentation for TiDB, TiDB Cloud, and TiDB Operator. You can preview PRs from the following repositories:
Usage scenarios
Steps to preview document changes
- Expand to view the flowchart.
To preview document changes, perform the following steps:
Fork the
pingcap-docsite-previewrepository.Update the scaffold of PingCAP documentation website, including version selection, table of contents, index pages, and the homepage.
For more information, see Update scaffold.
Update the documentation content you want to preview.
For more information, see Update content.
Deploy the preview website either locally or on a static hosting service.
For more information, see Deploy your website.