Google Git
Sign in
apache / streampipes-website / d90ed448e051d538e6dfb5739b09f3b0db73e4f6
commitd90ed448e051d538e6dfb5739b09f3b0db73e4f6[log] [tgz]
authorTim <50115603+bossenti@users.noreply.github.com>Thu May 16 11:17:18 2024 +0200
committerGitHub <noreply@github.com>Thu May 16 11:17:18 2024 +0200
tree95ce2bfaf33f4d165318a8c6f9832917be24b28b
parentc0a7f0583e7190214da4c5eee097bf3a9ef728e6 [diff]
docs: remove existing consul references (#172)
4 files changed
tree: 95ce2bfaf33f4d165318a8c6f9832917be24b28b
  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.