commit | 73c6f1a673944791c26cb5af7cfeb0567bc89d0a | [log] [tgz] |
---|---|---|
author | Rohan Udupa <86579136+lab596@users.noreply.github.com> | Sat Sep 09 01:57:14 2023 -0700 |
committer | GitHub <noreply@github.com> | Sat Sep 09 10:57:14 2023 +0200 |
tree | b74418a2db87cd14f835dd0ff1fb51c6609562f2 | |
parent | bdce98e55f7c6b37f15c86e27e527e67ef38dc25 [diff] |
Updating CLI Documentation (#105) * updating beginner documentation * Update README.md
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.