Skip to content

Commit fde1c91

Browse files
committed
more descriptions
1 parent effadcc commit fde1c91

File tree

4 files changed

+9
-4
lines changed

4 files changed

+9
-4
lines changed

modules/reference/pages/duration.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
= Duration format
22
:page-aliases: concepts:duration.adoc
3-
43
:rust-duration-max: https://doc.rust-lang.org/std/time/struct.Duration.html#associatedconstant.MAX
54
:go-std-time: https://cs.opensource.google/go/go/+/refs/tags/go1.21.2:src/time/format.go;l=1589
65
:k8s-cr: https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/
76
:go: https://go.dev/
7+
:description: nderstand the human-readable duration format used by Stackable operators, based on Go's time.ParseDuration, with units like days, hours, minutes, and seconds.
88

99
All Stackable operators use a human-readable duration format. It very closely resembles the format used by the {go}[Go] programming language - which Kubernetes uses internally.
1010
Every duration field of a {k8s-cr}[CustomResource], for example, the xref:trino:usage-guide/operations/graceful-shutdown.adoc[`spec.workers.roleConfig.gracefulShutdownTimeout`] field, supports this format.

modules/reference/pages/glossary.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
= Glossary
22
:li: pass:[<i class="fa-solid fa-link fa-sm" style="margin-left: 5px; vertical-align: baseline;"></i>]
3+
:description: Glossary of Stackable terms, including "Role," "Role Group," and "Stacklet," with definitions and links to detailed explanations.
34

45
// refined styling for the glossary
56
++++
@@ -54,4 +55,4 @@ Learn more about xref:concepts:stacklet.adoc#role-groups[role groups].
5455
A Stacklet is defined by a custom resource like AirflowCluster or DruidCluster.
5556
The term refers to the defining resource and all the resources that belong to it, which are created by the operator, such as StatefulSets, Services, Secrets and ConfigMaps.
5657
All objects together are the Stacklet.
57-
====
58+
====

modules/tutorials/pages/authentication_with_openldap.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
11
= Authentication with OpenLDAP
2+
:kind: https://kind.sigs.k8s.io/
3+
:k9s: https://k9scli.io/
4+
:description: Learn how to set up LDAP authentication for Stackable's Superset and Trino products, including installing OpenLDAP and configuring authentication classes.
25

36
The Stackable platform supports user authentication with LDAP in multiple products. This page guides you through setting
47
up the configuration necessary to use an existing LDAP installation with Stackable supported products. You can learn
58
more about authentication in the Stackable Platform on the xref:concepts:authentication.adoc[concepts page].
69

710
Prerequisites:
811

9-
* a k8s cluster available, or https://kind.sigs.k8s.io/[kind] installed
12+
* a k8s cluster available, or {kind}[kind] installed
1013
* xref:management:stackablectl:index.adoc[] installed
1114
* basic knowledge of how to create resources in Kubernetes (i.e. `kubectl apply -f <filename>.yaml`) and inspect them
12-
(`kubectl get` or a tool like https://k9scli.io/[k9s])
15+
(`kubectl get` or a tool like {k9s}[k9s])
1316
1417
== Setup
1518

modules/tutorials/pages/index.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= Tutorials
2+
:description: Explore Stackable Data Platform tutorials for feature setup, product operators, and getting started guides for Airflow, Druid, HBase, and more.
23

34
Tutorials help you learn about a specific aspect of the Stackable Data Platform in a hands-on way.
45

0 commit comments

Comments
 (0)