Update guidance for creating SR issue tickets

shiragoodman commented 5 months ago

User Story

As a Governance team member, I want to have clear concise directions on how to publish Staging Review findings tickets so that VFS teams can be made aware of the issues we found.

Assignee: @erinrwhite Peer Reviewer: @shiragoodman

Description

In ticket #83388, @it-harrison defined a new way for Governance team to bulk upload issue tickets at Staging Review. This new method is an app for your desktop that utilizes the csv file created from the DraftingTemplate.

Now that the app is working as expected, Governance team needs to modify the How to generate SR issue tickets guidance so that it reflects the steps necessary with the new app.

Currently the guidance covers:

verifying the content within the DraftingTemplate is complete
creating the CSV file from the DraftingTemplate data
saving the CSV file properly on your local machine
running the bulk upload using node.js
verifying the issue tickets were created in the correct repo
notifying the Governance team of the issue tickets created

Some things that are currently missing:

archiving the DraftingTemplate file and/or folder within Google Drive
locating the QA Standards ticket

The purpose of this ticket is to restructure and better organize the existing guidance, while also incorporating use of the new upload tool created in ticket #83388.

Note: There should be no indication in this guidance of who is completing these steps. We plan to eventually task the On Support person with creating the SR issue tickets and notifying the team, however we still need to determine how Shira can be informed/notified of the tickets so she can monitor them for updates/questions from the VFS team.

Impacted Artifacts

How to generate SR issue tickets How to generate DST SR issue tickets

Tasks

[x] update How to generate SR issue tickets documentation
[x] update How to generate DST Staging Review tickets documentation
[x] fold in documentation about the uploader tool

Peer Review

To be completed by peer reviewer

[x] User story and acceptance criteria are met

Acceptance Criteria

[x] We have restructured the guidance so that is clear, easy to follow, easy to step away from and return knowing where you left off, and flows similarly to our other touchpoint guidance.
[x] We have incorporated use of the new bulk upload tool

Team Notification

[x] Slack post on #platform-governance-team
[ ] Presentation at Weekly Initiative Meeting
[ ] No notification needed

How to prepare this issue

Refinement

[x] Ticket has user story, description, tasks, and acceptance criteria
[x] Ticket has been sized
[x] Once all above items are checked, add the 'Ready' label.
Planning

If this ticket is picked up from the Backlog mid-sprint, connect with Shira to ensure the below items are completed correctly
[x] Ticket has been discussed as a team at Planning
[x] Ticket has been assigned to appropriate initiative or quarterly epic
[x] Ticket has been assigned to a Sprint
[x] Ticket has been moved to the Planned pipeline in the Governance team board
[x] Ticket as an assignee and peer reviewer

erinrwhite commented 5 months ago

Started draft page for How to generate Staging Review tickets

todo:

DST Staging Review tickets instructions
Fold in documentation about the uploader tool

erinrwhite commented 4 months ago

@shiragoodman docs ready for your first review!

shiragoodman commented 4 months ago

@erinrwhite I added comments to all 3 docs. Thank you for organizing this! Let me know if you have any questions about my comments.

erinrwhite commented 4 months ago

thank you @shiragoodman ! I think I got all of the feedback addressed. Please do one more-read through and then I can move the documentation over:

shiragoodman commented 4 months ago

@erinrwhite the changes look good! I tagged you in 1 comment re: a very minor issue. Feel free to publish to their forever home on Confluence. thank you!

erinrwhite commented 4 months ago

@shiragoodman thank you for the fast and thorough review! Reviewing now.

erinrwhite commented 4 months ago

We're live! @shiragoodman closing this ticket - can you check the peer review boxes when you have a chance?

shiragoodman commented 4 months ago

done - thank you @erinrwhite !

department-of-veterans-affairs / va.gov-team