commit | a721b2a856a32357339d409c1af5a9849e331d55 | [log] [tgz] |
---|---|---|
author | Dominik Riemer <riemer@fzi.de> | Sat May 01 14:26:54 2021 +0200 |
committer | Dominik Riemer <riemer@fzi.de> | Sat May 01 14:26:54 2021 +0200 |
tree | 1e863bdedd057e0494de50b1eecb1ed9934b2c80 | |
parent | be6f66b11ddf1a25e496da165a93dd778a24ce79 [diff] |
[STREAMPIPES-197] Add documentation for pipeline overview
This repository includes the website and documentation of Apache StreamPipes (incubating) 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
.