Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,12 @@

https://crds.stackable.tech/

## Building
## Building & Running

run `make`, the site is generated in the `site` directory.
First run `git submodule update --init` to pull the `crddocs-generator`.

Afterwards run `make`, the site is generated in the `site` directory.
To access the rendered contents use `make serve`.

Generated with https://github.com/stackabletech/crddocs-generator (have a look there for how it works).

Expand All @@ -27,10 +30,15 @@ There was a slight modification for navbar alignment.

### How to add a new platform release

The docs are built for all the repos and branches configured in the `repos.yaml` file.
so if this file is updated and merged into main, the automated Netlify build will automatically build
new documentation for any changes. Instructions:
The docs are built for all the repos configured in the `repos.yaml` file. The
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For this line onwards the one-sentence-per-line rule gets ignored

list of versions is auto-discovered from GitHub at build time: all calver tags
(`YY.M.P`) on each repo are listed and only the latest patch per `YY.M`
release line is kept (e.g. `24.11.0` is hidden once `24.11.1` exists).
`nightly` (tracking `main`) is always included.

A new SDP release therefore only needs the operator repos to be tagged on
GitHub — no change to `repos.yaml` is required. Trigger the "Trigger Netlify
build hook" GitHub action (or wait for the next build) to pick it up.

- Add the new {major}.{minor}.{patch} version for all `repos` as well as a `platformVersion` to the `repos.yaml` file.
- Merge these changes into main.
- Wait 5 minutes for the Netlify build to update the page. You can also manually run the "Trigger Netlify build hook" GitHub action to trigger a build.
To add or remove a repo from the site, edit the flat list in `repos.yaml` and
merge to main.
247 changes: 19 additions & 228 deletions repos.yaml
Original file line number Diff line number Diff line change
@@ -1,230 +1,21 @@
---
# Tags per repo are auto-discovered from GitHub at build time:
# all calver tags (YY.M.P) are listed and only the latest patch per
# YY.M release line is kept. `nightly` (tracking main) is always added.
repos:
airflow-operator:
- "26.3.0"
- "25.11.0"
- "25.7.0"
- "25.3.0"
- "24.11.1"
- "24.11.0"
- "24.7.0"
- "24.3.0"
- "23.11.0"
- "23.7.0"
- "23.4.1"
- "23.1.0"
- "nightly"
druid-operator:
- "26.3.0"
- "25.11.0"
- "25.7.0"
- "25.3.0"
- "24.11.1"
- "24.11.0"
- "24.7.0"
- "24.3.0"
- "23.11.0"
- "23.7.0"
- "23.4.1"
- "23.1.0"
- "nightly"
hbase-operator:
- "26.3.0"
- "25.11.0"
- "25.7.0"
- "25.3.0"
- "24.11.1"
- "24.11.0"
- "24.7.0"
- "24.3.0"
- "23.11.0"
- "23.7.0"
- "23.4.1"
- "23.1.0"
- "nightly"
hdfs-operator:
- "26.3.0"
- "25.11.0"
- "25.7.0"
- "25.3.0"
- "24.11.1"
- "24.11.0"
- "24.7.0"
- "24.3.0"
- "23.11.0"
- "23.7.0"
- "23.4.1"
- "23.1.0"
- "nightly"
hive-operator:
- "26.3.0"
- "25.11.0"
- "25.7.0"
- "25.3.0"
- "24.11.1"
- "24.11.0"
- "24.7.0"
- "24.3.0"
- "23.11.0"
- "23.7.0"
- "23.4.1"
- "23.1.0"
- "nightly"
kafka-operator:
- "26.3.0"
- "25.11.0"
- "25.7.0"
- "25.3.0"
- "24.11.1"
- "24.11.0"
- "24.7.0"
- "24.3.0"
- "23.11.0"
- "23.7.0"
- "23.4.1"
- "23.1.0"
- "nightly"
nifi-operator:
- "26.3.0"
- "25.11.0"
- "25.7.0"
- "25.3.0"
- "24.11.1"
- "24.11.0"
- "24.7.0"
- "24.3.0"
- "23.11.0"
- "23.7.0"
- "23.4.1"
- "23.1.0"
- "nightly"
opensearch-operator:
- "26.3.0"
- "25.11.0"
- "nightly"
spark-k8s-operator:
- "26.3.0"
- "25.11.0"
- "25.7.0"
- "25.3.0"
- "24.11.1"
- "24.11.0"
- "24.7.0"
- "24.3.0"
- "23.11.0"
- "23.7.0"
- "23.4.1"
- "23.1.0"
- "nightly"
superset-operator:
- "26.3.0"
- "25.11.0"
- "25.7.0"
- "25.3.0"
- "24.11.1"
- "24.11.0"
- "24.7.0"
- "24.3.0"
- "23.11.0"
- "23.7.0"
- "23.4.1"
- "23.1.0"
- "nightly"
trino-operator:
- "26.3.0"
- "25.11.0"
- "25.7.0"
- "25.3.0"
- "24.11.1"
- "24.11.0"
- "24.7.0"
- "24.3.0"
- "23.11.0"
- "23.7.0"
- "23.4.1"
- "23.1.0"
- "nightly"
zookeeper-operator:
- "26.3.0"
- "25.11.0"
- "25.7.0"
- "25.3.0"
- "24.11.1"
- "24.11.0"
- "24.7.0"
- "24.3.0"
- "23.11.0"
- "23.7.0"
- "23.4.1"
- "23.1.0"
- "nightly"
opa-operator:
- "26.3.0"
- "25.11.0"
- "25.7.0"
- "25.3.0"
- "24.11.1"
- "24.11.0"
- "24.7.0"
- "24.3.0"
- "23.11.0"
- "23.7.0"
- "23.4.1"
- "23.1.0"
- "nightly"
commons-operator:
- "26.3.0"
- "25.11.0"
- "25.7.0"
- "25.3.0"
- "24.11.1"
- "24.11.0"
- "24.7.0"
- "24.3.0"
- "23.11.0"
- "23.7.0"
- "23.4.1"
- "23.1.0"
- "nightly"
secret-operator:
- "26.3.0"
- "25.11.0"
- "25.7.0"
- "25.3.0"
- "24.11.1"
- "24.11.0"
- "24.7.0"
- "24.3.0"
- "23.7.0"
- "23.4.1"
- "23.1.0"
- "nightly"
listener-operator:
- "26.3.0"
- "25.11.0"
- "25.7.0"
- "25.3.0"
- "24.11.1"
- "24.11.0"
- "24.7.0"
- "24.3.0"
- "23.11.0"
- "23.7.0"
- "23.4.1"
- "23.1.0"
- "nightly"

platformVersions:
- "26.3.0"
- "25.11.0"
- "25.7.0"
- "25.3.0"
- "24.11.1"
- "24.11.0"
- "24.7.0"
- "24.3.0"
- "23.11.0"
- "23.7.0"
- "23.4.1"
- "23.1.0"
- "nightly"
- airflow-operator
- druid-operator
- hbase-operator
- hdfs-operator
- hive-operator
- kafka-operator
- nifi-operator
- opensearch-operator
- spark-k8s-operator
- superset-operator
- trino-operator
- zookeeper-operator
- opa-operator
- commons-operator
- secret-operator
- listener-operator
9 changes: 9 additions & 0 deletions shell.nix
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
pkgs ? import <nixpkgs> { },
}:
pkgs.mkShell {
nativeBuildInputs = with pkgs; [
sqlite
go
];
}