commit	ee621083e302c989febe47701d56b9df6bcc7ee9	[log] [tgz]
author	Philipp Zehnder <tenthe@users.noreply.github.com>	Tue May 06 16:06:42 2025 +0200
committer	Philipp Zehnder <tenthe@users.noreply.github.com>	Tue May 06 16:06:42 2025 +0200
tree	a5b2876a048f30a5858c0830193047bca4cd1df0
parent	071fd1e29f7ca1943fd4a571c8a3c982aa1acd89 [diff]
parent	db4f6b20244f2b251980abf69e6461611e84f3cf [diff]

tree: a5b2876a048f30a5858c0830193047bca4cd1df0

README.md

Apache StreamPipes Website + Docs

Intro

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

Run npm install from the website-v2 directory by first running cd ./website-v2.
Run npm run start to start the documentation for debugging purposes. The content will be served on http://localhost:3000
Run npm run build to build the documentation This will create a folder website-v2/build that includes all required static files.
Run npm run ds-version NEW_VERSION to release a new docs version.

Deploy

First, build the website and documentation as explained above.
Copy the content from the docs-python to the website-v2/build folder into a subdirectory named python.

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.