Important note

This repository will serve as an archive for RisingWave user documentation up to version 2.0. The topics are published to the legacy documentation site.

The latest documentation source files are in the risingwave-docs repository for our documentation source files. This change reflects a shift in our documentation infrastructure.

Contribute to RisingWave user docs

For issues and documentation contribution, please go to the risingwave-docs repository.

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.