Skip to content

Commit fca415e

Browse files
committed
feat: Shared link bar partial for operator index pages
Operator index pages define their links as page attributes and include ROOT:partial$operator-link-bar.adoc; the bar itself is maintained here instead of copy-pasted in 13 repos. Adds an optional Stackable Hub entry linking to the operator's component page on https://hub.stackable.tech. The Feature Tracker URL moves to antora.yml (feature-tracker), next to a new hub-base-url attribute, so future URL changes are one line here instead of one PR per operator repo.
1 parent 4cfc9c7 commit fca415e

2 files changed

Lines changed: 22 additions & 0 deletions

File tree

antora.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@ asciidoc:
2929
end-of-life: false
3030
# use the attributes below to link to the CRD docs
3131
crd-docs-base-url: "https://crds.stackable.tech"
32+
# links shared by the operator index pages, see the
33+
# operator-link-bar.adoc partial in the ROOT module
34+
feature-tracker: "https://features.stackable.tech/unified"
35+
hub-base-url: "https://hub.stackable.tech"
3236
crd-docs: "{crd-docs-base-url}/{crd-docs-version}"
3337
# to make attributes accessible to the UI template, they need to
3438
# be prefixed with "page-"
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
// Shared link bar for operator index pages.
2+
//
3+
// Usage in an operator's index.adoc:
4+
//
5+
// :github: https://github.com/stackabletech/airflow-operator/
6+
// :crd: {crd-docs-base-url}/airflow-operator/{crd-docs-version}/
7+
// :hub: {hub-base-url}/components/airflow
8+
//
9+
// include::ROOT:partial$operator-link-bar.adoc[]
10+
//
11+
// {feature-tracker} is defined centrally in antora.yml. Every entry is
12+
// optional: unset an attribute on the page (e.g. :!feature-tracker: for the
13+
// internal operators) and its entry disappears.
14+
[.link-bar]
15+
ifdef::github[* {github}[GitHub {external-link-icon}^]]
16+
ifdef::feature-tracker[* {feature-tracker}[Feature Tracker {external-link-icon}^]]
17+
ifdef::crd[* {crd}[CRD documentation {external-link-icon}^]]
18+
ifdef::hub[* {hub}[Stackable Hub {external-link-icon}^]]

0 commit comments

Comments
 (0)