Update README.md #1524
Draft
Update README.md #1524
+42
−17
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Saiyam Pathak <[email protected]>
Signed-off-by: Saiyam Pathak <[email protected]>
|
Solves #1518 |
|
cc - @TheFoxAtWork |
| This document provides high level information for projects to understand the project lifecycle, criteria, and the moving levels process for to demonstrate their completion of a defined criteria set. | ||
|
|
||
| CNCF Projects experience a project lifecycle that conveys their completion of a defined set of criteria. These criteria are cumulative, building upon the previous maturity level criteria to enable cloud native projects to become highly maturity, secure, production ready projects for adopters. | ||
| This document outlines the CNCF project lifecycle, the criteria for each stage, and the process for transitioning between levels. The CNCF project lifecycle helps ensure cloud-native projects meet defined standards of maturity, security, and production readiness for adopters. |
There was a problem hiding this comment.
Suggested change
| This document outlines the CNCF project lifecycle, the criteria for each stage, and the process for transitioning between levels. The CNCF project lifecycle helps ensure cloud-native projects meet defined standards of maturity, security, and production readiness for adopters. | |
| This document outlines the CNCF project lifecycle - a multi-stage evaluation which helps ensure cloud native projects meet defined standards of maturity, security, and production readiness for adopters. It includes the criteria for each stage and the process for transitioning between levels. |
| Sandbox projects are the initial stage in the CNCF's project maturity levels. These projects represent innovative and experimental ideas, often involving new technologies or offering unique approaches to existing technologies. At this early stage, failure is a possibility, but the focus is on evaluating the project's potential impact and value to the ecosystem. Sandbox projects are expected to undergo significant changes, including breaking changes to their functionality. They are in a continuous state of evolution, refining their release processes and integrating feedback from both contributors and early adopters who are willing to experiment with less mature technology. They are experimental; they might still be used in production by a few organizations on a case to case basis. | ||
|
|
||
| **Incubation**: | ||
| Incubating projects in the CNCF represent the middle stage of project maturity. These projects have progressed beyond the experimental phase of the Sandbox and are starting to demonstrate stability. Incubating projects exhibit a slower rate of change, with fewer breaking changes and more fixed APIs. This signifies that the project's core functionality is solid, making it more reliable for production use. Importantly, this stage marks the point where the CNCF's Technical Oversight Committee (TOC) begins to actively evaluate the project's adoption. The TOC assesses the project's usefulness to interested parties, gauging its potential for wider adoption and integration within the cloud-native ecosystem. |
There was a problem hiding this comment.
Suggested change
| Incubating projects in the CNCF represent the middle stage of project maturity. These projects have progressed beyond the experimental phase of the Sandbox and are starting to demonstrate stability. Incubating projects exhibit a slower rate of change, with fewer breaking changes and more fixed APIs. This signifies that the project's core functionality is solid, making it more reliable for production use. Importantly, this stage marks the point where the CNCF's Technical Oversight Committee (TOC) begins to actively evaluate the project's adoption. The TOC assesses the project's usefulness to interested parties, gauging its potential for wider adoption and integration within the cloud-native ecosystem. | |
| Incubating projects in the CNCF represent the middle stage of project maturity. These projects have progressed beyond the experimental phase of the Sandbox and are starting to demonstrate stability. Incubating projects exhibit a slower rate of change, with fewer breaking changes and more stable, versioned APIs. This signifies that the project's core functionality is solid, making it more reliable for production use. Importantly, this stage marks the point where the CNCF's Technical Oversight Committee (TOC) begins to actively evaluate the project's adoption. The TOC assesses the project's usefulness to interested parties, gauging its potential for wider adoption and integration within the cloud native ecosystem. |
| Incubating projects in the CNCF represent the middle stage of project maturity. These projects have progressed beyond the experimental phase of the Sandbox and are starting to demonstrate stability. Incubating projects exhibit a slower rate of change, with fewer breaking changes and more fixed APIs. This signifies that the project's core functionality is solid, making it more reliable for production use. Importantly, this stage marks the point where the CNCF's Technical Oversight Committee (TOC) begins to actively evaluate the project's adoption. The TOC assesses the project's usefulness to interested parties, gauging its potential for wider adoption and integration within the cloud-native ecosystem. | ||
|
|
||
| **Graduation**: | ||
| CNCF Graduated projects represent the pinnacle of project maturity within the Cloud Native Computing Foundation's ecosystem. These projects have successfully navigated the Sandbox and Incubating stages, demonstrating a high level of stability, functionality, and widespread adoption within their specific market area. Graduated projects are characterised by their adherence to mature and evolved practices, ensuring consistent and reliable performance. They offer a high degree of confidence to adopters and contributors alike, guaranteeing stability, robust performance, comprehensive security measures, and active engagement with the community. Reaching the Graduated level signifies that the project has proven its value and is considered a reliable and trusted solution within the cloud-native landscape. |
There was a problem hiding this comment.
Suggested change
| CNCF Graduated projects represent the pinnacle of project maturity within the Cloud Native Computing Foundation's ecosystem. These projects have successfully navigated the Sandbox and Incubating stages, demonstrating a high level of stability, functionality, and widespread adoption within their specific market area. Graduated projects are characterised by their adherence to mature and evolved practices, ensuring consistent and reliable performance. They offer a high degree of confidence to adopters and contributors alike, guaranteeing stability, robust performance, comprehensive security measures, and active engagement with the community. Reaching the Graduated level signifies that the project has proven its value and is considered a reliable and trusted solution within the cloud-native landscape. | |
| CNCF Graduated projects represent the pinnacle of project maturity within the Cloud Native Computing Foundation's ecosystem. These projects have successfully navigated the previous stage(s), demonstrating a high level of stability, functionality, and widespread adoption within their specific market area. Graduated projects are characterised by their adherence to mature and evolved practices, ensuring consistent and reliable performance. They offer a high degree of confidence to adopters and contributors alike, demonstrating stability, robust performance, comprehensive security measures, and active engagement with the community. Reaching the Graduated level signifies that the project has proven its value and is considered a reliable and trusted solution within the cloud native landscape. |
There was a problem hiding this comment.
in open source we dont provide guarantees beyond what the license of the software states.
|
|
||
| **Archived**: | ||
| Archived projects are inactive or no longer recommended for use. This stage ensures the CNCF community focuses on active, impactful projects. | ||
| Projects may enter the CNCF either by applying as a sandbox project or applying directly for incubation. As a project navigates their maturity journey, their completion of a given level's criteria is evaluated by the TOC in a process called Due Diligence to ensure the project's implementation of the criteria meets the desired outcome, intent, and expectations set forth by the TOC. |
There was a problem hiding this comment.
This line is out of place here under archived, should probably move down to replace line 36 "Projects may enter the CNCF...." under Project lifecycle processes.
Should also link to the archive information: https://github.com/cncf/toc/blob/main/process/archiving.md
|
|
||
| Evaluting projects against the criteria does take some time and the TOC has recently modified the Due Diligence process to reduce duplication of work, streamline handoffs, and provide better transparency to the project and its adopters about its conformance and implementation of the criteria. | ||
| **Project Lifecycle Process** |
There was a problem hiding this comment.
Suggested change
| **Project Lifecycle Process** | |
| ## Project Lifecycle Process |
Comment on lines
48
to
56
| ### Project resources and guide posts | ||
|
|
||
| The TOC, with support from the [Technical Advisory Groups](/tags/README.md), have a wide variety of resources available to assist projects. Current and aspiring maintainers of cloud native projects can find a lot of information and templates on [contribute.cncf.io/maintainers](https://contribute.cncf.io/maintainers/). The TOC also maintains [project Guide Posts](../docs/project_guideposts.md) - a collection of guiding points that have assisted cloud native projects as they grow and mature in the ecosystem. These are not requirements for moving levels, those may be found in the respective application issue templates ([Incubation](../.github/ISSUE_TEMPLATE/template-incubation-application.md), [Graduation](../.github/ISSUE_TEMPLATE/template-graduation-application.md)). The [Guide Posts](../docs/project_guideposts.md) are a resources for projects to leverage that is beneficial in meeting or exceeding the criteria defined. | ||
| The TOC, with support from the [Technical Advisory Groups](/tags/README.md), have a wide variety of resources available to assist projects. Current and aspiring maintainers of cloud native projects can find a lot of information and templates on [contribute.cncf.io/maintainers](https://contribute.cncf.io/maintainers/). The TOC also maintains [project Guide Posts](../docs/project_guideposts.md) - a collection of guiding points that have assisted cloud native projects as they grow and mature in the ecosystem. These are not requirements for moving levels, those may be found in the respective application issue templates ([Incubation](../.github/ISSUE_TEMPLATE/template-incubation-application.md), [Graduation](../.github/ISSUE_TEMPLATE/template-graduation-application.md)). The [Guide Posts](../docs/project_guideposts.md) are resources for projects to leverage that are beneficial in meeting or exceeding the criteria defined. | ||
|
|
||
| Additionally, projects interested in preparing to apply to move levels are encouraged to pursue the following activities as the resulting artifacts can and often are leveraged in the TOC's completion of the Due Diligence in lieu of certain sections of the DD. | ||
|
|
||
| * Pursue a [Goverance Review with TAG Contributor Strategy](https://github.com/cncf/tag-contributor-strategy/issues/new?template=governance-review-request.yaml) - A governance review is an indepth look at how your project is governed, its documentation, its practices, and general project operations. For more information please [checkout the maintainer page on governance](https://contribute.cncf.io/maintainers/governance/overview/) or join the [Governance Review Group](https://github.com/cncf/tag-contributor-strategy/tree/main/governance). | ||
| * Complete a [General Technical Review (GTR)](../tags/resources/toc-supporting-guides/general-technical-questions.md) or [Domain Technical Review (DTR)](../tags/resources/toc-supporting-guides/tag-domain-technical-review-template.md) - these reviews are provide a structured framework to explore the technical lifecycle aspects of a project experienced or sought by adopters as well as dive deep on the design and architecture of the project within its technical domain of focus. The results of these can support projects in identifying next steps to increase usability, resilience, scale, performance, and ease-of-use. | ||
| * Collaborate with [TAG Security on a joint-review](https://github.com/cncf/tag-security/blob/main/community/assessments/guide/README.md#joint-assessment) - highly recommended for currently incubating projects, the joint review is a comprehensive assessment of a project's security, it helps project's prepare for a successful security audit. |
There was a problem hiding this comment.
This should have a link "for project resources on the lifecycle process, please refer to the section on Project Resources and Guide Posts" under the Project Lifecycle Process section (towards the end) and then move this below into the "additional information"
| @@ -150,6 +172,7 @@ __2nd week following the event__ | |||
| The above freeze only applies to KCCN NA and EU. Other events will be subject to the TOC members' availability who are expected to regularly check in with the projects. TOC members may choose to continue working with projects on due diligence within the weeks before and after KCCN subject to their and others' availability. Projects should take all of this into account when planning completion of their due diligence. We ask projects to be understanding and considerate of our availability constraints around KCCN and remind everyone that the TOC is not a full-time body, we have primary work commitments in addition to our involvement on the TOC and any projects, TAGs, or community groups we are involved in. | |||
|
|
|||
| As the CNCF chooses to create new standalone occurrences of KCCN, this freeze should be reviewed to ensure ample time is available to conduct activities to support project moving levels. It may include restricting to just two freezes a year, or a complete re-evaluation of the freeze in light of whatever changes have transpired. | |||
| --- | |||
|
|
|||
| #### Additional information | |||
There was a problem hiding this comment.
This should be moved to an H2
| @@ -3,40 +3,60 @@ | |||
| v1.6, previously "project proposal process v1.5" | |||
|
|
|||
| ## Introduction | |||
There was a problem hiding this comment.
Given this file is fairly long, we should consider adding header links to commonly sought information. Like "How to move levels" "timelines"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adding more extensive definitions for Sandbox, incubating and graduations. Fixed a few other things for overall doc.
This should provide definitions for the projects and also act as a single source for maintainers of new - existing CNCF projects to find information about projects and the overall process.
I definitely think we should re-evaluate the process as the number of KubeCon's have already increased to 5 a year which is a big number now for freeze to be applicable.