Skip to content

Commit 8c1bf75

Browse files
razvanfhennigsbernauer
authored
Glossary (#479)
* Glossary * Update concepts nav * Move to the correct location (hopefully) * moved the glossary, added some entries, added styling and linking * Open blocks by default * concepts reorganized and new overview page (#325) * Added a bunch of images * More stuff * use different domain in local playbook to make fonts work * build from local branch * temporary branch ref * fixed refs * Update local-antora-playbook.yml * reorganized menu * Update modules/concepts/pages/overview.adoc Co-authored-by: Sebastian Bernauer <[email protected]> * fixed illlustration * Added more links --------- Co-authored-by: Sebastian Bernauer <[email protected]> * fix: merge breakage --------- Co-authored-by: Felix Hennig <[email protected]> Co-authored-by: Felix Hennig <[email protected]> Co-authored-by: Sebastian Bernauer <[email protected]>
1 parent 6abbe14 commit 8c1bf75

File tree

2 files changed

+59
-1
lines changed

2 files changed

+59
-1
lines changed

modules/reference/nav.adoc

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
* Reference
22
** {crd-docs}[CRD Reference {external-link-icon}^]
3-
** xref:duration.adoc[]
3+
** xref:glossary.adoc[]
4+
** xref:duration.adoc[]

modules/reference/pages/glossary.adoc

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
= Glossary
2+
:li: pass:[<i class="fa-solid fa-link fa-sm" style="margin-left: 5px; vertical-align: baseline;"></i>]
3+
4+
// refined styling for the glossary
5+
++++
6+
<style>
7+
dd details {
8+
margin-top: 0px !important;
9+
}
10+
11+
dt {
12+
font-size: 18px;
13+
font-style: unset !important;
14+
}
15+
</style>
16+
++++
17+
18+
// syntax explanation:
19+
// - the [[...]] creates an anchor at the list item
20+
// - The <<...>> creates a link to the achor
21+
// - The {li} references the pass that you can find at the top of the document, it is a FontAwesome icon
22+
// - The ...:: is the syntax for a definition list item
23+
// - The {empty} followed by the + means that there is no "normal" list item, instead there is a block
24+
// - The period followed by text is the summary of a details block that is collapsed
25+
// - Inside the "====" is the details of the details block.
26+
//
27+
// Please create new entries the same way! This allows easy linking to glossary items.
28+
// Antora generates dl, dt and dd tages for the definition list, which is great because these are
29+
// semantic HTML tags.
30+
31+
[[role]]Role <<role,{li}>>:: {empty}
32+
+
33+
.A <<stacklet,Stacklet>> is made up of multiple roles, which refer to the different processes that make up the service.
34+
[%collapsible%open]
35+
====
36+
For example HDFS consists of 3 roles: Name nodes, journal nodes and data nodes.
37+
Learn more about xref:concepts:roles-and-role-groups.adoc[].
38+
====
39+
40+
[[role-group]]Role group <<role-group,{li}>>:: {empty}
41+
+
42+
.A <<role,Role>> is made up of multiple role groups.
43+
[%collapsible%open]
44+
====
45+
A role group can override configuration set at role level, allowing for different configurations for sets of processes.
46+
Learn more about xref:concepts:roles-and-role-groups.adoc[].
47+
====
48+
49+
[[stacklet]]Stacklet <<stacklet,{li}>>:: {empty}
50+
+
51+
.A deployed service or product instance that is managed by a Stackable operator.
52+
[%collapsible%open]
53+
====
54+
A Stacklet is defined by a custom resource like AirflowCluster or DruidCluster.
55+
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.
56+
All objects together are the Stacklet.
57+
====

0 commit comments

Comments
 (0)