From ae24fa3ee2ef7af257caccea30f1876c093207f0 Mon Sep 17 00:00:00 2001 From: Felix Hennig Date: Thu, 29 Aug 2024 11:22:28 +0200 Subject: [PATCH] Add page --- modules/contributor/nav.adoc | 1 + modules/contributor/pages/docs/crd-documentation.adoc | 10 ++++++++++ 2 files changed, 11 insertions(+) create mode 100644 modules/contributor/pages/docs/crd-documentation.adoc diff --git a/modules/contributor/nav.adoc b/modules/contributor/nav.adoc index 75ed3792f..3e96a53a8 100644 --- 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 new file mode 100644 index 000000000..af589f7ce --- /dev/null +++ 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.