From 6d40964c526edba763fceaf0fb81349273fa5db1 Mon Sep 17 00:00:00 2001 From: Francisco Javier Arceo Date: Fri, 23 Aug 2024 11:45:26 -0400 Subject: [PATCH 1/3] Adding a proposal for new projects to be included in KF Signed-off-by: Francisco Javier Arceo --- add-ons/APPLICATION_TEMPLATE.md | 146 ++++++++++++++++++++++ proposals/new-project-addition-process.md | 36 ++++++ 2 files changed, 182 insertions(+) create mode 100644 add-ons/APPLICATION_TEMPLATE.md create mode 100644 proposals/new-project-addition-process.md diff --git a/add-ons/APPLICATION_TEMPLATE.md b/add-ons/APPLICATION_TEMPLATE.md new file mode 100644 index 000000000..62b86c4ad --- /dev/null +++ b/add-ons/APPLICATION_TEMPLATE.md @@ -0,0 +1,146 @@ +# New Project Project Application + + + + +## Background information + +1. Submitter Name +- +2. Submitter’s relationship to project / title +- +3. Project Name +- +4. Why this project is valuable to the Kubeflow Community +- +5. Short Description / Functionality +- +6. Website +- +7. GitHub repository +- +8. 1st Release date +- +9. Project Meeting Times +- +10. Meeting Notes (link) +- +11. Installation Documentation (provide status and link) +- +12. Application Documentation (provide status and link) +- +13. Security Profile (CVE scanning) +- +14. Ownership / Legal Profile (license type, any potential issues for CNCF) +- +15. Kubernetes native (K8s version) +- +16. AuthN/Z, Isolation mechanisms +- +17. Project Roadmap +- +18. Other Information +- + +## Metrics + +Number of Contributors +- [ ] 1 +- [ ] <10 +- [ ] 10+ + +Number of Users +- [ ] 1 +- [ ] <10 +- [ ] 10+ + +GitHub Pull Requests in the last 90 days +- [ ] 1 +- [ ] <10 +- [ ] 10+ + +Number of Releases +- [ ] No release +- [ ] 1 release +- [ ] 2+ releases + +Downloads +- [ ] <100 +- [ ] <10k +- [ ] 10k+ + +## Kubeflow Specific Questions +1. Kubeflow specific Roadmap + - [ ] Yes + - [ ] No + - Link +2. Workflows that integrate with Kubeflow Components +- [ ] 1 +- [ ] 2 +- [ ] 3+ +3. Manifest Integration + - [ ] Yes + - [ ] No + - [ ] Planned +4. Installation + - [ ] Testing + - [ ] Stand alone + - [ ] Part of Manifests + - [ ] Part of Distributions +5. Application + - [ ] Testing + - [ ] Stand alone + - [ ] Part of Kubeflow workflow +6. Installation Documentation (Current Quality) + - [ ] Good + - [ ] Fair + - [ ] Part of Kubeflow +7. Application Documentation (Current Quality) + - [ ] Good + - [ ] Fair + - [ ] Part of Kubeflow +8. Kubeflow Website Documentation + - [ ] Yes + - [ ] No + - Pull Request # +9. Distributions position on added testing, docs + - [ ] 0 Distribution + - [ ] 1 Distribution + - [ ] 2+ Distributions +10. Blog/Social Media announcements + - [ ] Yes + - [ ] No + - Pull Request # + +## Level of Integration and Support Sought by Kubeflow +1. What level? + - [ ] Add-on + - [ ] Core +2. IP Ownerhsip + - [ ] Stand Alone + - [ ] Merge into Kubeflow/CNCF +3. Kubeflow Working Group + - [ ] None + - [ ] New + - [ ] Part of Existing +4. Posting Meetings on Kubeflow Calendar + - [ ] Yes + - [ ] No +5. Use of Zoom Accounts + - [ ] Yes + - [ ] No +6. Repository Ownership + - [ ] Yes + - [ ] No +7. Pull request Approvers + - [ ] Yes + - [ ] No +8. Posting on Kubeflow Social Media, blog, and website + - [ ] Yes + - [ ] No + - [ ] Collaborate diff --git a/proposals/new-project-addition-process.md b/proposals/new-project-addition-process.md new file mode 100644 index 000000000..7cfd3df43 --- /dev/null +++ b/proposals/new-project-addition-process.md @@ -0,0 +1,36 @@ +## Motivation +As Kubeflow has become a well established ecosystem and community, several +projects may want to be incorporated into Kubeflow in different capacities. + +That may include: +1. Project Donation +2. Inclusion in the Manifest +3. Inclusion in documentation as an add on + +This proposal aims to give guidelines and set expectations for community +members about the application process. + +## Goals +The goal of this proposal is to provide a clear process for being included in +the Kubeflow ecosystem. + +## Non-Goals +Give specific recommendations for evaluating any individual project. + +## UI or API +N/A + +## Design +Project owners or maintainers will apply for inclusion by following a four +step process. submitting the + +The process is outlined in 4 steps: + +1. Submit a Pull Request with the [../add-ons/APPLICATION_TEMPLATE.md](application form). +2. Schedule meeting with Kubeflow Community to introduce and collect feedback on +the application. +3. Schedule meeting with Kubeflow Steering Committee for initial vote and to collect feedback. +4. Merge or close the Pull Request depending upon the outcome of the final vote. + +## Alternatives Considered +N/A From 83219a826972961754e0a88a72186aca7f56bc7f Mon Sep 17 00:00:00 2001 From: Francisco Javier Arceo Date: Fri, 23 Aug 2024 11:50:31 -0400 Subject: [PATCH 2/3] Updating format Signed-off-by: Francisco Javier Arceo --- add-ons/APPLICATION_TEMPLATE.md | 37 +++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/add-ons/APPLICATION_TEMPLATE.md b/add-ons/APPLICATION_TEMPLATE.md index 62b86c4ad..4955c9296 100644 --- a/add-ons/APPLICATION_TEMPLATE.md +++ b/add-ons/APPLICATION_TEMPLATE.md @@ -12,38 +12,55 @@ In short, copy this Application Template and populate the document. 1. Submitter Name - + 2. Submitter’s relationship to project / title - + 3. Project Name - + 4. Why this project is valuable to the Kubeflow Community - + 5. Short Description / Functionality - + 6. Website - + 7. GitHub repository - + 8. 1st Release date - + 9. Project Meeting Times - + 10. Meeting Notes (link) - + 11. Installation Documentation (provide status and link) - + 12. Application Documentation (provide status and link) - + 13. Security Profile (CVE scanning) - + 14. Ownership / Legal Profile (license type, any potential issues for CNCF) - + 15. Kubernetes native (K8s version) - + 16. AuthN/Z, Isolation mechanisms - + 17. Project Roadmap - + 18. Other Information - @@ -75,72 +92,92 @@ Downloads - [ ] 10k+ ## Kubeflow Specific Questions + 1. Kubeflow specific Roadmap - [ ] Yes - [ ] No - Link + 2. Workflows that integrate with Kubeflow Components - [ ] 1 - [ ] 2 - [ ] 3+ + 3. Manifest Integration - [ ] Yes - [ ] No - [ ] Planned + 4. Installation - [ ] Testing - [ ] Stand alone - [ ] Part of Manifests - [ ] Part of Distributions + 5. Application - [ ] Testing - [ ] Stand alone - [ ] Part of Kubeflow workflow + 6. Installation Documentation (Current Quality) - [ ] Good - [ ] Fair - [ ] Part of Kubeflow + 7. Application Documentation (Current Quality) - [ ] Good - [ ] Fair - [ ] Part of Kubeflow + 8. Kubeflow Website Documentation - [ ] Yes - [ ] No - Pull Request # + 9. Distributions position on added testing, docs - [ ] 0 Distribution - [ ] 1 Distribution - [ ] 2+ Distributions + 10. Blog/Social Media announcements - [ ] Yes - [ ] No - Pull Request # ## Level of Integration and Support Sought by Kubeflow + 1. What level? - [ ] Add-on - [ ] Core + 2. IP Ownerhsip - [ ] Stand Alone - [ ] Merge into Kubeflow/CNCF + 3. Kubeflow Working Group - [ ] None - [ ] New - [ ] Part of Existing + 4. Posting Meetings on Kubeflow Calendar - [ ] Yes - [ ] No + 5. Use of Zoom Accounts - [ ] Yes - [ ] No + 6. Repository Ownership - [ ] Yes - [ ] No + 7. Pull request Approvers - [ ] Yes - [ ] No + 8. Posting on Kubeflow Social Media, blog, and website - [ ] Yes - [ ] No - [ ] Collaborate + + From 9956a96c103e4e2c2b9b4e4248528a1fb1085d9a Mon Sep 17 00:00:00 2001 From: Francisco Javier Arceo Date: Fri, 23 Aug 2024 11:53:16 -0400 Subject: [PATCH 3/3] Removing commented out section Signed-off-by: Francisco Javier Arceo --- add-ons/APPLICATION_TEMPLATE.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/add-ons/APPLICATION_TEMPLATE.md b/add-ons/APPLICATION_TEMPLATE.md index 4955c9296..6c5edfa8a 100644 --- a/add-ons/APPLICATION_TEMPLATE.md +++ b/add-ons/APPLICATION_TEMPLATE.md @@ -1,8 +1,7 @@ # New Project Project Application -