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

Spike: LOE for URL change request from IA #88117

Closed aplatt-coforma closed 1 month ago

aplatt-coforma commented 1 month ago

Background: The IA team has done an audit and requested major URL changes. The spreadsheet can be found here

Slack discussions for context: https://dsva.slack.com/archives/C05MS96P6P2/p1711719332619779 and https://dsva.slack.com/archives/C05MS96P6P2/p1719952820408009

In this ticket, the size of effort and what this level of change will touch within our code and reporting.

Acceptance Criteria:

mjknight50 commented 1 month ago

This change should be relatively straight forward. For each entry in the spreadsheet, we will need to find the corresponding page in vets-website.

For example, withinsrc/applications/pensions/config/chapters/01-applicant-information/applicantInformation.js we would change the path on line 49 to the new path of veteran-info

For each page that is changed, we will also need to do a migration in src/applications/pensions/migrations.js

Something like this:

// 9 > 10
  // This migration handles the url changes that have been made throughout
  // the pension form.  This was part of an initiative to update the form urls
  // so they are up to date with standards set by CAIA
  ({ formData, metadata }) => {
    const newFormData = { ...formData };
    const newMetadata = { ...metadata };
    // check if the user has history
    if (formData['view:history']) {
      // TODO: either do a dictionary or switch here, returning the new url
      // newMetadata.returnUrl = '/applicant/information';
      // delete newFormData['view:history'];
    }
    return { formData: newFormData, metadata: newMetadata };
  },

My estimate is that this would 3 points.

mjknight50 commented 1 month ago

@matt4su - Leaving this here for your visibility and for you to prioritize

matt4su commented 1 month ago

@mjknight50 would it be possible to provide more info on analytics impact around the change (ga4, datadog, domo)?

mjknight50 commented 1 month ago

https://dsva.slack.com/archives/C1Q4294JJ/p1722439140419169

There's not a way to map old and new URLs in GA.

For Domo, you can have the Forms dashboard updated with the new URLs using the Analytics Product KPI Dashboard - Request and Update Template