commit | efe4be2efd21cb663fe9437fb3a942da5eb8b1e0 | [log] [tgz] |
---|---|---|
author | Tim <50115603+bossenti@users.noreply.github.com> | Mon Oct 23 21:06:51 2023 +0200 |
committer | GitHub <noreply@github.com> | Mon Oct 23 21:06:51 2023 +0200 |
tree | 2c2017b136bdd3e234b049185af68c259f0f9d30 | |
parent | ca670dc4c859dfab12a4022c1ba4608959cfa93e [diff] |
Update adapter tutorial (#124) * docs: update general description of streampipes concepts * docs: describe first steps of adapter creation * docs: change heading * small update * add section about UI configuration of adapters * remove unused code * Fix minor typo * Backport concept overview to 0.92.0 --------- Co-authored-by: Dominik Riemer <dominik.riemer@gmail.com>
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.