From 9e3926bdbb4f9cb4cfc51c01ff80e6714757ef47 Mon Sep 17 00:00:00 2001 From: lauralorenz Date: Wed, 30 Jul 2025 17:01:16 +0000 Subject: [PATCH 1/3] Add a simple glossary page to top nav with basic definitions. Signed-off-by: lauralorenz --- mkdocs.yml | 2 ++ site-src/references/glossary/index.md | 20 ++++++++++++++++++++ 2 files changed, 22 insertions(+) create mode 100644 site-src/references/glossary/index.md diff --git a/mkdocs.yml b/mkdocs.yml index 6d12ada..026bf7d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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 diff --git a/site-src/references/glossary/index.md b/site-src/references/glossary/index.md new file mode 100644 index 0000000..65711ef --- /dev/null +++ b/site-src/references/glossary/index.md @@ -0,0 +1,20 @@ +# Glossary + +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._ + +Cluster Inventory: An old name for the project that became the ClusterProfile API. See _ClusterProfile API_. + +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._ + +ClusterProperty API: An old name for the About API. See also _About API_. + +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). + +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._ + +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). + + + From 5ca42a6f9f0f6b62abea7afc09c705c1be9c95e8 Mon Sep 17 00:00:00 2001 From: lauralorenz Date: Wed, 6 Aug 2025 19:06:34 +0000 Subject: [PATCH 2/3] Remove aliases and old name references. Signed-off-by: lauralorenz --- site-src/references/glossary/index.md | 15 ++++----------- 1 file changed, 4 insertions(+), 11 deletions(-) diff --git a/site-src/references/glossary/index.md b/site-src/references/glossary/index.md index 65711ef..3508bf5 100644 --- a/site-src/references/glossary/index.md +++ b/site-src/references/glossary/index.md @@ -1,20 +1,13 @@ # Glossary -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._ +About API: A cluster-local CRD to store arbitrary properties about a cluster. See [About API Overview](concepts/about-api.md). -Cluster Inventory: An old name for the project that became the ClusterProfile API. See _ClusterProfile API_. +ClusterProfile API: A CRD intended to store information about member clusters in a clusterset. See [ClusterProfile API Overview](concepts/clusterprofile-api.md). -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._ +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). -ClusterProperty API: An old name for the About API. See also _About API_. - -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). - -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._ +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). - - - From 90ca43be3775a946ae0726eb629a9c886a6149b7 Mon Sep 17 00:00:00 2001 From: lauralorenz Date: Wed, 6 Aug 2025 19:06:51 +0000 Subject: [PATCH 3/3] Rewrap Signed-off-by: lauralorenz --- site-src/references/glossary/index.md | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/site-src/references/glossary/index.md b/site-src/references/glossary/index.md index 3508bf5..7508258 100644 --- a/site-src/references/glossary/index.md +++ b/site-src/references/glossary/index.md @@ -1,13 +1,24 @@ # Glossary -About API: A cluster-local CRD to store arbitrary properties about a cluster. See [About API Overview](concepts/about-api.md). +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). +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). +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). +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). +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). +Work API: A CRD defining the Work Kind, intended to facilitate distributing +workloads across multiple clusters. See [Work API +Overview](concepts/work-api.md).