Developer docs

Page-level cross-domain redirects for a subdomain that does NOT load proxy-rewrite JS

Last Updated: October 22, 2024

This document helps you to better understand aSubdomain to VA.gov redirect that does NOT load proxy-rewrite Java Script (JS). This is a page-level cross-domain redirect. For more information about redirects, return to the Redirect Implementation Strategy page.

The Sitewide Content, Accessibility & Information Architecture team (CAIA) reviews all URL redirects before routing them to the appropriate engineer.

Before you attempt a redirect, follow these two important steps:

  1. File a redirect request ticket on GitHub.

  2. Read the Design System guidance for redirects.

This is a client-side redirect

Subdomain to VA.gov redirects are client-side redirects for TeamSites that do not use the Injected Header, or load proxy-rewrite JS. Subdomain to VA.gov redirects for TeamSites without proxy-rewrite JS require identifying TeamSite admins.

Client-side redirects should only be used when absolutely necessary.

Information Table: Subdomainto VA.gov Redirects

Below is a table that outlines the details of a Subdomainto VA.gov redirect.

Subdomain to VA.gov: Page-level cross-domain redirect for a subdomain that does NOT load proxy-rewrite JS

When to use this redirect:

When a single page within a TeamSite should redirect to VA.gov , and that TeamSite does not load proxy-rewrite JS.

  • For subdomains that do not use the Injected Header.

Additional Info:

You can verify if a site loads proxy-rewrite by checking the proxy-rewrite-whitelist.json.

This redirect is dependent on VA stakeholders.

Team Responsibilities:

CAIA must sign off on request.

Requesting team must follow WebOps KB article steps to file a WebOps ticket to start the process.

  • WebOps must help identify the owner of the TeamSite.

  • TeamSite admins who are identified will then be asked to execute the redirect.

Additional Info:

You can verify if a site loads proxy-rewrite by checking the proxy-rewrite-whitelist.json.

Typically these sites will display the injected modernized header/footer, but in some cases, sites may load the proxy-rewrite JS but not yet display the injected header. proxy-rewrite-whitelist.json is the source of truth.

Team Responsibilities:

CAIA must sign off on request.

Special Note

Do not archive redirected TeamSite pages. Instead, product team should implement the client-side redirect, with additional ask of VA stakeholder to:

  1. ✅ Replace their page content with a 'redirect' message and

  2. ✅ Update their print materials and nav links with the new URL

Additional Resources


Help and feedback