Skip to content

Commit 7c70168

Browse files
committedJan 30, 2023
Optimize the document for readability
Signed-off-by: Fish-pro <[email protected]>
1 parent 2c55ced commit 7c70168

6 files changed

+9
-9
lines changed
 

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Please see the [Support](#support) section below.
88
## What is Kubeadm ?
99

1010
Kubeadm is a tool built to provide best-practice "fast paths" for creating Kubernetes clusters.
11-
It performs the actions necessary to get a minimum viable, secure cluster up and running in a user friendly way.
11+
It performs the actions necessary to get a minimum viable, secure cluster up and running in a user-friendly way.
1212
Kubeadm's scope is limited to the local node filesystem and the Kubernetes API, and it is intended to be a composable building block of higher level tools.
1313

1414

‎docs/managing-e2e-tests.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Kubernetes uses applications such as the web-based [testgrid](https://k8s-testgr
1111
The following folder contains all the SIG Cluster Lifecycle (the SIG that maintains kubeadm) originated test jobs:
1212
[sig-cluster-lifecycle](https://git.k8s.io/test-infra/config/jobs/kubernetes/sig-cluster-lifecycle)
1313

14-
Please note that this document will only cover details on the `kubeadm*.yaml` files and only on some of the parameters
14+
Please note that this document will only cover details on the `kubeadm*.yaml` files and only on some parameters
1515
these files contain.
1616

1717
For example, let's have a look at this file:
@@ -87,7 +87,7 @@ Let's define the size of the Kubernetes support skew as `N`.
8787
For `N=3`, 3 releases will be in support.
8888

8989
When a new release is about to happen, the kubeadm test workflows and jobs have
90-
two be updated two times:
90+
to be updated two times:
9191
1. When the new `release-x.yy` branch of `kubernetes/kubernetes` is created and the
9292
`release-x.yy-*` test-grid dashboards are created.
9393
- Edit `kinder/hack/update-workflows.sh`:

‎docs/release-cycle.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### kubeadm's release cycle and quarterly agenda
22

3-
Kubernetes has a well defined release process that improves with every release.
3+
Kubernetes has a well-defined release process that improves with every release.
44
These notes provide some inspiration for how the Kubernetes developing flow actually can look like.
55

66
Most of these tips and tricks are general and not kubeadm specific.
@@ -17,10 +17,10 @@ That said, nothing here is set in stone. See this as inspiration :)
1717
#### First month of the quarter (coding)
1818

1919
- Create a new housekeeping tracking issue similar to [this one](https://github.com/kubernetes/kubeadm/issues/180).
20-
- Remove e2e tests for k8s/kubeadm versions outside of the support skew.
20+
- Remove e2e tests for k8s/kubeadm versions outside the support skew.
2121
- Manage cherrypicks for the current stable branch
2222
- Make sure high-priority bug reports are triaged and fixed.
23-
- Create bug fixes, ensure they're merged, and cherry pick them to the release branch.
23+
- Create bug fixes, ensure they're merged, and cherry-pick them to the release branch.
2424
- Coordinate with the patch release team.
2525
- Plan/prioritize features, testing work and bugs
2626
- At the beginning of each cycle the kubeadm team has a planning session during the kubeadm office hours meeting.

‎docs/test-failures.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ ultimately responsible for keeping this in check. For this reason, contributors
2828
should be encouraged to work with and get the help of maintainers where
2929
necessary.
3030

31-
## A ecosystem/upstream change happens that breaks current tests
31+
## An ecosystem/upstream change happens that breaks current tests
3232

3333
If tests fail due to an upstream change to test-infra or a related ecosystem
3434
project, it is the responsibility of maintainers to correct and recalibrate

‎docs/testing-pre-releases.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ make release-images
212212

213213
## Creating the Kubernetes cluster with kubeadm
214214

215-
The kubernetes web site contains reference documentation for [installing kubeadm](https://kubernetes.io/docs/setup/independent/install-kubeadm/)
215+
The kubernetes website contains reference documentation for [installing kubeadm](https://kubernetes.io/docs/setup/independent/install-kubeadm/)
216216
and for [creating a cluster using it](https://kubernetes.io/docs/setup/independent/create-cluster-kubeadm/).
217217

218218
According to selected versions to be installed (the version of .deb or .rpm packages, the version of the kubeadm binary to be used, the version number of the control plane components) following variants to the standard procedure should be applied:

‎docs/updating-command-reference.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ sending a PR for `kubernetes/kubernetes`.
1616
Some of them will be for the new command - `*newcommand*`.
1717
- In your local copy of `kubernetes/website` navigate to this folder:
1818
`./content/en/docs/reference/setup-tools/kubeadm/generated`
19-
- Copy the `*newcommand*` files from `kubernetes/docs/admin/` to the this folder.
19+
- Copy the `*newcommand*` files from `kubernetes/docs/admin/` to the folder.
2020
- Create a PR for `kubernetes/website` and add these files to your commit.
2121
- Depending on the parent command of `newcommand` (in this case `config`) import the generated
2222
sub-command in the parent command MD file like so:

0 commit comments

Comments
 (0)
Please sign in to comment.