commit | d6809819c4d88a44cd27b91432b6188abbc9c56c | [log] [tgz] |
---|---|---|
author | Dominik Riemer <dominik.riemer@gmail.com> | Mon Nov 28 20:44:44 2022 +0100 |
committer | Dominik Riemer <dominik.riemer@gmail.com> | Tue Nov 29 20:46:09 2022 +0100 |
tree | 0ee6585b4a1d91f1daac7035712e20b2d5e035d3 | |
parent | df2851e1cfca74d4e4ff953ba4dce3dd22227975 [diff] |
docs: Add documentation for functions (apache/streampipes#751)
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 both sites.
npm install
from the root directory of this repository.npm run start-website
to start the website locally for debugging purposes. The content will be served on port 9000.npm run build-website
to build the website. This will create a folder build
that contains the generated static HTML and asset files.npm install
from the documentation/website
directory.npm run start
to start the documentation for debugging purposes. The content will be served on http://localhost:3000/docs
npm run build
to build the documentation This will create a folder build/streampipes-docs
that includes all required static files.npm run ds-version NEW_VERSION
to release a new docs version.streampipes-docs
) to the build
folder into a subdirectory named docs
.