Skip to content

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

Open
@swirtSJW

Description

@swirtSJW

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

  • Any VAMC system service using that term is re-saved and re-aliased.
  • Any VAMC facility service using that term is re-saved and re-aliased.
  • Any Vet Center Service using that term is re-saved and re-aliased.
  • Any VBA Service using that term is re-saved and re-aliased.
  • Any NCA Service (non-existent at this time) using that term is is re-saved and re-aliased.
  • Edit runbook to remove manual steps
  • Requires KB article update?
  • This magic is Documented

Design principles

Veteran-centered

  • Single source of truth: Increase reliability and consistency of content on VA.gov by providing a single source of truth.
  • Accessible, plain language: Provide guardrails and guidelines to ensure content quality.
  • Purposely structured content: Ensure Content API can deliver content whose meaning matches its structure.
  • Content lifecycle governance: Produce tools, processes and policies to maintain content quality throughout its lifecycle.

Editor-centered

  • Purpose-driven: Create an opportunity to involve the editor community in VA’s mission and content strategy goals.
  • Efficient: Remove distractions and create clear, straightforward paths to get the job done.
  • Approachable: Offer friendly guidance over authoritative instruction.
  • Consistent: Reduce user’s mental load by allowing them to fall back on pattern recognition to complete tasks.
  • Empowering: Provide clear information to help editors make decisions about their work.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions