Add page (#655)

stackabletech · Aug 29, 2024 · 5a8b600 · 5a8b600
1 parent a1e539c
commit 5a8b600
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/modules/contributor/nav.adoc b/modules/contributor/nav.adoc
@@ -15,4 +15,5 @@
 *** xref:docs/backporting-changes.adoc[]
 *** xref:docs/releasing-a-new-version.adoc[]
 *** xref:docs/troubleshooting-antora.adoc[]
+*** xref:docs/crd-documentation.adoc[]
 include::partial$adr-nav.adoc[]
diff --git a/modules/contributor/pages/docs/crd-documentation.adoc b/modules/contributor/pages/docs/crd-documentation.adoc
@@ -0,0 +1,10 @@
+# CRD documentation
+:crds-docs: https://crds.stackable.tech/
+:crddocs-repo: https://github.com/stackabletech/crddocs
+
+The {crds-docs}[CRD documentation] 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].
+Also consult the README in that repository to learn more about how the site is generated.