Apache StreamPipes Website + Docs
This repository includes the website and documentation of Apache StreamPipes on https://streampipes.apache.org. Two different technologies are used to create both sites:
- The website & documentation uses Docusaurus to create a versioned documentation.
- The Python docs are auto-generated from the main code repo using MkDocs.
Both parts are merged to a single directory during the CI process.
Node.js(at most v18) and npm are required to build the documentation.
Build Website & Documentation
npm installfrom the
website-v2directory by first running
npm run startto start the documentation for debugging purposes. The content will be served on
npm run buildto build the documentation This will create a folder
website-v2/buildthat includes all required static files.
npm run ds-version NEW_VERSIONto release a new docs version.
- First, build the website and documentation as explained above.
- Copy the content from the
website-v2/buildfolder into a subdirectory named
The deployment step is done automatically using the asf.yaml process.
Code must be merged into the
master branch in order to trigger an update of the website.