Skip to content

Commit 9e3926b

Browse files
committed
Add a simple glossary page to top nav with basic definitions.
Signed-off-by: lauralorenz <[email protected]>
1 parent 206403d commit 9e3926b

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ nav:
4343
- Guides:
4444
- Index: guides/index.md
4545
- Implementation Guidelines: guides/guidelines.md
46+
- Glossary:
47+
- Index: references/glossary/index.md
4648
- Reference:
4749
- Namespace Sameness: concepts/namespace-sameness.md
4850
- ClusterSet: api-types/cluster-set.md

site-src/references/glossary/index.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Glossary
2+
3+
About API: A cluster-local CRD to store arbitrary properties about a cluster. See [About API Overview](concepts/about-api.md). _Previously known as ClusterProperty API._
4+
5+
Cluster Inventory: An old name for the project that became the ClusterProfile API. See _ClusterProfile API_.
6+
7+
ClusterProfile API: A CRD intended to store information about member clusters in a clusterset. See [ClusterProfile API Overview](concepts/clusterprofile-api.md). _Previously known as Cluster Inventory._
8+
9+
ClusterProperty API: An old name for the About API. See also _About API_.
10+
11+
ClusterSet: A group of clusters governed by a signle authority, with a high degree of trust, and in which namespace sameness applies. See [ClusterSet reference](api-types/clusterset.md).
12+
13+
Multicluster Services API: An CRD composed of the ServiceExport and ServiceImport Kinds, used to facilitate accessing Services across clusters. See [Multicluster Services API Overview](concepts/multicluster-services-api.md). _Also known as: MCS API, MCS._
14+
15+
Namespace Sameness: A property of clusters in clustersets, in which Kubernetes objects of the same name in the same namespace are expected to behave similarly across the clusterset. See [Namespace Sameness reference](api-types/namespace-sameness.md).
16+
17+
Work API: A CRD defining the Work Kind, intended to facilitate distributing workloads across multiple clusters. See [Work API Overview](concepts/work-api.md).
18+
19+
20+

0 commit comments

Comments
 (0)