Google Git
Sign in
apache / streampipes-website / 9587b10ae4c72795720d9b2dbb497d8bdcac7aef
commit9587b10ae4c72795720d9b2dbb497d8bdcac7aef[log] [tgz]
authorStefan Obermeier <obermeier@apache.org>Wed Nov 15 11:51:06 2023 +0100
committerGitHub <noreply@github.com>Wed Nov 15 11:51:06 2023 +0100
tree4bb38f3a6e6a1939f746812e3ded90e4930f1a65
parent2b1624198a3a9293dc9e69434101ea1a25397e36 [diff]
Provide 'User Guide' page on /docs (#132)
8 files changed
tree: 4bb38f3a6e6a1939f746812e3ded90e4930f1a65
  1. .github/
  2. docs/
  3. docs-python/
  4. nginx_config/
  5. website-v2/
  6. .asf.yaml
  7. .gitignore
  8. .htaccess
  9. CONTRIBUTING.md
  10. Dockerfile
  11. LICENSE
  12. README.md
README.md

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.

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.