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

Public resources for building on and in support of VA.gov. Visit complete Knowledge Hub:
https://depo-platform-documentation.scrollhelp.site/index.html
281 stars 197 forks source link

Launch new QA standard re endpoint monitoring (and modified SR requirements and required artifacts) #89357

Closed shiragoodman closed 3 days ago

shiragoodman commented 1 month ago

User Story

As a Governance team member, I want to launch and announce the changes to the QA Standards re: endpoint monitoring so that VFS teams can be prepared for upcoming Staging Reviews.

As a Governance team member, I want to launch and announce the changes to the SR requirements and required artifacts so that VFS teams can be prepared for scheduling an upcoming Staging Review.

Assignee: @briandeconinck Peer Reviewer: @it-harrison

Description

Note: This ticket includes the launch of the new endpoint monitoring QA standard as per the initiative, as well as the launch of the modified SR requirements (per ticket #88107) and the new SR required artifacts (per ticket #88140). The latter tickets were handled as tech-debt and are not affiliated with a larger initiative.

Since all changes impact the SR code blocks and the open Collab Cycle Request tickets, it makes it easier for Governance to launch and announce the changes together .

Impacted Artifacts

Live pages

Drafted pages

Tasks

Peer Review

To be completed by peer reviewer

Acceptance Criteria

Team Notification

How to prepare this issue

Refinement

shiragoodman commented 2 weeks ago

@humancompanion-usds We plan to launch the new QA standard for endpoint monitoring, and the SR requirements changes and required artifacts changes by end of sprint - Sep 10. However, we think it makes sense to not begin enforcing the new QA standard until Oct 1. Are you ok with that?

shiragoodman commented 2 weeks ago

@briandeconinck @it-harrison in my 1:1 with Matt on 8/30, we learned that there is an escalated priority of eliminating silent failures. This means that we will not be giving VFS teams any grace period at all for adhering to the new QA standard. When the new QA standard for endpoint monitoring is launched on September 10, VFS teams will be expected to meet standards right away. Meaning ay staging Review scheduled post 9/10 will need to meet ALL QA standards. I have updated the Description above with my 8/30 update.

This ticket is a priority! Please ensure everything is in order and on track to launch by September 10. If any issues come up at all, please notify @humancompanion-usds immediately. ty!

shiragoodman commented 2 weeks ago

also, @erinrwhite will be previewing these launch changes at the September 3 Team of Teams meeting and will be communicating the launch date of September 10. Please keep them informed as well if anything changes.

erinrwhite commented 1 week ago

@it-harrison has updated collab cycle tickets with this info as part of #91315 👍🏻

humancompanion-usds commented 1 week ago

@briandeconinck - Some content Steve and I would like to add to the QA Standard for endpoint monitoring:

Minimum requirements to meet this standard

  1. End point monitoring must cover the three fundamental types of problems: A. Unexpectedly high errors B. Unexpectedly low traffic C. Silent failures (silent to the end user) of any kind
  2. Don't ever include PII or PHI in logs!
  3. Errors that appear in DataDog should be routed to a Slack channel. (You should name this channel something like #(team name)-notifications
  4. The Slack channel should be monitored daily by the VFS team.
  5. The team should establish a process for acknowledging and assigning errors to a team member to investigate and resolve. (Playbook on this forthcoming)

Behaviors to avoid

briandeconinck commented 1 week ago

@it-harrison I have made edits to the draft QA Standards page to include the content @humancompanion-usds provided above -- mostly copy/paste, some slight changes to wording. Let me know if this all seems good to you. Not sure if you need to make any changes to your operational guidance based on Matt's notes.

Change history posts and change announcements are also ready to go. If the updates to the QA Standards page look good to you I'll begin moving things over to publish on Platform website.

it-harrison commented 1 week ago

@briandeconinck changes look awesome! thank you!

briandeconinck commented 1 week ago

Cool, thank you. I'll start getting things queued up for Platform website!

briandeconinck commented 1 week ago

Friday afternoon update:

briandeconinck commented 4 days ago

@it-harrison I believe all tasks on this are completed. Could you review just to make sure I didn't miss anything?

erinrwhite commented 4 days ago

Ben Brasso had a great clarifying suggestion to the entry point guidance on Slack, so I have added a sub-bullet of information to...

Change text is...

If the primary entry point is not a page on VA.gov, include information about how to view it. Reach out to @platform-governance-team-members on Slack with any questions.

it-harrison commented 3 days ago

@briandeconinck this is good to close!