Google Git
Sign in
apache / streampipes-website / refs/heads/add-oauth-documentation
commit0d05ebc515723f849f9a17d2ccdbb489db3da06d[log] [tgz]
authorDominik Riemer <dominik.riemer@gmail.com>Tue Aug 06 13:11:52 2024 +0200
committerGitHub <noreply@github.com>Tue Aug 06 13:11:52 2024 +0200
treed3e8d3888d738dcd64265a67970321fc2f8cf892
parent30e20d11bc695ef3b8df87316494ef1bb875c2c3 [diff]
Update docs/05_deploy-security.md

Co-authored-by: Philipp Zehnder <tenthe@users.noreply.github.com>
1 file changed
tree: d3e8d3888d738dcd64265a67970321fc2f8cf892
  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.