commit	9b0ecc42ed8a1a401eaf79b54db7887b5fc2f264	[log] [tgz]
author	dominikriemer <dominikriemer@users.noreply.github.com>	Sat Dec 21 04:04:02 2024 +0000
committer	GitHub <noreply@github.com>	Sat Dec 21 04:04:02 2024 +0000
tree	f9e2fda504b1e831b9b0148db1d7bb284a7332c9
parent	c62ac54d7819c28ae2adf8ae3c55ae1023335ccb [diff]

tree: f9e2fda504b1e831b9b0148db1d7bb284a7332c9

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.