commit | 2930f81a4cbc30a7579a406d745a30823db11662 | [log] [tgz] |
---|---|---|
author | Dominik Riemer <riemer@fzi.de> | Tue Apr 27 13:54:28 2021 +0200 |
committer | Dominik Riemer <riemer@fzi.de> | Tue Apr 27 13:54:28 2021 +0200 |
tree | 95ac13c6e59f2b762c39a61c7ad4c61b57f0f72a | |
parent | b1f02acac19c1f2ffec9c59a7abbf2fde4de1b34 [diff] |
[STREAMPIPES-197] Add documentation for StreamPipes Connect
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
.