Skip to content

docs: Point the CRD links at the Stackable Hub - #864

Open
lfrancke wants to merge 1 commit into
mainfrom
docs/crd-links-to-hub
Open

lfrancke wants to merge 1 commit into
mainfrom
docs/crd-links-to-hub

Conversation

@lfrancke

@lfrancke lfrancke commented Sep 15, 2026

Copy link
Copy Markdown
Member

Description

This is the first PR - it'll be rolled out across all operators if this is accepted.
In a previous PR we introduced the necessary variables in the documentation repo.

I commented on this PR so you can see the rendered links.

Definition of Done Checklist

  • Not all of these items are applicable to all PRs, the author should update this template to only leave the boxes in that are relevant
  • Please make sure all these things are done and tick the boxes

Author

  • Changes are OpenShift compatible
  • CRD changes approved
  • CRD documentation for all fields, following the style guide.
  • Helm chart can be installed and deployed operator works
  • Integration tests passed (for non trivial changes)
  • Changes need to be "offline" compatible
  • Links to generated (nightly) docs added
  • Release note snippet added

Reviewer

  • Code contains useful comments
  • Code contains useful logging statements
  • (Integration-)Test cases added
  • Documentation added or updated. Follows the style guide.
  • Changelog updated
  • Cargo.toml only contains references to git tags (not specific commits or branches)

Acceptance

  • Feature Tracker has been updated
  • Proper release label has been added
  • Links to generated (nightly) docs added
  • Release note snippet added
  • Add type/deprecation label & add to the deprecation schedule
  • Add type/experimental label & add to the experimental features tracker

= CRD Reference

Find all CRD reference for the Stackable Operator for Apache Airfow at: {crd-docs-base-url}/airflow-operator/{crd-docs-version}.
Find all CRD reference for the Stackable Operator for Apache Airfow at: {crd-ref}{crd-ref-release}&operator=airflow-operator.

@lfrancke lfrancke Sep 15, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

crd-ref = https://hub.stackable.tech/crds
crd-ref-release = ?release=dev

So it'll go to https://hub.stackable.tech/crds?release=dev&operator=airflow-operator

"release=dev" will be replaced with the correct version of the branch we're looking at.

TLS verification for the authentication connection cannot be disabled; the operator rejects an AuthenticationClass that turns it off.

You can follow the xref:tutorials:authentication_with_openldap.adoc[] tutorial to learn how to set up an AuthenticationClass for an LDAP server, as well as consulting the {crd-docs}/authentication.stackable.tech/authenticationclass/v1alpha1/[AuthenticationClass reference {external-link-icon}^].
You can follow the xref:tutorials:authentication_with_openldap.adoc[] tutorial to learn how to set up an AuthenticationClass for an LDAP server, as well as consulting the {crd-ref}/authentication.stackable.tech/v1alpha1/authenticationclass{crd-ref-release}[AuthenticationClass reference {external-link-icon}^].

@lfrancke lfrancke Sep 15, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

:github: https://github.com/stackabletech/airflow-operator/
:crd: {crd-docs-base-url}/airflow-operator/{crd-docs-version}/
:crd-airflowcluster: {crd-docs}/airflow.stackable.tech/airflowcluster/v1alpha2/
:crd: {crd-ref}{crd-ref-release}&operator=airflow-operator

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

:crd: {crd-docs-base-url}/airflow-operator/{crd-docs-version}/
:crd-airflowcluster: {crd-docs}/airflow.stackable.tech/airflowcluster/v1alpha2/
:crd: {crd-ref}{crd-ref-release}&operator=airflow-operator
:crd-airflowcluster: {crd-ref}/airflow.stackable.tech/v1alpha2/airflowcluster{crd-ref-release}

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@lfrancke
lfrancke marked this pull request as ready for review September 15, 2026 21:07
@lfrancke lfrancke moved this to Development: Waiting for Review in Stackable Engineering Sep 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Development: Waiting for Review

Development

Successfully merging this pull request may close these issues.

1 participant