PingCAP Docsite Preview Help

Deploy your website using Vercel

This document describes how to deploy your documentation website using Vercel.

Steps

  1. Log in to Vercel.

  2. In the Overview page, click Add New... > Project.

  3. In the Import Git Repository page, search for your fork (pingcap-docsite-preview) and click Import.

  4. In the Configure Project page, fill in the following information:

    • Root Directory: leave it as ./

    • Build and Output Settings > Build Command: ./build.sh

    • Build and Output Settings > Output Directory: website-docs/public

  5. Click Deploy.

  6. After approximately 5 minutes, the website is deployed. You can get the preview URL from your Vercel project page.

    Note

    Each time you create a new branch or commit new changes in your fork, Vercel automatically deploys the branch to a preview environment. You can get preview URLs in the Deployments page of your Vercel project.

    For more information, see Vercel documentation.

      Last modified: 01 April 2025