diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml new file mode 100644 index 0000000000000..724400e2c29c5 --- /dev/null +++ b/.github/workflows/doc.yml @@ -0,0 +1,37 @@ +name: Deploy Developer Docs + +on: + push: + branches: + - main + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions-rs/toolchain@v1 + - name: Install dependencies + run: sudo apt install make build-essential cmake protobuf-compiler curl openssl libssl-dev libcurl4-openssl-dev pkg-config postgresql-client tmux lld + - name: Docs + run: | + RUSTDOCFLAGS="--markdown-css rust.css --markdown-no-toc --index-page docs/index.md -Zunstable-options" cargo doc --workspace --no-deps --document-private-items + cp docs/rust.css target/doc/rust.css + - name: Upload artifacts + uses: actions/upload-pages-artifact@v1 + with: + path: target/doc + + deploy: + needs: build + permissions: + pages: write # to deploy to Pages + id-token: write # to verify the deployment originates from an appropriate source + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v1 diff --git a/docs/developer-guide.md b/docs/developer-guide.md index 6f47556f8e0da..7f304e9e9d340 100644 --- a/docs/developer-guide.md +++ b/docs/developer-guide.md @@ -46,6 +46,8 @@ To report bugs, create a [GitHub issue](https://github.com/risingwavelabs/rising Before you start to make code changes, ensure that you understand the design and implementation of RisingWave. We recommend that you read the design docs listed in [docs/README.md](README.md) first. +You can also read the [crate level documentation](https://risingwavelabs.github.io/risingwave/) for implementation details. You can also run `./risedev doc` to read it locally. Note that you need to [set up the development environment](#set-up-the-development-environment) first. + ## Learn about the code structure - The `src` folder contains all of the kernel components, refer to [src/README.md](../src/README.md) for more details.