feat: Link the CRD reference on the Stackable Hub#888
Open
lfrancke wants to merge 1 commit into
Open
Conversation
✅ Deploy Preview for stackable-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
The docs' own pages now link https://hub.stackable.tech/crds instead of the old CRD browser on crds.stackable.tech, using the new attributes: crd-ref: the listing {crd-ref}/<group>/<apiVersion>/<kind>{crd-ref-release}: a deep link crd-ref-release is ?release=dev on this branch and gets the release number on release branches (like crd-docs-version today). The old crd-docs attributes stay until the operator repos migrate their deep links to crd-ref (they do so in the planned operator sweep, one PR per repo). page-crd-docs is removed: nothing in the UI templates reads it. The OIDC provider deep link loses its per-property anchor: the Hub has section-level anchors only, so it points at #provider now.
lfrancke
force-pushed
the
feat/crd-links-to-hub
branch
from
3e4086e to
b9dc3c4
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Our Hub now uses a similar URL style to the old CRD browser which means we can switch the docs to use the Hub instead of the old one.
To help with that there are new attributes in
antora.yml:crd-ref- the listing (https://hub.stackable.tech/crds){crd-ref}/<group>/<apiVersion>/<kind>{crd-ref-release}- a deep linkcrd-ref-release-?release=devon main, the release number on release branches (same mechanism ascrd-docs-versiontoday)Converted: the reference nav entry, the landing page link, and the five deep links (AuthenticationClass ×3, S3Bucket, S3Connection).
Deliberately unchanged
crd-docs-*attributes stay: the operator repos still build their deep links from them (~40 links). We need to update those separately :( (I'll do it...)page-crd-docsis removed - nothing in the UI templates reads it.