Skip to content

Add new page for CRD documentation to the Contributors guide #655

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 29, 2024
Merged

Add new page for CRD documentation to the Contributors guide #655

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions modules/contributor/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
10 changes: 10 additions & 0 deletions modules/contributor/pages/docs/crd-documentation.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.