search

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 69 forks source link

SPIKE: Audit Sitewide products' impact for upcoming vets-website deployment changes #19780

Open randimays opened 2 weeks ago

randimays commented 2 weeks ago

Description

The Platform Reliability Team will be rolling out changes to the front end deployment pipeline for vets-website on 2/3/25. Slack announcement

If an application's code is not isolated, teams will not be able to deploy the application to production without Platform assistance.

We need to audit Sitewide products in vets-website and determine the impact of this change to each of our products.

Relatedly, we aren't sure how this change will impact Sitewide code that is not isolated to a src/applications folder (React widget or other componentized code). Jill requested some time to meet with the Reliability Team to understand how this would work. Slack thread

User story

AS A PO/PM/Delivery Manager/PW Teammember I WANT to understand how the PW team's applications will be affected by the above described change SO THAT we can make changes so that we don't have to rely on Platform assistance, or if we're unable to do that, plan to accommodate and plan for delays due to Platform assistance being required

Engineering notes / background

The below table can be used to assess code impact for Sitewide code in vets-website. Also, as part of the Frontend Support Dashboard, Platform has compiled a list of impacted applications that can be referenced: https://department-of-veterans-affairs.github.io/veteran-facing-services-tools/frontend-support-dashboard/cross-app-import-report/

Product Name Code Path Portfolio Impact
BTSSS Widget src/applications/static-pages/BTSSS-login PW TODO
CTA Widget src/applications/static-pages/cta-widget PW TODO
Discharge Upgrade Wizard src/applications/discharge-wizard PW ✅ None
Drupal Static Data src/platform/site-wide/drupal-static-data PW TODO
Find Forms src/applications/find-forms PW TODO
Homepage Search src/applications/static-pages/homepage PW TODO
Homepage Veteran Banner src/applications/static-pages/homepage-veteran-banner PW TODO
Income Limits src/applications/income-limits PW ✅ None
Language Toggles (i18Select) src/applications/static-pages/i18Select PW TODO
PACT Act Wizard src/applications/pact-act PW ✅ None
Public Outreach Materials src/applications/public-outreach-materials PW ✅ None
Resources & Support src/applications/resources-and-support PW ✅ None
Search src/applications/search PW ✅ None
Sitewide Announcements src/platform/site-wide/announcements PW TODO
Sitewide Banners src/platform/site-wide/banners PW TODO
TeamSites Helpers src/platform/site-wide/helpers/team-sites PW TODO
Side Nav src/platform/site-wide/side-nav CMS? PW? Fac? all 3? TODO
Events (search) src/applications/static-pages/events Fac / PW TODO
Facility Locator src/applications/facility-locator Fac TODO
Facilities Widgets src/applications/static-pages/facilities Fac TODO
Cerner / Healthcare CTAs src/applications/static-pages/health-care-manage-benefits Fac but transitioning to Health Tools, no hard date TODO

Analytics considerations

Testing & QA

Scope / Impact analysis

What, if anything, could break as a result of this change? Engineer should assess this when approaching PR.

Roles / assignments

After functional testing, code review, accessibility review, and design review can happen in parallel.

Acceptance criteria

_ACs should capture expected behavior, to inform test plans. Consider devices, documentation updates including KBs, change management, and content model when applicable._

randimays commented 2 weeks ago

Platform added messaging on Github PRs to indicate issues with app isolation and it linked to this report: https://department-of-veterans-affairs.github.io/veteran-facing-services-tools/frontend-support-dashboard/cross-app-import-report/ that appears to have done some of this investigation for us 🥳 I updated the description above with what's shown on this report.

jilladams commented 3 days ago

From a call with Joe Tice & Curt Bonade (Platform) + Michelle & Eli:

After this change from Platform:

jilladams commented 1 day ago

https://dsva.slack.com/archives/C04CYC4LMU6/p1732131652244929?thread_ts=1732129280.235259&cid=C04CYC4LMU6

Ideally the static-pages application would all be broken out into separate folders as a best practice. We should account for this in our audit here. We aren't sure what the solution is if an app can’t. It looks like there are a fair number of apps right now that import FROM static pages, and Platform will ask for those pieces to be relocated to the platform folder in possibly a subdirectory for static-pages.