Google Git
Sign in
apache / streampipes-website / 1cf8d0255ccb57e6758fe66ba2a7488cfae2707f
commit1cf8d0255ccb57e6758fe66ba2a7488cfae2707f[log] [tgz]
authordependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>Wed Jan 11 23:05:37 2023 +0100
committerGitHub <noreply@github.com>Wed Jan 11 23:05:37 2023 +0100
tree76e9ee773564d9e033eaa604e2d537968ddedec0
parent7de180c4194aacf1efe8dcae10317ddaf1e65069 [diff]
Bump ejs from 3.1.3 to 3.1.7 (#49)

Bumps [ejs](https://github.com/mde/ejs) from 3.1.3 to 3.1.7.
- [Release notes](https://github.com/mde/ejs/releases)
- [Changelog](https://github.com/mde/ejs/blob/main/CHANGELOG.md)
- [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>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2 files changed
tree: 76e9ee773564d9e033eaa604e2d537968ddedec0
  1. .github/
  2. documentation/
  3. nginx_config/
  4. website/
  5. .asf.yaml
  6. .gitignore
  7. .htaccess
  8. CONTRIBUTING.md
  9. Dockerfile
  10. LICENSE
  11. package-lock.json
  12. package.json
  13. 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.