commit	ac0f2db40154302921731a1cac46e6cef1d8bdd5	[log] [tgz]
author	dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>	Mon Dec 12 19:03:39 2022 +0100
committer	GitHub <noreply@github.com>	Mon Dec 12 19:03:39 2022 +0100
tree	d68ffa73c8e0593024d7276483037dbed0b97df4
parent	331616941d425b75543891ab8e331c206bed64f5 [diff]

tree: d68ffa73c8e0593024d7276483037dbed0b97df4

README.md

Apache StreamPipes Website + Docs

Intro

This repository includes the website and documentation of Apache StreamPipes on https://streampipes.apache.org. Two different technologies are used to create both sites:

The website uses harp.js to create static pages from ejs files.
The documentation uses Docusaurus to create a versioned documentation.

Both parts are merged to a single directory during the CI process.

Node.js and npm are required to build both sites.

Build & run website

Run npm install from the root directory of this repository.
Run npm run start-website to start the website locally for debugging purposes. The content will be served on port 9000.
Run npm run build-website to build the website. This will create a folder build that contains the generated static HTML and asset files.

Build Documentation

Run npm install from the documentation/website directory.
Run npm run start to start the documentation for debugging purposes. The content will be served on http://localhost:3000/docs
Run npm run build to build the documentation This will create a folder build/streampipes-docs that includes all required static files.
Run npm run ds-version NEW_VERSION to release a new docs version.

Deploy

First, build the website as explained above.
Then, build the documentation as explained above.
Copy the content from the generated documentation (content from streampipes-docs) to the build folder into a subdirectory named docs.