agrobbin / risingwave-docs

The official user documentation of RisingWave

RisingWave user documentation

This repository contains the source content for the RisingWave user documentation. The content is published to the docs website by Docusaurus 2.

Contribute to RisingWave user docs

To help us improve the RisingWave user documentation, you may:

• Open a GitHub issue to let us know if anything is incorrect or inaccurate.
• Submit a pull request with the proposed changes.

If you are not familiar with writing and formatting on GitHub, get started by reading Basic writing and formatting syntax on GitHub.

Test locally

If you would like to view your changes on the docs locally before submitting a pull request:

1. If you don't have yarn in your local machine, run npm i -g yarn to install it.

2. Open the risingwave-docs repo in terminal and run:

   yarn
   yarn start

3. The rendered docs will open in your browser automatically.

Visit our official doc site

Check out the published user docs at RisingWave Docs.