Grid Release Story Procedures and Documentation #125

New Issue

mik-tf · 2024-11-04T18:45:26Z

mik-tf commented

2024-11-04 18:45:26 +00:00

Situation

We strive for concrete and clear procedures and documentation for the upcoming grid releases
To achieve effective management of the 3.16 project and the future releases, we can define specs for issues
A grid release is well accomplished if:
- It has clear specs defined at the beginning of the project
- The specs are turned into clear stories filled with proper information (see below)
- Stories are completed within the given ETA and stakeholders confirm the work done

Grid Release Timeline

Each Grid Release Project should have a story presenting the Grid Release Timeline, as shown below (e.g. see here)

Stakeholders meet and define the grid release specs
Specs are turned into stories
Stakeholders confirm the stories as fulfilling the specs and grid release goals
Stories are worked on
When a grid release project is completed
- Stakeholders meet and review the stories, confirming they are correctly done
- A post summarizing the GEP is posted on the forum, written by Ops (Sabrina)
- A post explaining in detail the new grid release features is posted on the forum, written by comms
When the GEP is passed, devs and ops implement the new features of the grid (e.g. publish to all networks)

Story Metadata

Metadatas should be completed for each story to facilitate tracking and realization. The important metadata are: due date, project, label and assignees.

Grid Release and Stories ETA

Each story has a clear ETA set as Due Date in gitea metadata
Each grid release has a clear ETA set as Due Date in gitea metada
- This is done in the Grid Release Timeline story, e.g. 3.16 see this: #126

Owners of Story

The people assigned as Assignees are the Owners of the story
- The owners need to make sure people do the work and that there are executable issues on GitHub or on Gitea

Project

Each story should be within a given project (e.g. 3.16)

Labels

Each story should be labelled as Story

Stories Status

Stories have status defined by their position on the project kanban. There are 5 columns:

To Define
- Stakeholders need to discuss the story and complete the info (e.g. ETA, Owners, Assignees, etc.)
To Do
- A story has been defined and has not yet been started
In Progress
- A story being worked on
Blocked
- If it is blocked, stakeholders must make sure it gets fixed
- If stakeholders can't fix it, it must be escalated to Kristof
Done
- Once a story is completed, it's closed

Moved or Updated

Also, a story can be moved or updated.

Moved
- We can define that the story is better for a future release, so we move it
- Moved story should maintain info related to original issues (e.g. google docs link)
Updated
- If a story is updated, it must be done with the approval of all stakeholders

Story Template

Each story should follow a basic template to make sure they all satisfy the project goals.
- Engineering Circle Story Template: https://git.ourworld.tf/tfgrid/circle_engineering/issues/new?template=.gitea%2fissue_template%2fstory_template.md

# Situation - We strive for concrete and clear procedures and documentation for the upcoming grid releases - To achieve effective management of the 3.16 project and the future releases, we can define specs for issues - A grid release is well accomplished if: - It has clear specs defined at the beginning of the project - The specs are turned into clear stories filled with proper information (see below) - Stories are completed within the given ETA and stakeholders confirm the work done # Grid Release Timeline Each Grid Release Project should have a story presenting the Grid Release Timeline, as shown below (e.g. see [here](https://git.ourworld.tf/tfgrid/circle_engineering/issues/126)) - Stakeholders meet and define the grid release specs - Specs are turned into stories - Stakeholders confirm the stories as fulfilling the specs and grid release goals - Stories are worked on - When a grid release project is completed - Stakeholders meet and review the stories, confirming they are correctly done - A post summarizing the GEP is posted on the forum, written by Ops (Sabrina) - A post explaining in detail the new grid release features is posted on the forum, written by comms - When the GEP is passed, devs and ops implement the new features of the grid (e.g. publish to all networks) # Story Metadata Metadatas should be completed for each story to facilitate tracking and realization. The important metadata are: due date, project, label and assignees. ## Grid Release and Stories ETA - Each story has a clear ETA set as Due Date in gitea metadata - Each grid release has a clear ETA set as Due Date in gitea metada - This is done in the Grid Release Timeline story, e.g. 3.16 see this: https://git.ourworld.tf/tfgrid/circle_engineering/issues/126 ## Owners of Story - The people assigned as Assignees are the Owners of the story - The owners need to make sure people do the work and that there are executable issues on GitHub or on Gitea ## Project - Each story should be within a given project (e.g. 3.16) ## Labels - Each story should be labelled as Story # Stories Status Stories have status defined by their position on the project kanban. There are 5 columns: - To Define - Stakeholders need to discuss the story and complete the info (e.g. ETA, Owners, Assignees, etc.) - To Do - A story has been defined and has not yet been started - In Progress - A story being worked on - Blocked - If it is blocked, stakeholders must make sure it gets fixed - If stakeholders can't fix it, it must be escalated to Kristof - Done - Once a story is completed, it's closed ## Moved or Updated Also, a story can be moved or updated. - Moved - We can define that the story is better for a future release, so we move it - Moved story should maintain info related to original issues (e.g. google docs link) - Updated - If a story is updated, it must be done with the approval of all stakeholders # Story Template - Each story should follow a basic template to make sure they all satisfy the project goals. - Engineering Circle Story Template: https://git.ourworld.tf/tfgrid/circle_engineering/issues/new?template=.gitea%2fissue_template%2fstory_template.md

mik-tf added the

Story

label 2024-11-04 18:45:26 +00:00

mik-tf added this to the tfgrid_3_16 project 2024-11-04 18:45:26 +00:00

Sign in to join this conversation.