From 72a20ab45588d45ea57e01ce0fe5955fd81ac4c0 Mon Sep 17 00:00:00 2001 From: Ghanshyam Mann Date: Thu, 24 Mar 2022 12:13:02 -0500 Subject: [PATCH] Add goal readiness checklist As discussed in Yoga PTG TC+PTL interaction sessions[1], adding goal checklist to know if goal is ready or not. Also, remove the goal schedule which was needed when goal were coupled with development cycle. [1] https://etherpad.opendev.org/p/tc-ptl-interaction Change-Id: I91c21233673c75f37461094dcf1fbb9ef4ca2e5e --- goals/index.rst | 87 +++++++++++++++++++++------------------------- goals/template.rst | 86 +++++++++++++++++++++++++++++++++------------ 2 files changed, 103 insertions(+), 70 deletions(-) diff --git a/goals/index.rst b/goals/index.rst index 5a41c786e..231e9f9a7 100644 --- a/goals/index.rst +++ b/goals/index.rst @@ -70,7 +70,41 @@ This separates the discussion for each goal, and allows authors to gradually refine and improve their proposal through multiple incremental changes. Goals should be discussed on the mailing list to collect feedback on their feasibility, and consensus on whether they have been completely and clearly -described. +described. Below checklist will help to know if goal is ready to be selected +or need more pre-work. + +Goal Checklist +~~~~~~~~~~~~~~ + +Below checklist provide a high-level view for goal readiness and the same is +mandatory to fill while proposing the goal. + ++-------------------+-------------------------------------+------------+ +| Item | Requirements | Catagory | ++===================+=====================================+============+ +| | | | +| Design | * Is design finalized? | Mandatory | +| | | | ++-------------------+-------------------------------------+------------+ +| | | | +| Implementation | * Are implementation details | Mandatory | +| | finalized? | | +| | | | ++-------------------+-------------------------------------+------------+ +| | | | +| Dependency & | * Is there any dependency or blocker| Mandatory | +| Blocker | in OpenStack or External software?| | +| | | | ++-------------------+-------------------------------------+------------+ +| | | | +| Current state | * Any project completed this goal? | Optional | +| | | | ++-------------------+-------------------------------------+------------+ +| | | | +| Meeting & | * Is there any regular meeting or | Optional | +| discussion | discussion planned where projects | | +| | can ask questions and get help? | | ++-------------------+-------------------------------------+------------+ Selecting goals --------------- @@ -198,52 +232,11 @@ implementation phase, and next steps if there are any. Goal Selection Schedule ======================= -To give enough time to projects and champion to implement each cycle -community-wide goals, TC has to make sure goals are selected before -the development cycle start. - -Below schedule is for the next (say N+1) cycle goals preparation -during the current (say N) cycle timeframe. - -+-------------------+-------------------------------------+-------------------------------------------------------+ -| Time | Phase | Tasks | -+===================+=====================================+=======================================================+ -| | | | -|Before Summit & | TC volunteer & `Identifying Goals`_ |- Identify the two TC volunteers to drive the process. | -|PTG of N release | |- Kick off the process to collect the goal ideas over | -| | | ML etc. | -| | | | -+-------------------+-------------------------------------+-------------------------------------------------------+ -| | | | -| | |- Find potential candidates for N+1 goals. | -|At Summit & PTG | |- This can be new ideas or from backlog of potential | -|of N release | Find potential goals & Champion | goals. | -| | |- Call for Champions for goal candidates (mutiple | -| | | champions are acceptable) | -| | |- This can be done via ML, Forum and PTG sessions. | -+-------------------+-------------------------------------+-------------------------------------------------------+ -| | | | -| | | | -| | |- TC volunteer to Report on required pre-work for all | -| | | identified potentials goal candidates. | -|Until Milestone-1 | Discussion |- Find volunteers for action taker on required | -|of N release | | pre-works | -| | |- TC need to review the report and the | -| | | vote for the readiness of goal. | -| | | | -+-------------------+-------------------------------------+-------------------------------------------------------+ -|Until Milestone-2 | | | -|of N release | `Defining Goals`_ | | -| | | | -+-------------------+-------------------------------------+-------------------------------------------------------+ -|Until Milestone-3 | | | -|of N release | `Selecting goals`_ | | -| | | | -+-------------------+-------------------------------------+-------------------------------------------------------+ -|Until N+1 | | | -|development cycle | Goal Implementation |- Champion & projects to start the goal implementation | -|start | | | -+-------------------+-------------------------------------+-------------------------------------------------------+ +During the PTG of every cycle, TC has to make sure some goals are selected +and in progress. If none are selected, then the TC should investigate possible +candidates to select as goals. There is no requirement of a minimum or maximum +number of selected goals; there can be zero or more based on the community and +champion bandwidth. Community goals =============== diff --git a/goals/template.rst b/goals/template.rst index af0b6310e..121d1678d 100644 --- a/goals/template.rst +++ b/goals/template.rst @@ -2,28 +2,54 @@ (one line goal description here) ================================== +Description +=========== + Explain what the goal is in general terms. Include the reasoning and justification for applying the goal to all OpenStack projects. -:Storyboard Board: -:Storyboard Story: -OR -:Etherpad: +Design & Implementation details +=============================== -Champion -======== +Add all the details about design, implementation, direction, etc or +link where these are explained. -Goals need a main driver to project-manage them to completion. Project teams -need assistance, reminders and sometimes direct help in order for them to -complete the goals. +Goal Checklist +============== -Gerrit Topic -============ +Is design finalized? (Mandatory) +-------------------------------- -To facilitate tracking, commits related to this goal should use the -gerrit topic:: +Status: + - +Is implemenation finalized? (Mandatory) +--------------------------------------- + +Status: + | + +Is there any dependency or blocker? (Mandatory) +----------------------------------------------- + +Status: + + +Current state (Optional) +------------------------ + +Provide a summary of the current state of any ongoing work related to +the goal, including projects that have completed the work already and +can serve as examples. + +Regular Meeting & Discussion (Optional) +--------------------------------------- + + Completion Date & Criteria ========================== @@ -50,18 +76,32 @@ Items to complete: . . +Champion +======== + +Goals need a main driver to project-manage them to completion. Project teams +need assistance, reminders and sometimes direct help in order for them to +complete the goals. + +Status & Tracking +================= + +:Storyboard Board: +:Storyboard Story: + OR +:Etherpad: + +Gerrit Topic +------------ + +To facilitate tracking, commits related to this goal should use the +gerrit topic:: + + + References ========== Provide reference links to previous discussions on the mailing list or IRC, etherpads, wiki pages, other forms of notes, and documentation that would be useful to a project team in working on the goal. - -Current State / Anticipated Impact -================================== - -Provide a summary of the current state of any ongoing work related to -the goal, including known blockers for any projects, projects that -have completed the work already and can serve as examples, or other -information useful to evaluate the scope of the goal and whether it -would fit into the time given.