Skip to content

Commit 5a8b600

Browse files
authored
Add page (#655)
1 parent a1e539c commit 5a8b600

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

modules/contributor/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,5 @@
1515
*** xref:docs/backporting-changes.adoc[]
1616
*** xref:docs/releasing-a-new-version.adoc[]
1717
*** xref:docs/troubleshooting-antora.adoc[]
18+
*** xref:docs/crd-documentation.adoc[]
1819
include::partial$adr-nav.adoc[]
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# CRD documentation
2+
:crds-docs: https://crds.stackable.tech/
3+
:crddocs-repo: https://github.com/stackabletech/crddocs
4+
5+
The {crds-docs}[CRD documentation] is generated from the CRD manifest files, which are in turn generated from the operator source code.
6+
All the documentation strings are doc strings in the Rust source code.
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+
9+
To change the UI, adjust the HTML template and CSS files in the {crddocs-repo}[crddocs repository].
10+
Also consult the README in that repository to learn more about how the site is generated.

0 commit comments

Comments
 (0)