Skip to content

Commit 94d3fd1

Browse files
committed
typos: minor spelling corrections in design docs
Signed-off-by: hasheddan <[email protected]>
1 parent 47f279b commit 94d3fd1

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

designs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Use your best judgement.
1111

1212
When submitting a design document, we encourage having written
1313
a proof-of-concept, and it's perfectly acceptable to submit the
14-
proof-of-concept PR simulatenously with the design document, as the
14+
proof-of-concept PR simultaneously with the design document, as the
1515
proof-of-concept process can help iron out wrinkles and can help with the
1616
`Example` section of the template.
1717

designs/simplified-scaffolding.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Simplified Builder-Based Scaffolding
44
## Background
55

66
The current scaffolding in kubebuilder produces a directory structure that
7-
looks something like this (compiled artificacts like config omitted for
7+
looks something like this (compiled artifacts like config omitted for
88
brevity):
99

1010
<details>
@@ -114,7 +114,7 @@ files, 6 are KubeBuilder-specific glue code, 4 are test setup, and
114114
user-edited code.
115115

116116
This proliferation of files makes it difficult for users to understand how
117-
their code relates to the library, posing some barier for initial adoption
117+
their code relates to the library, posing some barrier for initial adoption
118118
and moving beyond a basic knowledge of functionality to actual
119119
understanding of the structure. A common line of questioning amongst
120120
newcomers to KubeBuilder includes "where should I put my code that adds
@@ -179,7 +179,7 @@ Users receive a simply scaffolded structure to start. Simple projects can
179179
remain relatively simple, and complicated projects can decide to adopt
180180
a different structure as they grow.
181181

182-
The new scaffoled project structure looks something like this (compiled
182+
The new scaffold project structure looks something like this (compiled
183183
artifacts like config omitted for brevity):
184184

185185
```shell
@@ -223,7 +223,7 @@ func (r *myReconciler) SetupWithManager(mgr ctrl.Manager) error {
223223
```
224224

225225
This makes it abundantly clear where to start looking at the code
226-
(`main.go` is the defacto standard entrypoint for many go programs), and
226+
(`main.go` is the defacto standard entry-point for many go programs), and
227227
simplifies the levels of hierarchy. Furthermore, since `main.go` actually
228228
instantiates an instance of the reconciler, users are able to add custom
229229
logic having to do with flags.
@@ -248,7 +248,7 @@ easy to setup with a manager.
248248

249249
These suggestions make it much harder to scaffold out additional versions
250250
and kinds. You need to have each version in a separate package, so that
251-
type names don't confict. While we could put scheme registration in with
251+
type names don't conflict. While we could put scheme registration in with
252252
`kind_types.go`, if a project has multiple "significant" Kinds in an API
253253
group, it's not immediately clear which file has the scheme registration.
254254

@@ -323,7 +323,7 @@ scaffold out the builder. We have two options here:
323323

324324
2. Simply adding a new controller, and reminding the user to add the
325325
builder themselves. This is easier for the maintainers, but perhaps
326-
a slighly poorer UX for the users. However, writing out a builder by
326+
a slightly poorer UX for the users. However, writing out a builder by
327327
hand is significantly less complex than adding a controller by hand in
328328
the current structure.
329329

@@ -348,7 +348,7 @@ versions, controllers, etc
348348
### Teaching more complicated project structures
349349

350350
Some controllers may eventually want more complicated project structures.
351-
We should have a section of the book reccomending options for when you
351+
We should have a section of the book recommending options for when you
352352
project gets very complicated.
353353

354354
### Additional Tooling Work

designs/template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ annoyed by the overall design process and decide to bake cookies instead.
1010

1111
<!-- Specify an example of how the user would use this. It helps other
1212
contributors get a feel for how this will look in real code, and provides
13-
a good oportunity to evaluate the end-user feel of the code for yourself.
13+
a good opportunity to evaluate the end-user feel of the code for yourself.
1414
1515
If you find yourself groaning at verbosity, copy-and-pasting a lot, or
1616
writing a bunch of tiny helper functions, it's a good indication that you
1717
might need to re-evaluate the user experience of your design.
1818
19-
This is also a good oportunity to stop and write a proof-of-concept, if
19+
This is also a good opportunity to stop and write a proof-of-concept, if
2020
you haven't already, which should help catch practical nits with the
2121
design. -->

0 commit comments

Comments
 (0)