Google Git
Sign in
apache / streampipes-website / eb8b99244dd4e384d32bd52e5848d881af6dc7ae
commiteb8b99244dd4e384d32bd52e5848d881af6dc7ae[log] [tgz]
authordependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>Sat Apr 29 17:27:14 2023 +0200
committerGitHub <noreply@github.com>Sat Apr 29 17:27:14 2023 +0200
tree0a58bac7bde35f2955b0246f135f028052f8344c
parentba7065d2fd2befaf99eed6a8a1f3b3f9b38266b1 [diff]
Bump ejs from 3.1.3 to 3.1.7 (#77)

Bumps [ejs](https://github.com/mde/ejs) from 3.1.3 to 3.1.7.
- [Release notes](https://github.com/mde/ejs/releases)
- [Commits](https://github.com/mde/ejs/compare/v3.1.3...v3.1.7)

---
updated-dependencies:
- dependency-name: ejs
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2 files changed
tree: 0a58bac7bde35f2955b0246f135f028052f8344c
  1. .github/
  2. docs-python/
  3. documentation/
  4. nginx_config/
  5. website/
  6. .asf.yaml
  7. .gitignore
  8. .htaccess
  9. CONTRIBUTING.md
  10. Dockerfile
  11. LICENSE
  12. package-lock.json
  13. package.json
  14. 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 uses harp.js to create static pages from ejs files.
  • The documentation uses Docusaurus to create a versioned documentation.

Both parts are merged to a single directory during the CI process.

Node.js and npm are required to build both sites.

Build & run website

  • Run npm install from the root directory of this repository.
  • Run npm run start-website to start the website locally for debugging purposes. The content will be served on port 9000.
  • Run npm run build-website to build the website. This will create a folder build that contains the generated static HTML and asset files.

Build Documentation

  • Run npm install from the documentation/website directory.
  • Run npm run start to start the documentation for debugging purposes. The content will be served on http://localhost:3000/docs
  • Run npm run build to build the documentation This will create a folder build/streampipes-docs that includes all required static files.
  • Run npm run ds-version NEW_VERSION to release a new docs version.

Deploy

  • First, build the website as explained above.
  • Then, build the documentation as explained above.
  • Copy the content from the generated documentation (content from streampipes-docs) to the build folder into a subdirectory named docs.