Skip to content

Commit cf610f0

Browse files
authored
Merge pull request #41 from lauralorenz/add-basic-glossary-to-website
Add a simple glossary page to top nav with basic definitions.
2 parents 206403d + 90ca43b commit cf610f0

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-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: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Glossary
2+
3+
About API: A cluster-local CRD to store arbitrary properties about a cluster.
4+
See [About API Overview](concepts/about-api.md).
5+
6+
ClusterProfile API: A CRD intended to store information about member clusters in
7+
a clusterset. See [ClusterProfile API Overview](concepts/clusterprofile-api.md).
8+
9+
ClusterSet: A group of clusters governed by a single authority, with a high
10+
degree of trust, and in which namespace sameness applies. See [ClusterSet
11+
reference](api-types/clusterset.md).
12+
13+
Multicluster Services API: An CRD composed of the ServiceExport and
14+
ServiceImport Kinds, used to facilitate accessing Services across clusters. See
15+
[Multicluster Services API Overview](concepts/multicluster-services-api.md).
16+
17+
Namespace Sameness: A property of clusters in clustersets, in which Kubernetes
18+
objects of the same name in the same namespace are expected to behave similarly
19+
across the clusterset. See [Namespace Sameness
20+
reference](api-types/namespace-sameness.md).
21+
22+
Work API: A CRD defining the Work Kind, intended to facilitate distributing
23+
workloads across multiple clusters. See [Work API
24+
Overview](concepts/work-api.md).

0 commit comments

Comments
 (0)