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

Editor-centered management for Veteran-centered content.
https://prod.cms.va.gov
GNU General Public License v2.0
99 stars 70 forks source link

Add Product documentation for React widgets owned by Public Websites #17145

Open jilladams opened 5 months ago

jilladams commented 5 months ago

User Story or Problem Statement

As Public Websites product owner & team we want to have accurate product documentation for React widgets used on VA.gov for the sake of long-term ownership and maintenance.

Description or Additional Context

During USWDS V3 component migration, we identified that over the years Public Websites has created many React widgets that aren't listed in our product portfolio as products we own, and don't have top level product docs in https://github.com/department-of-veterans-affairs/va.gov-team/tree/master/products.

We need to get those documented, with 2 intentions:

  1. In case of contract transition, make sure existing product docs are comprehensive about what might need maintenance or iteration, in our portfolio
  2. Make docs available in case products need to be retired or moved to other teams

Question for FE Team members

We need a gut check from FE re: whether Jill's guesses in comments are spot-on, and if there are more widget sources to review, in order to determine what all Fran and Jill need to help get documented.

Tasks

  1. Audit https://github.com/department-of-veterans-affairs/vets-website/blob/main/src/applications/static-pages/widgetTypes.js for widgets owned by PW
  2. For any widgets owned but not documented, create docs

Acceptance Criteria

jilladams commented 5 months ago

Full list from https://github.com/department-of-veterans-affairs/vets-website/blob/main/src/applications/static-pages/widgetTypes.js. Box checked for anything I'm pretty sure we own:

There's another list here we may need to review? https://github.com/department-of-veterans-affairs/vets-website/blob/main/src/applications/static-pages/cta-widget/ctaWidgets.js#L16