Skip to content

Commit bf4bb9a

Browse files
committed
docs: Point CRD reference links at the Stackable Hub
The old CRD browser at crds.stackable.tech is being discontinued in favor of the CRD reference on the Stackable Hub, which ingests the CRDs of every operator automatically. - Update the netlify redirect target for /home/stable/reference/* - Update the contributor guide pages that described the crddocs generation pipeline - Update the README link list The crd-docs-base-url attribute in antora.yml (used by the operator link bars and CRD deep links) is intentionally unchanged: it needs the group/version/kind URL structure on the Hub before it can be switched.
1 parent 3a7a6de commit bf4bb9a

5 files changed

Lines changed: 11 additions & 12 deletions

File tree

README.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,5 +70,5 @@ The design & layout comes from our https://github.com/stackabletech/documentatio
7070
== More useful links
7171

7272
* The https://github.com/stackabletech/documentation-ui[documentation-ui] repository.
73-
* The https://github.com/stackabletech/crddocs[crddocs] repository from which the https://crds.stackable.tech/[CRD reference] is generated.
73+
* The https://hub.stackable.tech/crds[CRD reference] on the Stackable Hub.
7474
* The Stackable https://docs.stackable.tech/home/stable/contributor/[contributor's guide] containing more info on how to contribute to the documentation.
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# CRD documentation
2-
:crds-docs: https://crds.stackable.tech/
3-
:crddocs-repo: https://github.com/stackabletech/crddocs
2+
:crds-docs: https://hub.stackable.tech/crds
3+
:stackable-issues: https://github.com/stackabletech/issues
44

5-
The {crds-docs}[CRD documentation{external-link-icon}^] is generated from the CRD manifest files, which are in turn generated from the operator source code.
5+
The {crds-docs}[CRD reference{external-link-icon}^] on the Stackable Hub is generated from the CRD manifest files, which are in turn generated from the operator source code.
66
All the documentation strings are doc strings in the Rust source code.
77
If you want to contribute documentation for a particular field, this needs to be done in doc string of the property on the struct that makes up that part of the CRD.
88

9-
To change the UI, adjust the HTML template and CSS files in the {crddocs-repo}[crddocs repository{external-link-icon}^].
10-
Also consult the README in that repository to learn more about how the site is generated.
9+
The Hub ingests the CRDs of every operator automatically, so no manual steps are needed to publish the reference.
10+
If you spot a problem with how the reference is rendered, file an issue in the {stackable-issues}[issues repository{external-link-icon}^].

modules/contributor/pages/docs/overview.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,10 @@
55
:antora-zulipchat: https://antora.zulipchat.com/
66
:antora-distributed-components: https://docs.antora.org/antora/latest/distributed-component-version/
77
:antora-content-branches: https://docs.antora.org/antora/latest/playbook/content-branches/
8-
:crddocs-site: https://crds.stackable.tech/
8+
:crd-reference: https://hub.stackable.tech/crds
99
:diataxis: https://diataxis.fr/
1010
:netlify: https://www.netlify.com/
1111
:pagefind: https://pagefind.app/
12-
:stackable-crddocs-repo: https://github.com/stackabletech/crddocs
1312
:stackable-docs-readme: https://github.com/stackabletech/documentation/blob/main/README.adoc
1413
:stackable-docs-repo: https://github.com/stackabletech/documentation
1514
:stackable-docs-ui-repo: https://github.com/stackabletech/documentation-ui
@@ -46,7 +45,7 @@ The guide has to account for different use-cases (i.e. the user is using their o
4645
Since this kind of information is typically product specific, it is located in the usage guide section of individual operators.
4746

4847
**Reference** information for the Stackable platform entails all the settings and Options in our YAMLs, which we generate.
49-
The reference is found at {crddocs-site}[{crddocs-site}{external-link-icon}^] and generated from the {stackable-crddocs-repo}[crddocs repository{external-link-icon}^].
48+
The reference is found at {crd-reference}[{crd-reference}{external-link-icon}^] on the Stackable Hub, which ingests the CRDs of every operator automatically.
5049

5150
=== Style guide
5251

modules/contributor/pages/project-overview.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ The UI for the documentation is found in the https://github.com/stackabletech/do
5656
The documentation pulls in operator documentation files from the operator repositories.
5757
The documentation is found at https://docs.stackable.tech/[https://docs.stackable.tech/{external-link-icon}^].
5858

59-
There is also https://crds.stackable.tech/[https://crds.stackable.tech/{external-link-icon}^] where you can find generated documentation for all the CustomResourceDefinitions on the platform.
60-
The code to generate this page is found in the https://github.com/stackabletech/crddocs[crddocs{external-link-icon}^] repository.
59+
There is also the https://hub.stackable.tech/crds[CRD reference on the Stackable Hub{external-link-icon}^] where you can find generated documentation for all the CustomResourceDefinitions on the platform.
60+
The Hub ingests the CRDs of every operator automatically.
6161

6262
[[tooling-repositories]]
6363
=== Tooling repositories

netlify.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
[[redirects]]
66
from = "/home/stable/reference/*"
7-
to = "https://crds.stackable.tech/"
7+
to = "https://hub.stackable.tech/crds"
88
status = 301
99

1010
[[redirects]]

0 commit comments

Comments
 (0)