Link to CRD docs (#509)

* ~

* updated link on landing page

* Added release branch script

* added another attribute to antora.yml

* Added WIP version of the second release script

* Added WIP version of the second release script

* WIP

* WIP

* WIP

* merged scripts

* fixed review

* Cleanup for the link icon; use target=_blank

Author: fhennig

antora-playbook.yml

@@ -183,6 +183,8 @@ asciidoc:
     base-repo: https://github.com/stackabletech
     plantuml-server-url: http://www.plantuml.com/plantuml
     kroki-fetch-diagram: true
+    # an external icon. Create a link opening in a new tab like this: http://my-url.com[Text {external-link-icon}^]
+    external-link-icon: "<i class=\"fa-solid fa-arrow-up-right-from-square fa-xs\" style=\"margin-left: 3px; vertical-align: baseline;\"></i>"
   extensions:
     - asciidoctor-kroki
 

antora.yml

@@ -6,8 +6,8 @@ nav:
   - modules/concepts/nav.adoc
   - modules/demos/nav.adoc
   - modules/tutorials/nav.adoc
-  - modules/reference/nav.adoc
   - modules/operators/nav.adoc
+  - modules/reference/nav.adoc
   - modules/contributor/nav.adoc
   - modules/ROOT/nav2.adoc
 # The prerelease setting affects version sorting.
@@ -24,3 +24,6 @@ asciidoc:
     # use the attributes below to link to the CRD docs
     crd-docs-base-url: "https://crds.stackable.tech"
     crd-docs: "{crd-docs-base-url}/{crd-docs-version}"
+    # this attribute is an annoying little hack to make the versioned
+    # link accessible to the UI template.
+    page-crd-docs: "{crd-docs}"

local-antora-playbook.yml

@@ -172,6 +172,8 @@ asciidoc:
     base-repo: https://github.com/stackabletech
     plantuml-server-url: http://www.plantuml.com/plantuml
     kroki-fetch-diagram: true
+    # an external icon. Create a link opening in a new tab like this: http://my-url.com[Text {external-link-icon}^]
+    external-link-icon: "<i class=\"fa-solid fa-arrow-up-right-from-square fa-xs\" style=\"margin-left: 3px; vertical-align: baseline;\"></i>"
   extensions:
     - asciidoctor-kroki
 

modules/ROOT/pages/index.adoc

@@ -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 {external-link-icon}^]
 
 ++++
 </div>

modules/concepts/pages/authentication.adoc

@@ -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
@@ -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]

modules/concepts/pages/s3.adoc

@@ -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].

modules/concepts/pages/service-discovery.adoc

@@ -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
 
@@ -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]

modules/reference/examples/authenticationclass-ldap-full.yaml

@@ -1,3 +1 @@
-* xref:index.adoc[]
-** xref:authenticationclass.adoc[]
-** xref:s3.adoc[]
+- {crd-docs}[CRD Reference {external-link-icon}^]

modules/reference/nav.adoc

@@ -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