Skip to content

feat(docs): added reference section #516

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
Dec 21, 2023
Merged

feat(docs): added reference section #516

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
13 changes: 0 additions & 13 deletions docs/modules/trino/pages/configuration.adoc
View file
Open in desktop

This file was deleted.

7 changes: 5 additions & 2 deletions ...modules/trino/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,5 +1,8 @@
= Command line parameters

=== product-config
This operator accepts the following command line parameters:

== product-config

*Default value*: `/etc/stackable/trino-operator/config-spec/properties.yaml`

Expand All @@ -12,7 +15,7 @@
cargo run -- run --product-config /foo/bar/properties.yaml
----

=== watch-namespace
== watch-namespace

*Default value*: All namespaces

Expand Down
3 changes: 3 additions & 0 deletions docs/modules/trino/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 Operator for Trino at: {crd-docs-base-url}/trino-operator/{crd-docs-version}.
8 changes: 5 additions & 3 deletions docs/modules/trino/pages/env_var_args.adoc → ...ages/reference/environment-variables.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
= Environment variables

=== PRODUCT_CONFIG
This operator accepts the following environment variables:

== PRODUCT_CONFIG

*Default value*: `/etc/stackable/trino-operator/config-spec/properties.yaml`

Expand All @@ -25,7 +28,7 @@ docker run \
docker.stackable.tech/stackable/trino-operator:latest
----

=== WATCH_NAMESPACE
== WATCH_NAMESPACE

*Default value*: All namespaces

Expand Down Expand Up @@ -53,4 +56,3 @@ docker run \
--mount type=bind,source="$HOME/.kube/config",target="/home/stackable/.kube/config" \
docker.stackable.tech/stackable/trino-operator:latest
----

6 changes: 6 additions & 0 deletions docs/modules/trino/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[] and xref:reference/environment-variables.adoc[] accepted by the operator.
7 changes: 6 additions & 1 deletion docs/modules/trino/partials/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
* xref:trino:getting_started/index.adoc[]
** xref:trino:getting_started/installation.adoc[]
** xref:trino:getting_started/first_steps.adoc[]
* xref:trino:configuration.adoc[]
* xref:trino:concepts.adoc[]
* xref:trino:usage-guide/index.adoc[]
** xref:trino:usage-guide/connect_to_trino.adoc[]
Expand All @@ -25,3 +24,9 @@
*** xref:trino:usage-guide/operations/pod-placement.adoc[]
*** xref:trino:usage-guide/operations/pod-disruptions.adoc[]
*** xref:trino:usage-guide/operations/graceful-shutdown.adoc[]
* xref:trino:reference/index.adoc[]
** xref:trino:reference/crds.adoc[]
*** {crd-docs}/trino.stackable.tech/trinocluster/v1alpha1/[TrinoCluster {external-link-icon}^]
*** {crd-docs}/trino.stackable.tech/trinocatalog/v1alpha1/[TrinoCatalog {external-link-icon}^]
** xref:trino:reference/commandline-parameters.adoc[]
** xref:trino:reference/environment-variables.adoc[]