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

Automate name and alias changes when service taxonomy name changes #7315

Open swirtSJW opened 2 years ago

swirtSJW commented 2 years ago

User Story or Problem Statement

As a maintainer of the health service taxonomy, I want to have any change in name reflected in system and facility service names and paths across the site so that it does not require a manual process.

Manual process that needs replicating

  1. Bulk resave system services to pick up name change (filtered for the old name)
  2. Bulk Update alias for all system services (filtered for new name)
  3. Bulk update facility services (filtered for the old name)
  4. Bulk update alias for all facility services (filtered for new name)

Implemenation details.

  1. Queueing and batching should be considered. Depending on the service, a change to the service could result in a save of up to ~1,400 services.
  2. Order of operations is critical. If 3 runs before 1 nothing gets fixed.
  3. We currently have logic that pushes all facility services if either a system service or VA service term changes. This would be redundant if saving a term resulted in a resave of all system and facility services using that term. The saves themselves would cause the push of each service instance.

Acceptance Criteria

When a VA service term is saved

Design principles

Veteran-centered

Editor-centered

swirtSJW commented 9 months ago

Please add your planning poker estimate with Zenhub @omahane

xiongjaneg commented 9 months ago

From Michelle: What's the timing on this? Do we need to do this manually for now?

Implementing this ticket could benefit Facility name changes and may be the more common use case for this.

@xiongjaneg look for the automate facilities name change ticket. Relates to #11628 The difference being that ticket requires an added step for redirects. There are some blockers to full automation for the facilities name change process that need resolution.

This ticket may come first because it has no external blockers.

xiongjaneg commented 9 months ago

@mmiddaugh For VRE, use the runbook template for that change.