Google Git
Sign in
apache / streampipes-website / 82465fde65b22b4050cc65d3f3605fe4fa9ce2db
commit82465fde65b22b4050cc65d3f3605fe4fa9ce2db[log] [tgz]
authordependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>Mon Mar 25 10:14:59 2024 +0100
committerGitHub <noreply@github.com>Mon Mar 25 10:14:59 2024 +0100
tree2a743cb048895d6ddb79d176f07e8c921b32a002
parentfda714db4e58d185dc85c9ba9035c82ea0c6f578 [diff]
Bump follow-redirects from 1.15.4 to 1.15.6 in /website-v2 (#157)

Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.15.4 to 1.15.6.
- [Release notes](https://github.com/follow-redirects/follow-redirects/releases)
- [Commits](https://github.com/follow-redirects/follow-redirects/compare/v1.15.4...v1.15.6)

---
updated-dependencies:
- dependency-name: follow-redirects
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
1 file changed
tree: 2a743cb048895d6ddb79d176f07e8c921b32a002
  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.