Usage Guide

Steps to preview document changes

Expand to view the flowchart.

To preview document changes, perform the following steps:

1. Fork the pingcap-docsite-preview repository.

2. Update the scaffold of PingCAP documentation website, including version selection, table of contents, index pages, and the homepage.

   For more information, see Update scaffold.

3. Update the documentation content you want to preview.

   For more information, see Update content.

4. Deploy the preview website either locally or on a static hosting service.

   For more information, see Deploy your website.

Notes

• Fork pingcap-docsite-preview to your GitHub account first.

• Ensure your fork remains synchronized with the upstream repository.

• Avoid updating the main branch of your fork. This helps prevent conflicts with the upstream repository.