This repo holds the source code for the StreamsHub site.
This site aggregates documentation from all the StreamsHub components.
Each component's documentation source and the versions which are included are configured via an entry in the sources.json file in the repository root:
{
"name": "Flink SQL Runner",
"sourceOwner": "streamshub",
"sourceRepository": "flink-sql",
"developmentBranch": "docs-dev",
"docsFolderPath": "docs",
"tags":["0.2.0"]
}This file is read by the scripts/docBuilder.java jbang script.
You will need to install jbang locally in order to run the documentation build.
The contents of the docsFolderPath in each <sourceOwner>/<sourceRepository> GitHub repository at each supplied reference tag will be pulled and placed in their own folder under content/docs/<name>/<tag>.
If a folder already exists for the given tag then it will not be pulled.
The contents of the docsFolderPath folder on the developmentBranch will always be pulled on every build via the .github/workflows/publish.yaml GitHub Action.
A contents file will be generated for each entry in the source.json.
This will contain links to the documentation for the development branch and each of the configured tags.
You can skip this if you only want to have one version of the docs (just the development branch) by setting the skipContentsPageCreation key to true.
To pull the configured sources locally you will need a GitHub access token with permissions to access all the configured <sourceOwner>/<sourceRepository>:
./scripts/docBuilder.java <github-access-token>The site uses the hugo static site generator. You will need to install a recent release (the version in your package manager is probably too old) and the PostCSS packages in order to build the source.
You will also need asciidoctor installed to build most of the documentation pages.
You can build the site by running hugo from the repository root.
Or run a live preview server by running:
hugo server --buildDrafts --disableFastRender