diff --git a/README.adoc b/README.adoc index acbab1514..9043d2bbd 100644 --- a/README.adoc +++ b/README.adoc @@ -70,5 +70,5 @@ The design & layout comes from our https://github.com/stackabletech/documentatio == More useful links * The https://github.com/stackabletech/documentation-ui[documentation-ui] repository. -* The https://github.com/stackabletech/crddocs[crddocs] repository from which the https://crds.stackable.tech/[CRD reference] is generated. +* The https://hub.stackable.tech/crds[CRD reference] on the Stackable Hub. * The Stackable https://docs.stackable.tech/home/stable/contributor/[contributor's guide] containing more info on how to contribute to the documentation. diff --git a/modules/contributor/images/project-overview-documentation.drawio.svg b/modules/contributor/images/project-overview-documentation.drawio.svg index 01858c6d7..e94b63aff 100644 --- a/modules/contributor/images/project-overview-documentation.drawio.svg +++ b/modules/contributor/images/project-overview-documentation.drawio.svg @@ -1,4 +1,134 @@ -
documentation
documentation
documentation-ui
documentation-ui
crddocs
crddocs
Netlify
Netlify
docs.stackable.tech
docs.stackable.tech
crds.stackable.tech
crds.stackable.tech
airflow-operator
airflow-operator
airflow-operator
airflow-operator
airflow-operator
airflow-operator
\ No newline at end of file +
documentation
documentation
documentation-ui
documentation-ui
Netlify
Netlify
docs.stackable.tech
docs.stackable.tech
hub.stackable.tech
hub.stackable.tech
airflow-operator
airflow-operator
airflow-operator
airflow-operator
airflow-operator
airflow-operator
diff --git a/modules/contributor/pages/docs/crd-documentation.adoc b/modules/contributor/pages/docs/crd-documentation.adoc index 0840c5e0d..9760f94ef 100644 --- a/modules/contributor/pages/docs/crd-documentation.adoc +++ b/modules/contributor/pages/docs/crd-documentation.adoc @@ -1,10 +1,10 @@ # CRD documentation -:crds-docs: https://crds.stackable.tech/ -:crddocs-repo: https://github.com/stackabletech/crddocs +:crds-docs: https://hub.stackable.tech/crds +:stackable-issues: https://github.com/stackabletech/issues -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. +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. All the documentation strings are doc strings in the Rust source code. 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. -To change the UI, adjust the HTML template and CSS files in the {crddocs-repo}[crddocs repository{external-link-icon}^]. -Also consult the README in that repository to learn more about how the site is generated. +The Hub ingests the CRDs of every operator automatically, so no manual steps are needed to publish the reference. +If you spot a problem with how the reference is rendered, file an issue in the {stackable-issues}[issues repository{external-link-icon}^]. diff --git a/modules/contributor/pages/docs/overview.adoc b/modules/contributor/pages/docs/overview.adoc index cc9393820..51ef6f8cd 100644 --- a/modules/contributor/pages/docs/overview.adoc +++ b/modules/contributor/pages/docs/overview.adoc @@ -5,11 +5,10 @@ :antora-zulipchat: https://antora.zulipchat.com/ :antora-distributed-components: https://docs.antora.org/antora/latest/distributed-component-version/ :antora-content-branches: https://docs.antora.org/antora/latest/playbook/content-branches/ -:crddocs-site: https://crds.stackable.tech/ +:crd-reference: https://hub.stackable.tech/crds :diataxis: https://diataxis.fr/ :netlify: https://www.netlify.com/ :pagefind: https://pagefind.app/ -:stackable-crddocs-repo: https://github.com/stackabletech/crddocs :stackable-docs-readme: https://github.com/stackabletech/documentation/blob/main/README.adoc :stackable-docs-repo: https://github.com/stackabletech/documentation :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 Since this kind of information is typically product specific, it is located in the usage guide section of individual operators. **Reference** information for the Stackable platform entails all the settings and Options in our YAMLs, which we generate. -The reference is found at {crddocs-site}[{crddocs-site}{external-link-icon}^] and generated from the {stackable-crddocs-repo}[crddocs repository{external-link-icon}^]. +The reference is found at {crd-reference}[{crd-reference}{external-link-icon}^] on the Stackable Hub, which ingests the CRDs of every operator automatically. === Style guide diff --git a/modules/contributor/pages/project-overview.adoc b/modules/contributor/pages/project-overview.adoc index 5344b03d0..232920f2b 100644 --- a/modules/contributor/pages/project-overview.adoc +++ b/modules/contributor/pages/project-overview.adoc @@ -56,8 +56,8 @@ The UI for the documentation is found in the https://github.com/stackabletech/do The documentation pulls in operator documentation files from the operator repositories. The documentation is found at https://docs.stackable.tech/[https://docs.stackable.tech/{external-link-icon}^]. -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. -The code to generate this page is found in the https://github.com/stackabletech/crddocs[crddocs{external-link-icon}^] repository. +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. +The Hub ingests the CRDs of every operator automatically. [[tooling-repositories]] === Tooling repositories diff --git a/netlify.toml b/netlify.toml index 0e761f583..05d325692 100644 --- a/netlify.toml +++ b/netlify.toml @@ -4,7 +4,7 @@ [[redirects]] from = "/home/stable/reference/*" - to = "https://crds.stackable.tech/" + to = "https://hub.stackable.tech/crds" status = 301 [[redirects]]