Skip to content

Commit 3108606

Browse files
committed
optimize partial descriptions in the document
Signed-off-by: Fish-pro <[email protected]>
1 parent 62cd2b6 commit 3108606

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ If you're new to the project and want to help, but don't know where to start, we
5151
should not need deep knowledge of the system. [Have a look and see if anything sounds
5252
interesting](https://github.com/kubernetes-sigs/cluster-api/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).
5353
Before starting to work on the issue, make sure that it doesn't have a [lifecycle/active](https://github.com/kubernetes-sigs/cluster-api/labels/lifecycle%2Factive) label. If the issue has been assigned, reach out to the assignee.
54-
Alternatively, read some of the docs on other controllers and try to write your own, file and fix any/all issues that
54+
Alternatively, read some docs on other controllers and try to write your own, file and fix any/all issues that
5555
come up, including gaps in documentation!
5656

5757
If you're a more experienced contributor, looking at unassigned issues in the next release milestone is a good way to find work that has been prioritized. For example, if the latest minor release is `v1.0`, the next release milestone is `v1.1`.
@@ -198,7 +198,7 @@ containing markdown files and we use [mdBook][] to build it into a static
198198
website.
199199

200200
After making changes locally you can run `make serve-book` which will build the HTML version
201-
and start a web server so you can preview if the changes render correctly at
201+
and start a web server, so you can preview if the changes render correctly at
202202
http://localhost:3000; the preview auto-updates when changes are detected.
203203

204204
Note: you don't need to have [mdBook][] installed, `make serve-book` will ensure
@@ -287,7 +287,7 @@ Code reviews should generally look at:
287287
- **Complexity**: Could the code be made simpler? Would another developer be able to easily understand and use this code when they come across it in the future?
288288
- **Tests**: Does the code have correct and well-designed tests?
289289
- **Naming**: Did the developer choose clear names for variable, types, methods, functions, etc.?
290-
- **Comments**: Are the comments clear and useful? Do they explain the why rather than what?
290+
- **Comments**: Are the comments clear and useful? Do they explain why rather than what?
291291
- **Documentation**: Did the developer also update relevant documentation?
292292

293293
See [Code Review in Cluster API](REVIEWING.md) for a more focused list of review items.
@@ -321,7 +321,7 @@ For big feature, API and contract amendments, we follow the CAEP process as outl
321321
Proof of concepts, code experiments, or other initiatives can live under the `exp` folder or behind a feature gate.
322322

323323
- Experiments SHOULD not modify any of the publicly exposed APIs (e.g. CRDs).
324-
- Experiments SHOULD not modify any existing CRD types outside of the experimental API group(s).
324+
- Experiments SHOULD not modify any existing CRD types outside the experimental API group(s).
325325
- Experiments SHOULD not modify any existing command line contracts.
326326
- Experiments MUST not cause any breaking changes to existing (non-experimental) Go APIs.
327327
- Experiments SHOULD introduce utility helpers in the go APIs for experiments that cross multiple components
@@ -349,7 +349,7 @@ Proof of concepts, code experiments, or other initiatives can live under the `ex
349349
- Experiment Graduation checklist:
350350
- [ ] MAY provide a way to be disabled, any feature gates MUST be marked as 'GA'
351351
- [ ] MUST undergo a full Kubernetes-style API review and update the CAEP with the plan to address any issues raised
352-
- [ ] CAEP MUST be in an implementable state and is fully up to date with the current implementation
352+
- [ ] CAEP MUST be in an implementable state and is fully up-to-date with the current implementation
353353
- [ ] CAEP MUST define transition plan for moving out of the experimental api group and code directories
354354
- [ ] CAEP MUST define any upgrade steps required for Existing Management and Workload Clusters
355355
- [ ] CAEP MUST define any upgrade steps required to be implemented by out-of-tree bootstrap, control plane, and infrastructure providers.
@@ -363,7 +363,7 @@ There may be times, however, when `main` is closed for breaking changes. This is
363363
release of a new minor version.
364364

365365
Breaking changes are not allowed in release branches, as these represent minor versions that have already been released.
366-
These versions have consumers who expect the APIs, behaviors, etc. to remain stable during the life time of the patch
366+
These versions have consumers who expect the APIs, behaviors, etc. to remain stable during the lifetime of the patch
367367
stream for the minor release.
368368

369369
Examples of breaking changes include:
@@ -475,7 +475,7 @@ organization and can request membership by [opening an
475475
issue](https://github.com/kubernetes/org/issues/new?template=membership.md&title=REQUEST%3A%20New%20membership%20for%20%3Cyour-GH-handle%3E)
476476
against the kubernetes/org repo.
477477

478-
However, if you are a member of any of the related Kubernetes GitHub organizations but not of the Kubernetes org, you
478+
However, if you are a member of the related Kubernetes GitHub organizations but not of the Kubernetes org, you
479479
will need explicit sponsorship for your membership request. You can read more about Kubernetes membership and
480480
sponsorship [here](https://git.k8s.io/community/community-membership.md).
481481

README.md

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

1919
## ✨ What is the Cluster API?
2020

21-
Cluster API is a Kubernetes sub-project focused on providing declarative APIs and tooling to simplify provisioning, upgrading, and operating multiple Kubernetes clusters.
21+
Cluster API is a Kubernetes subproject focused on providing declarative APIs and tooling to simplify provisioning, upgrading, and operating multiple Kubernetes clusters.
2222

2323
Started by the Kubernetes Special Interest Group (SIG) Cluster Lifecycle, the Cluster API project uses Kubernetes-style APIs and patterns to automate cluster lifecycle management for platform operators. The supporting infrastructure, like virtual machines, networks, load balancers, and VPCs, as well as the Kubernetes cluster configuration are all defined in the same way that application developers operate deploying and managing their workloads. This enables consistent and repeatable cluster deployments across a wide variety of infrastructure environments.
2424

REVIEWING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ feedback and suggestions.
2525
## Resources
2626

2727
- [Writing inclusive documentation](https://developers.google.com/style/inclusive-documentation)
28-
- [Contributor Summit NA 2019: Keeping the Bar High - How to be a bad ass Code Reviewer](https://www.youtube.com/watch?v=OZVv7-o8i40)
28+
- [Contributor Summit NA 2019: Keeping the Bar High - How to be a bad-ass Code Reviewer](https://www.youtube.com/watch?v=OZVv7-o8i40)
2929
- [Code Review Developer Guide - Google](https://google.github.io/eng-practices/review/)
3030
- [The Gentle Art Of Patch Review](https://sage.thesharps.us/2014/09/01/the-gentle-art-of-patch-review/)
3131

@@ -128,7 +128,7 @@ to help troubleshooting issues.
128128

129129
### Testing
130130

131-
Testing plays an crucial role in ensuring the long term maintainability of the project.
131+
Testing plays a crucial role in ensuring the long term maintainability of the project.
132132

133133
In Cluster API we are committed to have a good test coverage and also to have a nice and consistent style in implementing
134134
tests. For more information see [testing Cluster API](https://cluster-api.sigs.k8s.io/developer/testing.html).

0 commit comments

Comments
 (0)