Merge pull request #7970 from Fish-pro/fix/statemant
Fix syntax errors in the document
This commit is contained in:
		| @@ -35,9 +35,9 @@ We are a large inclusive OSS project that is welcoming help of any kind shape or | ||||
| * We need OSS community outreach/organizing help to get the word out; manage | ||||
| and create messaging and educational content; and help with social media, community forums/groups, and google groups. | ||||
| * We are actively inviting new [security advisors](https://github.com/containerd/project/blob/main/GOVERNANCE.md#security-advisors) to join the team. | ||||
| * New sub-projects are being created, core and non-core that could use additional development help. | ||||
| * New subprojects are being created, core and non-core that could use additional development help. | ||||
| * Each of the [containerd projects](https://github.com/containerd) has a list of issues currently being worked on or that need help resolving. | ||||
|   - If the issue has not already been assigned to someone or has not made recent progress and you are interested, please inquire. | ||||
|   - If the issue has not already been assigned to someone or has not made recent progress, and you are interested, please inquire. | ||||
|   - 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) | ||||
|  | ||||
| ## Getting Started | ||||
| @@ -320,7 +320,7 @@ A Kubernetes incubator project, [cri-tools](https://github.com/kubernetes-sigs/c | ||||
| For async communication and long-running discussions please use issues and pull requests on the GitHub repo. | ||||
| This will be the best place to discuss design and implementation. | ||||
|  | ||||
| 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) | ||||
| 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) | ||||
|  | ||||
| ### Security audit | ||||
|  | ||||
|   | ||||
							
								
								
									
										18
									
								
								RELEASES.md
									
									
									
									
									
								
							
							
						
						
									
										18
									
								
								RELEASES.md
									
									
									
									
									
								
							| @@ -1,7 +1,7 @@ | ||||
| # Versioning and Release | ||||
|  | ||||
| This document details the versioning and release plan for containerd. Stability | ||||
| is a top goal for this project and we hope that this document and the processes | ||||
| is a top goal for this project, and we hope that this document and the processes | ||||
| it entails will help to achieve that. It covers the release process, versioning | ||||
| numbering, backporting, API stability and support horizons. | ||||
|  | ||||
| @@ -74,7 +74,7 @@ to create the milestone or add an issue or PR to an existing milestone. | ||||
| ### Support Horizon | ||||
|  | ||||
| Support horizons will be defined corresponding to a release branch, identified | ||||
| by `<major>.<minor>`. Releases branches will be in one of several states: | ||||
| by `<major>.<minor>`. Release branches will be in one of several states: | ||||
|  | ||||
| - __*Next*__: The next planned release branch. | ||||
| - __*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 | ||||
| patches than non-_LTS_ releases to support the longer term maintainability of the | ||||
| branch, including library dependency, toolchain (including Go) and other version updates | ||||
| which are needed to ensure each release is built with fully supported dependencies and | ||||
| remains usable by containerd clients. There should be at least a 6 month overlap between | ||||
| remains usable by containerd clients. There should be at least a 6-month overlap between | ||||
| the end of life of an _LTS_ release and the initial release of a new _LTS_ release. | ||||
| Up to 6 months before the announced end of life of an _LTS_ branch, the branch may | ||||
| convert to a regular _Active_ release with stricter backport criteria. | ||||
| @@ -157,7 +157,7 @@ Deprecated containerd and kubernetes versions | ||||
| Backports in containerd are community driven. As maintainers, we'll try to | ||||
| ensure that sensible bugfixes make it into _active_ release, but our main focus | ||||
| will be features for the next _minor_ or _major_ release. For the most part, | ||||
| this process is straightforward and we are here to help make it as smooth as | ||||
| this process is straightforward, and we are here to help make it as smooth as | ||||
| possible. | ||||
|  | ||||
| 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 | ||||
| a fix from main or need to draft a new commit specific to a particular | ||||
| branch. | ||||
|  | ||||
| To cherry pick a straightforward commit from main, simply use the cherry pick | ||||
| To cherry-pick a straightforward commit from main, simply use the cherry-pick | ||||
| process: | ||||
|  | ||||
| 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 | ||||
| Out of tree plugins are not supported by the containerd maintainers. | ||||
|  | ||||
| Currently, the Windows runtime and snapshot plugins are not stable and not supported. | ||||
| Please refer to the github milestones for Windows support in a future release. | ||||
| Please refer to the GitHub milestones for Windows support in a future release. | ||||
|  | ||||
| #### Error Codes | ||||
|  | ||||
| @@ -289,7 +289,7 @@ new version of the service. | ||||
|  | ||||
| If you find that an error code that is required by your application is not | ||||
| well-documented in the protobuf service description or tested explicitly, | ||||
| please file and issue and we will clarify. | ||||
| please file an issue and we will clarify. | ||||
|  | ||||
| #### Opaque Fields | ||||
|  | ||||
| @@ -317,7 +317,7 @@ be a matter of fixing compilation errors and moving from there. | ||||
|  | ||||
| The CRI (Container Runtime Interface) GRPC API is used by a Kubernetes kubelet | ||||
| to communicate with a container runtime. This interface is used to manage | ||||
| container lifecycles and container images. Currently this API is under | ||||
| container lifecycles and container images. Currently, this API is under | ||||
| development and unstable across Kubernetes releases. Each Kubernetes release | ||||
| only supports a single version of CRI and the CRI plugin only implements a | ||||
| single version of CRI. | ||||
| @@ -330,7 +330,7 @@ version of Kubernetes which supports that version of CRI. | ||||
|  | ||||
| The `ctr` tool provides the ability to introspect and understand the containerd | ||||
| API. It is not considered a primary offering of the project and is unsupported in | ||||
| that sense. While we understand it's value as a debug tool, it may be completely | ||||
| that sense. While we understand its value as a debug tool, it may be completely | ||||
| refactored or have breaking changes in _minor_ releases. | ||||
|  | ||||
| Targeting `ctr` for feature additions reflects a misunderstanding of the containerd | ||||
|   | ||||
| @@ -1,7 +1,7 @@ | ||||
| # containerd roadmap | ||||
|  | ||||
| containerd uses the issues and milestones to define its roadmap. | ||||
| `ROADMAP.md` files are common in open source projects but we find they quickly become out of date. | ||||
| `ROADMAP.md` files are common in open source projects, but we find they quickly become out of date. | ||||
| We opt for an issues and milestone approach that our maintainers and community can keep up-to-date as work is added and completed. | ||||
|  | ||||
| ## Issues | ||||
|   | ||||
							
								
								
									
										2
									
								
								SCOPE.md
									
									
									
									
									
								
							
							
						
						
									
										2
									
								
								SCOPE.md
									
									
									
									
									
								
							| @@ -31,7 +31,7 @@ Additional implementations will not be accepted into the core repository and sho | ||||
| ## Scope | ||||
|  | ||||
| The following table specifies the various components of containerd and general features of container runtimes. | ||||
| The table specifies whether or not the feature/component is in or out of scope. | ||||
| The table specifies whether the feature/component is in or out of scope. | ||||
|  | ||||
| | Name | Description | In/Out | Reason | | ||||
| |------------------------------|--------------------------------------------------------------------------------------------------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||||
|   | ||||
		Reference in New Issue
	
	Block a user
	 Phil Estes
					Phil Estes