Apache StreamPipes Website

Clone this repo:
  1. 2ecd232 docs: Bring UI customization page to the latest state by Dominik Riemer · 3 weeks ago dev
  2. fcc2aaf feat: Add all-in-one image to quick start guide (#241) by Dominik Riemer · 3 weeks ago
  3. 41dc608 docs: Remove old python versions, add redirects, add descriptions (#240) by Dominik Riemer · 3 weeks ago
  4. 8564e6c docs audit logging (#239) by Jacqueline Höllig · 3 weeks ago
  5. 2a63feb docs: Added ToddySoft to the Get Help page. (#238) by Christofer Dutz · 3 weeks ago

Github Actions

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 & documentation uses Docusaurus to create a versioned documentation.
  • The Python docs are auto-generated from the main code repo using MkDocs.

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.

Build Website & Documentation

  • Run npm install from the website-v2 directory by first running cd ./website-v2.
  • Run npm run start to start the documentation for debugging purposes. The content will be served on http://localhost:3000
  • Run npm run build to build the documentation This will create a folder website-v2/build that includes all required static files.
  • Run npm run ds-version NEW_VERSION to release a new docs version.
  • Python docs: the update-python-docs workflow only refreshes docs-python/dev. For a release, copy the built docs to docs-python/NEW_VERSION, add the version to docs-python/versions.json with the latest alias, and replace both docs-python/latest and the unversioned files in docs-python/ with a copy of the new version (every page's canonical URL points to latest).
  • Pipeline element docs are synced from the main repo by update-extensions-docs; run node scripts/add-pe-descriptions.js in website-v2 afterwards to restore the meta descriptions.

Deploy

  • First, build the website and documentation as explained above.
  • Copy the content from the 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.