commit | dcf457b13e690b048cc1c0d2010b9774c1dd2895 | [log] [tgz] |
---|---|---|
author | Cccccrystall <qyang2767@gmail.com> | Sat Oct 28 19:38:16 2023 +0800 |
committer | GitHub <noreply@github.com> | Sat Oct 28 13:38:16 2023 +0200 |
tree | c397df883eb9c5dad40c9a1ad5d4f53f033f2dd5 | |
parent | 0ab70226cb164bf1be67d4ee95af0106f2cd4c47 [diff] |
introduce the quickstart mode user guide (#116) * Instroduce the Quick start mode user guide, make it consist with the full and nats option user guide. * Add Quickstart introduction, user guide and example asset introduction. * Addressed the comments.
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.