diff --git a/antora.yml b/antora.yml index b862577d9..1263a61c3 100644 --- a/antora.yml +++ b/antora.yml @@ -29,6 +29,9 @@ asciidoc: end-of-life: false # use the attributes below to link to the CRD docs crd-docs-base-url: "https://crds.stackable.tech" + # used by the operator index pages, see the + # operator-link-bar.adoc partial in the ROOT module + hub-base-url: "https://hub.stackable.tech" crd-docs: "{crd-docs-base-url}/{crd-docs-version}" # to make attributes accessible to the UI template, they need to # be prefixed with "page-" diff --git a/modules/ROOT/partials/operator-link-bar.adoc b/modules/ROOT/partials/operator-link-bar.adoc new file mode 100644 index 000000000..ea16a26bd --- /dev/null +++ b/modules/ROOT/partials/operator-link-bar.adoc @@ -0,0 +1,16 @@ +// Shared link bar for operator index pages. +// +// Usage in an operator's index.adoc: +// +// :github: https://github.com/stackabletech/airflow-operator/ +// :crd: {crd-docs-base-url}/airflow-operator/{crd-docs-version}/ +// :hub: {hub-base-url}/components/airflow +// +// include::ROOT:partial$operator-link-bar.adoc[] +// +// Every entry is optional: pages that don't define an attribute don't render +// its entry (e.g. the internal operators have no Hub component page). +[.link-bar] +ifdef::github[* {github}[GitHub {external-link-icon}^]] +ifdef::crd[* {crd}[CRD documentation {external-link-icon}^]] +ifdef::hub[* {hub}[Stackable Hub {external-link-icon}^]]