Skip to content

Commit 21a353e

Browse files
authored
Merge pull request #16 from ricardoapl/fix-typos
Fix typos, broken links, and formatting
2 parents 8e18f24 + b370237 commit 21a353e

File tree

6 files changed

+14
-12
lines changed

6 files changed

+14
-12
lines changed

site-src/api-types/cluster-set.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ClusterSet represents a specific pattern implemented by various organizations. A
99
- Namespaces don't have to exist in every cluster, but behave the same across those in which they do.
1010

1111
!!!note
12-
The early definition of the ClusterSet was described in [KEP-2149](https://github.com/kubernetes/enhancements/tree/master/keps/sig-multicluster/2149-clusterid). It is now part of the [About API](https://sigs.k8s.io/about-api).
12+
The early definition of the ClusterSet was described in [KEP-2149](https://github.com/kubernetes/enhancements/tree/master/keps/sig-multicluster/2149-clusterid). It is now part of the [About API](https://sigs.k8s.io/about-api).
1313

1414
A cluster's ClusterSet membership is stored in the about.k8s.io/ClusterProperty `clusterset.k8s.io`.
1515

site-src/concepts/multicluster-services-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This document provides an overview of Multicluster Services API.
44

5-
This is an extension of the Services concept across multiple clusters. Services are the basic way that workloads communicate with each other in Kubernetes, and the Multicluster Services builds upon the [Namespace Sameness](./namespace-sameness.md) concept to extend Services across multiclusters. In short, Services can remain available across clusters simply by using the same names. The Control Plane can be centralized or decentralized, but consumers only even rely on local data.
5+
This is an extension of the Services concept across multiple clusters. Services are the basic way that workloads communicate with each other in Kubernetes, and the Multicluster Services builds upon the [Namespace Sameness](./namespace-sameness.md) concept to extend Services across multiclusters. In short, Services can remain available across clusters simply by using the same names. The Control Plane can be centralized or decentralized, but consumers only rely on local data.
66

77
This document solely focuses on the API and the common behaviour, leaving room for various [implementations](../guides/index.md). There is no reference implementation available.
88

site-src/concepts/work-api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Work API Overview
22

3-
A common [Work API](https://github.com/kubernetes-sigs/work-api) to distribute workload to multiple clusters.
3+
A common [Work API](https://github.com/kubernetes-sigs/work-api) to distribute workloads across multiple clusters.
44

55
![Alt](../images/work-api.png "Work API")
66

@@ -15,7 +15,7 @@ and applies resources defined in the Work to the Managed Cluster.
1515

1616
## Overview
1717

18-
A Work is a custom resource that represent a list of API resources to be deployed on a cluster.
18+
A Work is a custom resource that represents a list of API resources to be deployed on a cluster.
1919
The Work is created on the Work Hub, and resides in the namespace that the Work Controller is authorized to access.
2020
Creation of a Work on the Work Hub indicates that resources defined in the Work will be applied on a certain Managed Cluster.
2121
Update of a Work will trigger the resource update on the Managed Cluster, and deletion of a Work will garbage collect the resources on the Managed Cluster.
@@ -41,7 +41,7 @@ spec:
4141
color=purple
4242
```
4343

44-
User creates a Work in the `cluster1 namespace on the Work Hub that the Work Controller is authorized to access.
44+
User creates a Work in the `cluster1` namespace on the Work Hub that the Work Controller is authorized to access.
4545
The Work Controller then accesses the Managed Cluster and applies the resources defined in the Work in its reconcile loop.
4646
The Work controller also tracks the status of applied resources by updating the Work status.
4747

site-src/contributing/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ you can get help with your specific implementation.
3030
Major discussions and notifications will be sent on the [SIG-MC mailing
3131
list][sigmcg].
3232

33-
We also have a [Slack channel (sig-multicluster)][slack] on k8s.io for day-to-day questions, discussions.
33+
We also have a [Slack channel (sig-multicluster)][slack] on k8s.io for day-to-day questions and discussions.
3434

3535
[sigmcg]: https://groups.google.com/forum/#!forum/kubernetes-sig-multicluster
3636
[slack]: https://kubernetes.slack.com/archives/C09R1PJR3

site-src/guides/guidelines.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ resources:
2222

2323
## Conflicts
2424

25-
Separation and delegation of responsibility among independent actors (e.g
25+
Separation and delegation of responsibility among independent actors (e.g.
2626
between cluster ops and application developers) can result in conflicts in the
2727
configuration. For example, two application teams may inadvertently submit
2828
configuration for the same HTTP path.
@@ -108,13 +108,15 @@ Similar to other Kubernetes APIs, Multicluster, Work and About APIs use "Kind" i
108108
in object references throughout the API. This pattern should be familiar to
109109
most Kubernetes users.
110110

111-
Per the [Kubernetes API conventions][1], this means that all implementations of
111+
Per the [Kubernetes API Conventions][1], this means that all implementations of
112112
this API should have a predefined mapping between kinds and resources. Relying
113113
on dynamic resource mapping is not safe.
114114

115115
## API Conventions
116116

117-
The Multicluster, About and Work APIs follow Kubernetes API [conventions][1]. These conventions
117+
The Multicluster, About and Work APIs follow [Kubernetes API Conventions][1]. These conventions
118118
are intended to ease client development and ensure that configuration
119119
mechanisms can consistently be implemented across a diverse set of use
120120
cases.
121+
122+
[1]: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md

site-src/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ Since its inception in 2015, Kubernetes has been pretty successful at popularizi
44

55
SIG-Multicluster is a [Special Interest Group][sig-multicluster-github] focused on solving common challenges related to the management of multiple Kubernetes clusters, and applications that exist therein.
66

7-
Specifically, the SIG aims to fine Kubernetes-native ways to:
7+
Specifically, the SIG aims to find Kubernetes-native ways to:
88

99
* Expose workloads from multiple clusters to each other
1010
* Share cluster metadata and its place relative to others
1111
* Generally break down the walls between clusters
1212

13-
The SIG is responsible for designing, discussing, implementing and maintaining API’s, tools and documentation related to multi-cluster administration and application management. This includes not only active automated approaches such as Cluster Federation, but also those that employ batch workflow-style continuous deployment systems like Spinnaker and others. Standalone building blocks for these and other similar systems (for example a cluster registry), and proposed changes to kubernetes core where appropriate will also be in scope.
13+
The SIG is responsible for designing, discussing, implementing and maintaining APIs, tools and documentation related to multi-cluster administration and application management. This includes not only active automated approaches such as Cluster Federation, but also those that employ batch workflow-style continuous deployment systems like Spinnaker and others. Standalone building blocks for these and other similar systems (for example a cluster registry), and proposed changes to kubernetes core where appropriate will also be in scope.
1414

1515
## Problem statement: why multicluster?
1616

@@ -37,7 +37,7 @@ There are many reasons to want to run multiple clusters, including but not limit
3737
## Project charter
3838
The following charter defines the scope and governance of the [Multicluster Special Interest Group][sig-multicluster-github]:
3939

40-
* Support an out-of-tree ecosystem by defining API standards that leave plenty of rool for flexibility in their ultimately third party implementation.
40+
* Support an out-of-tree ecosystem by defining API standards that leave plenty of room for flexibility in their ultimately third party implementation.
4141

4242
* Protect the known multicluster experience from incompatible changes upstream to single clusters by working with other [SIGs][sigs-github].
4343

0 commit comments

Comments
 (0)