Skip to content

Add a simple glossary page to top nav with basic definitions. #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ nav:
- Guides:
- Index: guides/index.md
- Implementation Guidelines: guides/guidelines.md
- Glossary:
- Index: references/glossary/index.md
- Reference:
- Namespace Sameness: concepts/namespace-sameness.md
- ClusterSet: api-types/cluster-set.md
Expand Down
24 changes: 24 additions & 0 deletions site-src/references/glossary/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Glossary

About API: A cluster-local CRD to store arbitrary properties about a cluster.
See [About API Overview](concepts/about-api.md).

ClusterProfile API: A CRD intended to store information about member clusters in
a clusterset. See [ClusterProfile API Overview](concepts/clusterprofile-api.md).

ClusterSet: A group of clusters governed by a single authority, with a high
degree of trust, and in which namespace sameness applies. See [ClusterSet
reference](api-types/clusterset.md).

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).

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).

Work API: A CRD defining the Work Kind, intended to facilitate distributing
workloads across multiple clusters. See [Work API
Overview](concepts/work-api.md).