Skip to content

Commit ac72483

Browse files
committed
Fix syntax errors in the document
Signed-off-by: Fish-pro <[email protected]>
1 parent 412ca49 commit ac72483

File tree

4 files changed

+14
-14
lines changed

4 files changed

+14
-14
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ We are a large inclusive OSS project that is welcoming help of any kind shape or
3535
* We need OSS community outreach/organizing help to get the word out; manage
3636
and create messaging and educational content; and help with social media, community forums/groups, and google groups.
3737
* We are actively inviting new [security advisors](https://github.com/containerd/project/blob/main/GOVERNANCE.md#security-advisors) to join the team.
38-
* New sub-projects are being created, core and non-core that could use additional development help.
38+
* New subprojects are being created, core and non-core that could use additional development help.
3939
* Each of the [containerd projects](https://github.com/containerd) has a list of issues currently being worked on or that need help resolving.
40-
- If the issue has not already been assigned to someone or has not made recent progress and you are interested, please inquire.
40+
- If the issue has not already been assigned to someone or has not made recent progress, and you are interested, please inquire.
4141
- If you are interested in starting with a smaller/beginner-level issue, look for issues with an `exp/beginner` tag, for example [containerd/containerd beginner issues.](https://github.com/containerd/containerd/issues?q=is%3Aissue+is%3Aopen+label%3Aexp%2Fbeginner)
4242

4343
## Getting Started
@@ -320,7 +320,7 @@ A Kubernetes incubator project, [cri-tools](https://github.com/kubernetes-sigs/c
320320
For async communication and long-running discussions please use issues and pull requests on the GitHub repo.
321321
This will be the best place to discuss design and implementation.
322322

323-
For sync communication catch us in the `#containerd` and `#containerd-dev` slack channels on Cloud Native Computing Foundation's (CNCF) slack - `cloud-native.slack.com`. Everyone is welcome to join and chat. [Get Invite to CNCF slack.](https://slack.cncf.io)
323+
For sync communication catch us in the `#containerd` and `#containerd-dev` Slack channels on Cloud Native Computing Foundation's (CNCF) Slack - `cloud-native.slack.com`. Everyone is welcome to join and chat. [Get Invite to CNCF Slack.](https://slack.cncf.io)
324324

325325
### Security audit
326326

RELEASES.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Versioning and Release
22

33
This document details the versioning and release plan for containerd. Stability
4-
is a top goal for this project and we hope that this document and the processes
4+
is a top goal for this project, and we hope that this document and the processes
55
it entails will help to achieve that. It covers the release process, versioning
66
numbering, backporting, API stability and support horizons.
77

@@ -74,7 +74,7 @@ to create the milestone or add an issue or PR to an existing milestone.
7474
### Support Horizon
7575

7676
Support horizons will be defined corresponding to a release branch, identified
77-
by `<major>.<minor>`. Releases branches will be in one of several states:
77+
by `<major>.<minor>`. Release branches will be in one of several states:
7878

7979
- __*Next*__: The next planned release branch.
8080
- __*Active*__: The release is a stable branch which is currently supported and accepting patches.
@@ -96,7 +96,7 @@ backports until the end of life date. They may also accept a wider range of
9696
patches than non-_LTS_ releases to support the longer term maintainability of the
9797
branch, including library dependency, toolchain (including Go) and other version updates
9898
which are needed to ensure each release is built with fully supported dependencies and
99-
remains usable by containerd clients. There should be at least a 6 month overlap between
99+
remains usable by containerd clients. There should be at least a 6-month overlap between
100100
the end of life of an _LTS_ release and the initial release of a new _LTS_ release.
101101
Up to 6 months before the announced end of life of an _LTS_ branch, the branch may
102102
convert to a regular _Active_ release with stricter backport criteria.
@@ -157,7 +157,7 @@ Deprecated containerd and kubernetes versions
157157
Backports in containerd are community driven. As maintainers, we'll try to
158158
ensure that sensible bugfixes make it into _active_ release, but our main focus
159159
will be features for the next _minor_ or _major_ release. For the most part,
160-
this process is straightforward and we are here to help make it as smooth as
160+
this process is straightforward, and we are here to help make it as smooth as
161161
possible.
162162

163163
If there are important fixes that need to be backported, please let us know in
@@ -178,7 +178,7 @@ fairly straightforward. The steps differ depending on whether you are pulling
178178
a fix from main or need to draft a new commit specific to a particular
179179
branch.
180180

181-
To cherry pick a straightforward commit from main, simply use the cherry pick
181+
To cherry-pick a straightforward commit from main, simply use the cherry-pick
182182
process:
183183

184184
1. Pick the branch to which you want backported, usually in the format
@@ -277,7 +277,7 @@ Plugins implemented in tree are supported by the containerd community unless exp
277277
Out of tree plugins are not supported by the containerd maintainers.
278278

279279
Currently, the Windows runtime and snapshot plugins are not stable and not supported.
280-
Please refer to the github milestones for Windows support in a future release.
280+
Please refer to the GitHub milestones for Windows support in a future release.
281281

282282
#### Error Codes
283283

@@ -289,7 +289,7 @@ new version of the service.
289289

290290
If you find that an error code that is required by your application is not
291291
well-documented in the protobuf service description or tested explicitly,
292-
please file and issue and we will clarify.
292+
please file an issue and we will clarify.
293293

294294
#### Opaque Fields
295295

@@ -317,7 +317,7 @@ be a matter of fixing compilation errors and moving from there.
317317

318318
The CRI (Container Runtime Interface) GRPC API is used by a Kubernetes kubelet
319319
to communicate with a container runtime. This interface is used to manage
320-
container lifecycles and container images. Currently this API is under
320+
container lifecycles and container images. Currently, this API is under
321321
development and unstable across Kubernetes releases. Each Kubernetes release
322322
only supports a single version of CRI and the CRI plugin only implements a
323323
single version of CRI.
@@ -330,7 +330,7 @@ version of Kubernetes which supports that version of CRI.
330330

331331
The `ctr` tool provides the ability to introspect and understand the containerd
332332
API. It is not considered a primary offering of the project and is unsupported in
333-
that sense. While we understand it's value as a debug tool, it may be completely
333+
that sense. While we understand its value as a debug tool, it may be completely
334334
refactored or have breaking changes in _minor_ releases.
335335

336336
Targeting `ctr` for feature additions reflects a misunderstanding of the containerd

ROADMAP.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# containerd roadmap
22

33
containerd uses the issues and milestones to define its roadmap.
4-
`ROADMAP.md` files are common in open source projects but we find they quickly become out of date.
4+
`ROADMAP.md` files are common in open source projects, but we find they quickly become out of date.
55
We opt for an issues and milestone approach that our maintainers and community can keep up-to-date as work is added and completed.
66

77
## Issues

SCOPE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Additional implementations will not be accepted into the core repository and sho
3131
## Scope
3232

3333
The following table specifies the various components of containerd and general features of container runtimes.
34-
The table specifies whether or not the feature/component is in or out of scope.
34+
The table specifies whether the feature/component is in or out of scope.
3535

3636
| Name | Description | In/Out | Reason |
3737
|------------------------------|--------------------------------------------------------------------------------------------------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

0 commit comments

Comments
 (0)