Skip to content

Commit 26782fe

Browse files
authored
feat(docs): reference docs (#338)
* reference docs * Changed nav order
1 parent 8bd5a4b commit 26782fe

File tree

5 files changed

+18
-8
lines changed

5 files changed

+18
-8
lines changed

docs/modules/secret-operator/pages/configuration.adoc

-6
This file was deleted.

docs/modules/secret-operator/pages/commandline_args.adoc renamed to docs/modules/secret-operator/pages/reference/commandline-parameters.adoc

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
=== --csi-endpoint
1+
= Command line parameters
2+
3+
This operator accepts the following command line parameters:
4+
5+
== --csi-endpoint
26

37
*Required*: true
48

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
= CRD Reference
2+
3+
Find all CRD reference for the Stackable Secret Operator at: {crd-docs-base-url}/secret-operator/{crd-docs-version}.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
= Reference
2+
3+
Consult the reference documentation section to find exhaustive information on:
4+
5+
* Descriptions and default values of all properties in the CRDs used by this operator in the xref:reference/crds.adoc[].
6+
* The xref:reference/commandline-parameters.adoc[] accepted by the operator.

docs/modules/secret-operator/partials/nav.adoc

+4-1
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,14 @@
22
// be included from a different module
33
* xref:secret-operator:building.adoc[]
44
* xref:secret-operator:installation.adoc[]
5-
* xref:secret-operator:configuration.adoc[]
65
* xref:secret-operator:usage.adoc[]
76
* Concepts
87
** xref:secret-operator:secretclass.adoc[]
98
** xref:secret-operator:scope.adoc[]
109
** xref:secret-operator:volume.adoc[]
1110
* xref:secret-operator:security.adoc[]
11+
* xref:secret-operator:reference/index.adoc[]
12+
** xref:secret-operator:reference/crds.adoc[]
13+
*** {crd-docs}/secrets.stackable.tech/secretclass/v1alpha1/[SecretClass {external-link-icon}^]
14+
** xref:secret-operator:reference/commandline-parameters.adoc[]
1215
* xref:secret-operator:troubleshooting.adoc[]

0 commit comments

Comments
 (0)