Skip to content

Commit 79f762d

Browse files
Address feedback
1 parent 51517fa commit 79f762d

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

docs/book/src/developer/providers/best-practices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ However, some best practice are worth to notice:
1212
to grouping resources
1313

1414
- Naming convention above should not be used and advertised as a contract to build on top. Instead more robust mechanism
15-
MUST always be provided and used for identifying objects, like tagging on labeling.
15+
MUST always be provided and used for identifying objects, like tagging or labeling.
1616
Please note that this is necessary not only to prevent issues in case Cluster API changes default naming strategies
1717
for the Kubernetes objects generated by core controllers, but also to handle use cases where users intentionally influence Cluster API naming strategies.
1818

docs/book/src/developer/providers/contracts/infra-cluster.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Infrastructure providers SHOULD implement an InfraCluster resource.
44

5-
The goal of an InfraCluster resource is to supplie whatever prerequisites (in term of infrastructure) are necessary for running machines.
5+
The goal of an InfraCluster resource is to supply whatever prerequisites (in term of infrastructure) are necessary for running machines.
66
Examples might include networking, load balancers, firewall rules, and so on.
77

88
The InfraCluster resource will be referenced by one of the Cluster API core resources, Cluster.
@@ -28,7 +28,7 @@ are explicitly called out in dedicated pages.
2828
When developing a provider, you MUST consider any Cluster API behaviour that is not defined by a contract rule
2929
as a Cluster API internal implementation detail, subject to change without any advice.
3030

31-
When implementing an Infra Cluster, you MUST NOT rely on any Cluster API internal behaviour, otherwise you are exposing users
31+
When implementing an InfraCluster, you MUST NOT rely on any Cluster API internal behaviour, otherwise you are exposing users
3232
to the risk that such internal behaviour will change.
3333

3434
Instead, whenever you need something more from the Cluster API contract, you MUST engage the community.
@@ -188,7 +188,7 @@ The list resource MUST be named as `<InfraCluster>List`.
188188
//+kubebuilder:object:root=true
189189

190190
// FooClusterList contains a list of fooclusters.
191-
type FooaClusterList struct {
191+
type FooClusterList struct {
192192
metav1.TypeMeta `json:",inline"`
193193
metav1.ListMeta `json:"metadata,omitempty"`
194194
Items []FooCluster `json:"items"`
@@ -380,14 +380,14 @@ The template resource MUST be named as `<InfraCluster>Template`.
380380
// +kubebuilder:storageversion
381381

382382
// FooClusterTemplate is the Schema for the fooclustertemplates API.
383-
type InfraClusterTemplate struct {
383+
type FooClusterTemplate struct {
384384
metav1.TypeMeta `json:",inline"`
385385
metav1.ObjectMeta `json:"metadata,omitempty"`
386386

387387
Spec FooClusterTemplateSpec `json:"spec,omitempty"`
388388
}
389389

390-
type FooaClusterTemplateSpec struct {
390+
type FooClusterTemplateSpec struct {
391391
Template FooClusterTemplateResource `json:"template"`
392392
}
393393

@@ -409,11 +409,11 @@ The list resource MUST be named as `<InfraClusterTemplate>List`.
409409
```go
410410
//+kubebuilder:object:root=true
411411

412-
// InfraClusterTemplateList contains a list of InfraClusterTemplates.
413-
type InfraClusterTemplateList struct {
412+
// FooClusterTemplateList contains a list of FooClusterTemplates.
413+
type FooClusterTemplateList struct {
414414
metav1.TypeMeta `json:",inline"`
415415
metav1.ListMeta `json:"metadata,omitempty"`
416-
Items []InfraClusterTemplate `json:"items"`
416+
Items []FooClusterTemplate `json:"items"`
417417
}
418418
```
419419

0 commit comments

Comments
 (0)