commit | 34cfdd7c4dbd33437dea75d88ed4d67f790b62ca | [log] [tgz] |
---|---|---|
author | Dominik Riemer <dominik.riemer@gmail.com> | Fri Nov 17 09:01:40 2023 +0100 |
committer | GitHub <noreply@github.com> | Fri Nov 17 09:01:40 2023 +0100 |
tree | 5bc8645ff9e8f0b899138e35f8a281992f9c7112 | |
parent | 9587b10ae4c72795720d9b2dbb497d8bdcac7aef [diff] |
Add documentation pages for env variables and UI customization (#134)
This repository includes the website and documentation of Apache StreamPipes on https://streampipes.apache.org. Two different technologies are used to create both sites:
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.
npm install
from the website-v2
directory by first running cd ./website-v2
.npm run start
to start the documentation for debugging purposes. The content will be served on http://localhost:3000
npm run build
to build the documentation This will create a folder website-v2/build
that includes all required static files.npm run ds-version NEW_VERSION
to release a new docs version.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.