commit | d7ecb6c4c8141000bc181769ab68e9a14130f3f1 | [log] [tgz] |
---|---|---|
author | Dominik Riemer <dominik.riemer@gmail.com> | Wed Jul 19 10:24:26 2023 +0200 |
committer | Dominik Riemer <dominik.riemer@gmail.com> | Wed Jul 19 10:24:26 2023 +0200 |
tree | 5a0369b521538475608c8f65d0698dc220b8255e | |
parent | 9200df4ace7c626e8209ad7634c25b97255cbda4 [diff] |
Add StreamPipes client documentation
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 and npm are required to build the documentation.
npm install
from the website-v2
directory.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.