Difference between revisions of "Project Proposals"

From fd.io
Jump to: navigation, search
(→‎Instructions for Submitting New Project Proposals)
 
(40 intermediate revisions by 22 users not shown)
Line 1: Line 1:
 
== Instructions for Submitting New Project Proposals ==
 
== Instructions for Submitting New Project Proposals ==
  
−
# Review the [https://fd.io/sites/cpstandard/files/pages/files/exhibit_c_-_fd.io_technical_community_charter.pdf Technical Community Charter] to get a clear picture of how projects work in fd.io.
+
# Review the [https://fd.io/docs/tsc/FD.IO-Project-a-Series-of-LF-Projects-LLC-Technical-Charter-12-13-2017-FINAL.pdf Technical Community Charter] to get a clear picture of how projects work in fd.io.
−
# Replace ${projectname} in the URL https://wiki.fd.io/view/Project_Proposals/${projectName}?action=edit&preload=Project_Proposals/Template and enter it in your browser bar.
+
# Replace ${projectname} in the URL https://wiki.fd.io/view/Project_Proposals/${projectName}?action=edit&preload=Project_Proposals/Template and enter it in your browser bar.  This will copy in the [[Project_Proposals/Template|Project Proposal Template]] into your new page.
 
# Fill out the template and save your new project proposal page.
 
# Fill out the template and save your new project proposal page.
 
## Please indicate if you are planning to contribute existing code, or start a new project from scratch.
 
## Please indicate if you are planning to contribute existing code, or start a new project from scratch.
−
# When you are happy with your proposal, send email to [mailto:project-lifecycle@lists.fd.io  project-lifecycle@lists.fd.io] using this [[Project_Proposals/Project Proposal Email Template|email template]].
+
# Add a link to your proposal to [[Project_Proposals#Project_Proposals|the Project Proposals Section of this page]].
 +
# When you are happy with your proposal, send email to [mailto:tsc@lists.fd.io  tsc@lists.fd.io] using this [[Project_Proposals/Project Proposal Email Template|email template]].
 +
## You should expect questions and feedback on your proposal from the community in response to your email, please be prepared to respond and engage.
 
# Prepare your existing code for contribution. [[Project_Proposals/Code_Prep_Suggestions|here]].
 
# Prepare your existing code for contribution. [[Project_Proposals/Code_Prep_Suggestions|here]].
 
# Submit your code to the fd.io Foundation for IPR Review.
 
# Submit your code to the fd.io Foundation for IPR Review.
Line 13: Line 15:
 
The last step before your project is created is your Creation Review before the [[TSC#Meeting_Schedule_and_Logistics|fd.io TSC]].
 
The last step before your project is created is your Creation Review before the [[TSC#Meeting_Schedule_and_Logistics|fd.io TSC]].
  
−
# You can ask for your creation review to be scheduled for any TSC meeting that is more than two weeks after the proposal was e-mailed to the [mailto:project-proposals@lists.fd.io project-proposals] list.
+
# You can ask for your creation review to be scheduled for any TSC meeting that is more than two weeks after the proposal was e-mailed to the [mailto:tsc@lists.fd.io tsc] list.
−
## Please e-mail the [mailto:tsc@lists.fd.io tsc] list to schedule the proposal.
+
## Please e-mail the [mailto:tsc@lists.fd.io tsc] list to schedule the proposal using this [[Project Proposals/Creation Review Request Email Template|email template]].
 
## It may not be possible to schedule the creation review on the requested day, the TSC does it's best to accommodate requests.
 
## It may not be possible to schedule the creation review on the requested day, the TSC does it's best to accommodate requests.
 
# Creation reviews typically last 20–30 minutes.
 
# Creation reviews typically last 20–30 minutes.
Line 27: Line 29:
 
## How should we expect it to interact with other related components and projects that are already in fd.io?
 
## How should we expect it to interact with other related components and projects that are already in fd.io?
 
## How would an user interact with it? any user story to illustrate?
 
## How would an user interact with it? any user story to illustrate?
 +
## Is this work that can be done in existing projects?  If there is overlap with existing projects, why are you choosing to start a new project?
 +
 +
== After Your Creation Review ==
 +
 +
Once your project has been formally approved by the TSC, you'll want to start getting it set up.
 +
 +
* Make sure any code you are bringing in goes through IPR Review.
 +
* Look at the [[Projects/New Project Checklist|New Project Checklist]]
 +
** Of particular note, create a main wiki page for your project using the [[Template:Project Facts|project facts template]] so that people can find key information about your project and so that it appears in the Project List.
 +
* The first thing you'll want to do is to email the fd.io [mailto:helpdesk@fd.io helpdesk] with a link to the TSC minutes (or TSC list e-mail) showing your creation review approval asking for your resources to be set up.
 +
* After that, you should start working through the tasks on the checklist.
 +
** At the very least, you can set up your main project wiki page with the key facts while your infrastructure is being set up.
  
 
== Project Proposals ==
 
== Project Proposals ==
−
<DynamicPageList>
+
* https://wiki.fd.io/view/Project_Proposals/CSIT
−
category = Project Main Pages
+
* https://wiki.fd.io/view/Project_Proposals/Honeycomb
−
ordermethod = categorysortkey
+
* https://wiki.fd.io/view/Project_Proposals/NSH_SFC
−
order = ascending
+
* https://wiki.fd.io/view/Project_Proposals/Overlay_Network_Engine
−
</DynamicPageList>
+
* https://wiki.fd.io/view/Project_Proposals/TLDK
 +
* https://wiki.fd.io/view/Project_Proposals/VPPSandbox
 +
* https://wiki.fd.io/view/Project_Proposals/pkg-dpdk
 +
* https://wiki.fd.io/view/Project_Proposals/ci-management
 +
* https://wiki.fd.io/view/Project_Proposals/TRex
 +
* https://wiki.fd.io/view/Project_Proposals/puppet-fdio
 +
* https://wiki.fd.io/view/Project_Proposals/honeycomb-vpp
 +
* https://wiki.fd.io/view/Project_Proposals/processing_pipeline
 +
* https://wiki.fd.io/view/Project_Proposals/govpp
 +
* https://wiki.fd.io/view/Project_Proposals/odp4vpp
 +
* https://wiki.fd.io/view/Project_Proposals/p4vpp
 +
* https://wiki.fd.io/view/Project_Proposals/pma_tools
 +
* https://wiki.fd.io/view/Project_Proposals/cicn
 +
* https://wiki.fd.io/view/Project_Proposals/DMM
 +
* https://wiki.fd.io/view/Project_Proposals/Sweetcomb
 +
* https://wiki.fd.io/view/Project_Proposals/hicn
 +
* https://wiki.fd.io/view/Project_Proposals/JVPP
 +
* https://wiki.fd.io/view/Project_Proposals/opflex-vpp-renderer
 +
* https://wiki.fd.io/view/Project_Proposals/uDPI
 +
* https://wiki.fd.io/view/Project_Proposals/VSAP

Latest revision as of 20:05, 7 April 2022

Instructions for Submitting New Project Proposals

  1. Review the Technical Community Charter to get a clear picture of how projects work in fd.io.
  2. Replace ${projectname} in the URL https://wiki.fd.io/view/Project_Proposals/${projectName}?action=edit&preload=Project_Proposals/Template and enter it in your browser bar. This will copy in the Project Proposal Template into your new page.
  3. Fill out the template and save your new project proposal page.
    1. Please indicate if you are planning to contribute existing code, or start a new project from scratch.
  4. Add a link to your proposal to the Project Proposals Section of this page.
  5. When you are happy with your proposal, send email to tsc@lists.fd.io using this email template.
    1. You should expect questions and feedback on your proposal from the community in response to your email, please be prepared to respond and engage.
  6. Prepare your existing code for contribution. here.
  7. Submit your code to the fd.io Foundation for IPR Review.

Guidelines for your Creation Review

The last step before your project is created is your Creation Review before the fd.io TSC.

  1. You can ask for your creation review to be scheduled for any TSC meeting that is more than two weeks after the proposal was e-mailed to the tsc list.
    1. Please e-mail the tsc list to schedule the proposal using this email template.
    2. It may not be possible to schedule the creation review on the requested day, the TSC does it's best to accommodate requests.
  2. Creation reviews typically last 20–30 minutes.
    1. People usually either bring slides or just use their proposal if it goes into sufficient detail.
    2. A few diagrams of the major components and how they interact are often useful.
    3. If you plan to use slides, please upload them to the wiki ahead of time so that people can see them without needing WebEx screensharing to work as it's often annoying to get to work on Linux.
    4. We conduct the meeting on IRC as well as WebEx, so it's useful to have the slides posted to the wiki before the meeting, that way we can link them in.
    5. You can find details about both the WebEx and IRC on the TSC page
  3. Common questions that come up are:
    1. Is the committer list complete?
    2. What problem is being solved here? What is the scope of the project?
    3. How should we expect it to interact with other related components and projects that are already in fd.io?
    4. How would an user interact with it? any user story to illustrate?
    5. Is this work that can be done in existing projects? If there is overlap with existing projects, why are you choosing to start a new project?

After Your Creation Review

Once your project has been formally approved by the TSC, you'll want to start getting it set up.

  • Make sure any code you are bringing in goes through IPR Review.
  • Look at the New Project Checklist
    • Of particular note, create a main wiki page for your project using the project facts template so that people can find key information about your project and so that it appears in the Project List.
  • The first thing you'll want to do is to email the fd.io helpdesk with a link to the TSC minutes (or TSC list e-mail) showing your creation review approval asking for your resources to be set up.
  • After that, you should start working through the tasks on the checklist.
    • At the very least, you can set up your main project wiki page with the key facts while your infrastructure is being set up.

Project Proposals

Retrieved from "https://wiki.fd.io/index.php?title=Project_Proposals&oldid=11671"