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
283 stars 204 forks source link

Redesign New VFS Team Member gh template #94448

Open shiragoodman opened 4 weeks ago

shiragoodman commented 4 weeks ago

User Story

As a Governance team member, I want to redesign the New VFS Team Member gh template to include only the administrative tasks so that the ticket is simpler for VFS teams to complete and easier for Platform to take action.

Assignee: @allison0034 Peer Reviewer: @erinrwhite

Description

In the last few tickets, Governance has been working to separate the educational tasks associated with Platform Orientation from the administrative tasks. This is so that we can only keep the administrative tasks within the GH template because these are the only tasks Platform actually validates for completion. Platform has our own tasks associated with Platform Orientation, seen under the Platform Checklist section of the current New VFS Team Member gh template, and several of the VFS administrative tasks are prerequisites for the Platform tasks. The educational tasks will soon be moved to live on Platform Website.

The purpose of this ticket is to redesign the New VFS Team Member gh template to limit it only to the administrative tasks for the VFS team member to complete, as well as the Platform Checklist items that Platform will complete. The redesign should also include a link to the educational tasks on Platform Website (this will have to be a placeholder as this page does not yet exist), and the instructions at the top of the current template should be streamlined.

In December 2022, Governance completed some user research on the Platform Orientation process and the research findings may still be valuable for reference when redesigning the template.

Lastly, it is recommended that the redesign of the New VFS Team Member template be completed in Confluence, and a pull request is NOT created. This is because it still may be sometime before the template is published, and we don't want the pull request to be accidentally merged before it's ready. Do NOT publish any changes to the New VFS Team Member template as part of the scope of this ticket.

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

allison0034 commented 5 days ago

Created PR

shiragoodman commented 5 days ago

@allison0034 are you going to be converting this to a YAML template? Have we considered that? I imagine there's some pros and cons to it. LMK what you think.

allison0034 commented 5 days ago

@shiragoodman I am not sure yet, I wanted to see what this would look like once restructured.

shiragoodman commented 4 days ago

@allison0034 since the template has both VFS actions, and then Platform actions, we'd like to have both there without manually adding anything after the ticket is submitted. IIRC, YAML does not allow for the Platform actions show up after the ticket is submitted... they must be present from the start which I'm not sure will work out too well with VFS teams. I'd imagine they would attempt to complete that section. @briandeconinck does that sound right to you?

I'm wondering if it might make sense to pull Platform Support team in now, since they're the team from Platform who will be interacting with this template, and see what their preference is.

allison0034 commented 4 days ago

@shiragoodman I just spoke with Brian and I don't think YAML will be a good fit for this. The only benefit would be adding text boxes to the things like "name" but once they submit, they will lose all static text and will not be able to edit unless they look at the markdown file.

erinrwhite commented 3 days ago

Reviewed the PR #96178 and left some comments 👍🏻

allison0034 commented 17 hours ago

Chatted with Shira, educational tasks need to be removed. After removing those, I believe this would be a good candidate for YAML... so now I am YAMLING!