Apache StreamPipes Website

Clone this repo:
  1. f63b4a6 add videos for apachecon 2020 by Patrick Wiener · 3 days ago dev
  2. 5e6ba9f Merge remote-tracking branch 'refs/remotes/origin/dev' into dev by Patrick Wiener · 11 days ago
  3. 67d2eef add upcoming talks and slides for apachecon home 2020 by Patrick Wiener · 11 days ago
  4. bd6d748 [HOTFIX] Website URL by Johannes Tex · 4 weeks ago
  5. 9c1d02b [hotfix] add refactored version of streampipes overview by Patrick Wiener · 7 weeks ago

Github Actions

Apache StreamPipes (incubating) Website + Docs

Intro

This repository includes the website and documentation of Apache StreamPipes (incubating) 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.