diff --git a/how-to/join_kubeflow_ecosystem.md b/how-to/join_kubeflow_ecosystem.md index a4b2678ea..be9c637c6 100644 --- a/how-to/join_kubeflow_ecosystem.md +++ b/how-to/join_kubeflow_ecosystem.md @@ -1,157 +1,157 @@ -# Application for a Project to Join the Kubeflow Ecosystem - -Please see the [proposals/new-project-join-process.md](Documentation) to -better understand the full process for submitting a new project. -In short, copy this Application Template and populate the document. - - -## Changes to the application process -Changes to the application process charter may be proposed through a Pull Request -on this document by a Kubeflow community member. - -Amendments are accepted following the Kubeflow Steering Committee's [Normal Decision Process](../KUBEFLOW-STEERING-COMMITTEE.md#normal-decision-process). - -Proposals and amendments to the application process are available for at -least a period of one week for comments and questions before a vote will occur. - -## CNCF Short Checklist - -- [ ] All project metadata and resources are vendor-neutral -- [ ] Governance structure -- [ ] Contributing guides -- [ ] Public list of adopters - - -## Background information - -1. Submitter Name - - - -1. Submitter’s relationship to project / title - - - -1. Project Name - - - -1. Why is this project is valuable to the Kubeflow Community? - - - -1. Why is it beneficial for this project to be a part of the Kubeflow Community? - - - -1. List of existing (and potential) integrations with Kubeflow Core components - - - -1. Short Description / Functionality - - - -1. Adoption - - - -1. License Agreement - - - -1. Part of an Open Source Foundation? (e.g., Apache, Liniux, CNCF, etc.) - - - -1. Vendor Neutrality - - - -1. Trademark transition - - - -1. CI/CD Infra Requirements - - - -1. Governance Structure - - - -1. Website - - - -1. GitHub repository - - - -1. 1st Release date - - - -1. Project Meeting Times - - - -1. Meeting Notes - - - -1. Installation Documentation - - - -1. Project Documentation - - - -1. Security Profile (CVE scanning, Pod Security Standards, Network Policies) - - - -1. Ownership / Legal Profile (license type, any potential issues for CNCF) - - - -1. Authorization, Isolation mechanisms - - - -1. Project Roadmap - - - -1. Other Information - - - -## Metrics - -- Number of Maintainers and their Affiliations -- Number of Releases in last 12 months -- Number of Contributors -- Number of Users -- Number of Forks -- Number of Stars -- Number of package/project installations/downloads - -## Kubeflow Checklist - -1. Overlap with existing Kubeflow projects - - [ ] Yes (If so please list them) - - [ ] No - -1. Manifest Integration - - [ ] Yes - - [ ] No - - [ ] Planned - -1. Commitment to Kubeflow Conformance Program - - [ ] Yes - - [ ] No - - [ ] Uncertain - -1. Installation - - [ ] Standalone/Self-contained Component - - [ ] Part of Manifests - - [ ] Part of Distributions - -1. Installation Documentation (Current Quality) - - [ ] Good - - [ ] Fair - - [ ] Part of Kubeflow - -1. CI/CD - - [ ] Yes - - [ ] No - -1. Release Process - - [ ] Automated - - [ ] Semi-automated - - [ ] Not Automated - -1. Kubeflow Website Documentation - - [ ] Yes - - [ ] No - -1. Blog/Social Media - - [ ] Yes - - [ ] No - +# How to Become a Kubeflow Subproject + +Please see the [proposals/748-expand-kubeflow-ecosystem.md](Documentation) to +better understand the full process for submitting a new project. +In short, copy this Application Template and populate the document. + + +## Changes to the application process +Changes to the application process charter may be proposed through a Pull Request +on this document by a Kubeflow community member. + +Amendments are accepted following the Kubeflow Steering Committee's [Normal Decision Process](../KUBEFLOW-STEERING-COMMITTEE.md#normal-decision-process). + +Proposals and amendments to the application process are available for at +least a period of one week for comments and questions before a vote will occur. + +## CNCF Short Checklist + +- [ ] All project metadata and resources are vendor-neutral +- [ ] Governance structure +- [ ] Contributing guides +- [ ] Public list of adopters + + +## Background information + +1. Submitter Name + - + +1. Submitter’s relationship to project / title + - + +1. Project Name + - + +1. Why is this project is valuable to the Kubeflow Community? + - + +1. Why is it beneficial for this project to be a part of the Kubeflow Community? + - + +1. List of existing (and potential) integrations with Kubeflow Core components + - + +1. Short Description / Functionality + - + +1. Adoption + - + +1. License Agreement + - + +1. Part of an Open Source Foundation? (e.g., Apache, Liniux, CNCF, etc.) + - + +1. Vendor Neutrality + - + +1. Trademark transition + - + +1. CI/CD Infra Requirements + - + +1. Governance Structure + - + +1. Website + - + +1. GitHub repository + - + +1. 1st Release date + - + +1. Project Meeting Times + - + +1. Meeting Notes + - + +1. Installation Documentation + - + +1. Project Documentation + - + +1. Security Profile (CVE scanning, Pod Security Standards, Network Policies) + - + +1. Ownership / Legal Profile (license type, any potential issues for CNCF) + - + +1. Authorization, Isolation mechanisms + - + +1. Project Roadmap + - + +1. Other Information + - + +## Metrics + +- Number of Maintainers and their Affiliations +- Number of Releases in last 12 months +- Number of Contributors +- Number of Users +- Number of Forks +- Number of Stars +- Number of package/project installations/downloads + +## Kubeflow Checklist + +1. Overlap with existing Kubeflow projects + - [ ] Yes (If so please list them) + - [ ] No + +1. Manifest Integration + - [ ] Yes + - [ ] No + - [ ] Planned + +1. Commitment to Kubeflow Conformance Program + - [ ] Yes + - [ ] No + - [ ] Uncertain + +1. Installation + - [ ] Standalone/Self-contained Component + - [ ] Part of Manifests + - [ ] Part of Distributions + +1. Installation Documentation (Current Quality) + - [ ] Good + - [ ] Fair + - [ ] Part of Kubeflow + +1. CI/CD + - [ ] Yes + - [ ] No + +1. Release Process + - [ ] Automated + - [ ] Semi-automated + - [ ] Not Automated + +1. Kubeflow Website Documentation + - [ ] Yes + - [ ] No + +1. Blog/Social Media + - [ ] Yes + - [ ] No + diff --git a/proposals/748-expand-kubeflow-ecosystem/README.md b/proposals/748-expand-kubeflow-ecosystem/README.md index ad6f4f21d..60ee8bc8c 100644 --- a/proposals/748-expand-kubeflow-ecosystem/README.md +++ b/proposals/748-expand-kubeflow-ecosystem/README.md @@ -1,79 +1,79 @@ -# KEP-748: Expanding the Kubeflow Ecosystem with a New OSS Project - -## Summary -This KEP outlines how OSS projects can join the Kubeflow Ecosystem. - - -Note: this process will follow the Kubeflow Steering Committee's [Normal decision process](../KUBEFLOW-STEERING-COMMITTEE.md#normal-decision-process) - -## Motivation -As Kubeflow has become a well established ecosystem and community, several -projects may want to join the Kubeflow ecosystem to explicitly be a part of our -community. - -Kubeflow's goal is to cover the entire AI/ML lifecycle and new projects can help -address missing stages in that lifecycle. - -### Goals -This goal of this process is to give clear guidelines and set expectations -for community members about how to be formally included into the Kubeflow Ecosystem and -the application process. - -The decision making process will be separate from the application process and is at the -discretion of the Kubeflow Steering Committee. The application and data provided are -critical for the KSC to make an informed decision that is best for the longetivity -of the project and community. - -### Non-Goals -- Give specific recommendations for evaluating any individual project. -- Supporting project add-ons. - -## Proposal -The process to join the Kubeflow Ecosystem is intended to be simple but thorough. - -Project owners or maintainers will apply to join by following a four -step process. - -The process is outlined in six steps: - -1. Create a GitHub Issue with a Google Document outlining your proposal (please allow for commentary), the document should have a rough outline with: - - Authors - - Motivation - - Benefits for Kubeflow - - Benefits for the Project's Community - - Community Metrics - - Contributor Metrics - - Maintainers - - Migration Plan - - Other Related Projects -2. Provide a demo during the Kubeflow Community Call -3. Submit a Pull Request with the [../proposals/new-project-join-process.md](application form). -4. Add your proposal to the Kubeflow Community call to introduce and collect feedback on -the application. -5. Work with the Kubeflow Outreach Committee to send an announcement email in `kubeflow-discuss` and publish messages on Slack, LinkedIn, X/Twitter, and other Kubeflow social resources -6. Schedule meeting with Kubeflow Steering Committee for initial vote and to collect feedback. -7. Identify the appropriate Kubeflow Working Group that should control the project. -8. Merge or close the Pull Request depending upon the outcome of the final vote. - -### Notes/Constraints/Caveats (Optional) - -Note that this application does not guarantee acceptance of the proposed project to Kubeflow. - -### Risks and Mitigations - -Two major risks for Kubeflow accepting projects are: -1. Accepting projects that do not have active contributors or a healthy user base -- This is why metrics are meant to capture this -2. Impacting the delivery speed of Kubeflow releases -- It will be expected that the maintainers invest in incorporating the project into the manifest or it will be removed -3. Additional infrastructure support -- It will be expected that the maintainers invest in providing this support - -## Drawbacks - -How could this new project harm the Kubeflow community? - -## Alternatives - -What other open source projects are there like the one proposed? -Why should Kubeflow accept the one proposed? +# KEP-748: Expanding the Kubeflow Ecosystem with a New OSS Project + +## Summary +This KEP outlines how OSS projects can join the Kubeflow Ecosystem. + + +Note: this process followed the Kubeflow Steering Committee's [Normal decision process](../KUBEFLOW-STEERING-COMMITTEE.md#normal-decision-process) + +## Motivation +As Kubeflow has become a well established ecosystem and community, several +projects may want to join the Kubeflow ecosystem to explicitly be a part of our +community. + +Kubeflow's goal is to cover the entire AI/ML lifecycle and new projects can help +address missing stages in that lifecycle. + +### Goals +This goal of this process is to give clear guidelines and set expectations +for community members about how to be formally included into the Kubeflow Ecosystem and +the application process. + +The decision making process will be separate from the application process and is at the +discretion of the Kubeflow Steering Committee. The application and data provided are +critical for the KSC to make an informed decision that is best for the longetivity +of the project and community. + +### Non-Goals +- Give specific recommendations for evaluating any individual project. +- Supporting project add-ons. + +## Proposal +The process to join the Kubeflow Ecosystem is intended to be simple but thorough. + +Project owners or maintainers will apply to join by following a four +step process. + +The process is outlined in six steps: + +1. Create a GitHub Issue with a Google Document outlining your proposal (please allow for commentary), the document should have a rough outline with: + - Authors + - Motivation + - Benefits for Kubeflow + - Benefits for the Project's Community + - Community Metrics + - Contributor Metrics + - Maintainers + - Migration Plan + - Other Related Projects +2. Provide a demo during the Kubeflow Community Call +3. Submit a Pull Request with the [../proposals/new-project-join-process.md](application form). +4. Add your proposal to the Kubeflow Community call to introduce and collect feedback on +the application. +5. Work with the Kubeflow Outreach Committee to send an announcement email in `kubeflow-discuss` and publish messages on Slack, LinkedIn, X/Twitter, and other Kubeflow social resources +6. Schedule meeting with Kubeflow Steering Committee for initial vote and to collect feedback. +7. Identify the appropriate Kubeflow Working Group that should control the project. +8. Merge or close the Pull Request depending upon the outcome of the final vote. + +### Notes/Constraints/Caveats (Optional) + +Note that this application does not guarantee acceptance of the proposed project to Kubeflow. + +### Risks and Mitigations + +Two major risks for Kubeflow accepting projects are: +1. Accepting projects that do not have active contributors or a healthy user base +- This is why metrics are meant to capture this +2. Impacting the delivery speed of Kubeflow releases +- It will be expected that the maintainers invest in incorporating the project into the manifest or it will be removed +3. Additional infrastructure support +- It will be expected that the maintainers invest in providing this support + +## Drawbacks + +How could this new project harm the Kubeflow community? + +## Alternatives + +What other open source projects are there like the one proposed? +Why should Kubeflow accept the one proposed?