You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: README.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -70,5 +70,5 @@ The design & layout comes from our https://github.com/stackabletech/documentatio
70
70
== More useful links
71
71
72
72
* 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.
74
74
* The Stackable https://docs.stackable.tech/home/stable/contributor/[contributor's guide] containing more info on how to contribute to the documentation.
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.
6
6
All the documentation strings are doc strings in the Rust source code.
7
7
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.
8
8
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}^].
@@ -46,7 +45,7 @@ The guide has to account for different use-cases (i.e. the user is using their o
46
45
Since this kind of information is typically product specific, it is located in the usage guide section of individual operators.
47
46
48
47
**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.
Copy file name to clipboardExpand all lines: modules/contributor/pages/project-overview.adoc
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,8 +56,8 @@ The UI for the documentation is found in the https://github.com/stackabletech/do
56
56
The documentation pulls in operator documentation files from the operator repositories.
57
57
The documentation is found at https://docs.stackable.tech/[https://docs.stackable.tech/{external-link-icon}^].
58
58
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.
0 commit comments