Skip to content

feat(docs): reference docs #338

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 2 commits into from
Jan 2, 2024
Merged

feat(docs): reference docs #338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be929e8
reference docs
Dec 25, 2023
3223c66
Changed nav order
Dec 25, 2023
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
6 changes: 0 additions & 6 deletions docs/modules/secret-operator/pages/configuration.adoc
View file
Open in desktop

This file was deleted.

6 changes: 5 additions & 1 deletion ...cret-operator/pages/commandline_args.adoc → ...ges/reference/commandline-parameters.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
=== --csi-endpoint
= Command line parameters

This operator accepts the following command line parameters:

== --csi-endpoint

*Required*: true

Expand Down
3 changes: 3 additions & 0 deletions docs/modules/secret-operator/pages/reference/crds.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
= CRD Reference

Find all CRD reference for the Stackable Secret Operator at: {crd-docs-base-url}/secret-operator/{crd-docs-version}.
6 changes: 6 additions & 0 deletions docs/modules/secret-operator/pages/reference/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
= Reference

Consult the reference documentation section to find exhaustive information on:

* Descriptions and default values of all properties in the CRDs used by this operator in the xref:reference/crds.adoc[].
* The xref:reference/commandline-parameters.adoc[] accepted by the operator.
5 changes: 4 additions & 1 deletion docs/modules/secret-operator/partials/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,14 @@
// be included from a different module
* xref:secret-operator:building.adoc[]
* xref:secret-operator:installation.adoc[]
* xref:secret-operator:configuration.adoc[]
* xref:secret-operator:usage.adoc[]
* Concepts
** xref:secret-operator:secretclass.adoc[]
** xref:secret-operator:scope.adoc[]
** xref:secret-operator:volume.adoc[]
* xref:secret-operator:security.adoc[]
* xref:secret-operator:reference/index.adoc[]
** xref:secret-operator:reference/crds.adoc[]
*** {crd-docs}/secrets.stackable.tech/secretclass/v1alpha1/[SecretClass {external-link-icon}^]
** xref:secret-operator:reference/commandline-parameters.adoc[]
* xref:secret-operator:troubleshooting.adoc[]