Skip to content

Link to CRD docs #509

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.

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 13 commits into from
Dec 21, 2023
Merged
2 changes: 1 addition & 1 deletion modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ xref:operators:index.adoc[Operator overview]

Read the CustomResourceDefinition (CRD) reference for all CRDs that are deployed by any Stackable operator.

https://crds.stackable.tech/[CRD Reference]
{crd-docs}[CRD Reference]

++++
</div>
Expand Down
4 changes: 2 additions & 2 deletions modules/concepts/pages/authentication.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ In a diagram it would look like this:

image::image$authentication-overview.drawio.svg[]

NOTE: For more details, look at the xref:reference:authenticationclass.adoc[AuthenticationClass reference] as well as the xref:tutorials:authentication_with_openldap.adoc[OpenLDAP tutorial].
NOTE: Learn more in the xref:tutorials:authentication_with_openldap.adoc[OpenLDAP tutorial] and get a full overview of all the properties in the {crd-docs}/authentication.stackable.tech/authenticationclass/v1alpha1/#spec-provider-ldap[AuthenticationClass LDAP provider CRD reference].

[#tls]
=== TLS
Expand Down Expand Up @@ -78,4 +78,4 @@ include::example$authenticationclass-static-secret.yaml[]
== Further Reading

* xref:tutorials:authentication_with_openldap.adoc[] tutorial
* xref:reference:authenticationclass.adoc[] reference
* {crd-docs}/authentication.stackable.tech/authenticationclass/v1alpha1/[AuthenticationClass CRD reference]
2 changes: 1 addition & 1 deletion modules/concepts/pages/s3.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -205,4 +205,4 @@ credentials:

== What's next

Find details about the options of the S3 resource in the xref:reference:s3.adoc[S3 resources reference].
Read the {crd-docs}/s3.stackable.tech/s3bucket/v1alpha1/[S3Bucket CRD reference] and the {crd-docs}/s3.stackable.tech/s3connection/v1alpha1/[S3Connection CRD reference].
4 changes: 2 additions & 2 deletions modules/concepts/pages/service-discovery.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:page-aliases: service_discovery.adoc

// Abstract
Stackable operators provide a _service discovery ConfigMap_ for each product instance that is deployed. This ConfigMap has the same name as the product instance and contains information about how to connect to the instance. The ConfigMap is used by other Operators to connect products together and can also be used by you, the user, to connect external software to Stackable-operated software.
Stackable operators provide a _service discovery ConfigMap_ for each product instance that is deployed. **This ConfigMap has the same name as the product instance** and contains information about how to connect to the instance. The ConfigMap is used by other Operators to connect products together and can also be used by you, the user, to connect external software to Stackable-operated software.

== Motivation

Expand Down Expand Up @@ -118,7 +118,7 @@ For Stackable managed services the Stackable Operators will take care of this, b

Consult discovery ConfigMap documentation for specific products:

* xref:druid:discovery.adoc[Apache Druid]
* xref:druid:reference/discovery.adoc[Apache Druid]
* xref:hdfs:discovery.adoc[Apache Hadoop HDFS]
* xref:hive:discovery.adoc[Apache Hive]
* xref:kafka:discovery.adoc[Apache Kafka]
Expand Down
4 changes: 1 addition & 3 deletions modules/reference/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
* xref:index.adoc[]
** xref:authenticationclass.adoc[]
** xref:s3.adoc[]
* xref:index.adoc[]
22 changes: 0 additions & 22 deletions modules/reference/pages/authenticationclass.adoc

This file was deleted.

8 changes: 6 additions & 2 deletions modules/reference/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# Reference
# CRD reference
:page-aliases: s3.adoc, authenticationclass.adoc

Reference for common objects and configuration fragments across the platform.
// Let's not link individual CRDs etc. here, just point to the landing page of the CRD docs and that's it.
You can find CRD reference documentation at {crd-docs}.

There you will find documentation on all properties of all the CRDs that are deployed by the Stackable operators.
99 changes: 0 additions & 99 deletions modules/reference/pages/s3.adoc

This file was deleted.

2 changes: 1 addition & 1 deletion modules/tutorials/pages/authentication_with_openldap.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ The LDAP connection details only need to be written down once, in the Authentica
== Further Reading

- xref:concepts:authentication.adoc[Authentication concepts page]
- xref:reference:authenticationclass.adoc[AuthenticationClass reference]
* {crd-docs}/authentication.stackable.tech/authenticationclass/v1alpha1/[AuthenticationClass CRD reference]
- xref:superset:getting_started/index.adoc[Getting started with the Stackable Operator for Apache Superset]
- xref:trino:getting_started/index.adoc[Getting started with the Stackable Operator for Trino]
// TODO Operator docs for LDAP
1 change: 1 addition & 0 deletions supplemental-ui/partials/navbar.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
<a class="drop-down-item" href="{{{ relativize (versioned "home" page "concepts/index.html") }}}">Concepts</a>
<a class="drop-down-item" href="{{{ relativize (versioned "home" page "demos/index.html") }}}">Demos</a>
<a class="drop-down-item" href="{{{ relativize (versioned "home" page "tutorials/index.html") }}}">Tutorials</a>
<a class="drop-down-item" href="{{{ relativize (versioned "home" page "reference/index.html") }}}">CRD Reference</a>
<a class="drop-down-item" href="{{{ relativize (versioned "home" page "release-notes.html") }}}">Release Notes</a>
</div>
</div>
Expand Down