Skip to content

feat: Shared link bar partial for operator index pages #872

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lfrancke wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: Shared link bar partial for operator index pages #872

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions antora.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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-"
Expand Down
16 changes: 16 additions & 0 deletions modules/ROOT/partials/operator-link-bar.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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}^]]
Loading