Skip to content

docs: update sparkpost.com/docs links to docs.sparkpost.com subdomain#858

Merged
danielfsousa merged 4 commits into
mainfrom
docs/update-links
Jul 14, 2026
Merged

docs: update sparkpost.com/docs links to docs.sparkpost.com subdomain#858
danielfsousa merged 4 commits into
mainfrom
docs/update-links

Conversation

@danielfsousa

@danielfsousa danielfsousa commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Summary

  • SparkPost's docs site canonical host moved from www.sparkpost.com/docs to docs.sparkpost.com/docs (see Migrate base URL from archive.sparkpost.com to docs.sparkpost.com #857, which migrated the site's own hosting config). This PR updates the 68 outbound content links that still pointed at the old www.sparkpost.com/docs host.
  • Mechanical www.sparkpost.com/docsdocs.sparkpost.com/docs substring replace; no other links touched.

Test plan

  • Spot-check a few updated links render correctly

Note

Low Risk
Documentation and navigation URL changes only; no application logic or runtime behavior is affected.

Overview
Updates outbound documentation URLs from www.sparkpost.com/docs to docs.sparkpost.com/docs across the site logo and a large set of markdown articles (getting started, FAQ, integrations, reporting, tech resources, user guides, etc.), aligning in-repo links with the docs host migration.

A handful of edits go beyond host substitution: some anchor fragments were refreshed (e.g. domain verification headings), cross-links now target sp-metrics-definitions instead of metrics-definitions, webhook setup references use developers.sparkpost.com/api/webhooks where the old user-guide paths pointed, and a couple of stale inline links or sentences were dropped.

Reviewed by Cursor Bugbot for commit a6dd905. Bugbot is set up for automated code reviews on this repo. Configure here.

@netlify

netlify Bot commented Jul 9, 2026

Copy link
Copy Markdown

Deploy Preview for support-docs ready!

Name Link
🔨 Latest commit a6dd905
🔍 Latest deploy log https://app.netlify.com/projects/support-docs/deploys/6a5170b6ebbaaf000862c3f3
😎 Deploy Preview https://deploy-preview-858--support-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

…swap

Several outbound links pointed at anchors/paths that no longer exist on
the docs site (predating this migration, just mechanically host-swapped):
- getting-started-sparkpost/#step-2-verifying-domain-ownership and
  #sending-domain-step-2-verifying-domain-ownership -> the real heading id
  is #step-2-verify-domain
- /docs/transmissions-breaking-changes -> missing the /tech-resources/
  path segment
- /docs/reporting/metrics-definitions/ -> page is now at
  /docs/reporting/sp-metrics-definitions/
- creating-template/#authoring-html-content-for-your-templates and
  #authoring-text-content-for-your-templates -> real ids have an
  "-in-the-sparkpost-app" suffix
@danielfsousa

danielfsousa commented Jul 10, 2026

Copy link
Copy Markdown
Contributor Author

Pushed a follow-up commit fixing several stale links/anchors that were carried over verbatim by the host swap (all pre-existing, not introduced by this PR — confirmed via live HTTP checks):

  • getting-started-sparkpost/#step-2-verifying-domain-ownership and #sending-domain-step-2-verifying-domain-ownership → real id is #step-2-verify-domain (6 files)
  • /docs/transmissions-breaking-changes → missing /tech-resources/ segment, 404s (api-error-response-changes.md)
  • /docs/reporting/metrics-definitions/ → 404s; live page is /docs/reporting/sp-metrics-definitions/ (analytics-report.md, enterprise-metrics-definitions.md)
  • creating-template/#authoring-html-content-for-your-templates / #authoring-text-content-for-your-templates → real ids have an -in-the-sparkpost-app suffix

Three links pointed at pages that appear fully removed rather than moved (confirmed both old and new host 404, and no live successor found under /docs/). Resolved in two follow-up commits:

  • docs/tech-resources/change-log-sparkpost/ (smtp-engagement-tracking.md) and docs/user-guide/comparing-data/ (faq/retrieve-bounce-info.md) — de-linked; dropped the hyperlink/sentence since no docs.sparkpost.com equivalent exists
  • docs/user-guide/defining-webhooks/ (integrations/php-list.md, tech-resources/list-unsubscribe-functionality.md, user-guide/setting-up-unsubscribe-links.md, user-guide/using-unsubscribe-reports.md) — re-linked to https://developers.sparkpost.com/api/webhooks/, which covers webhook creation directly

Also noted, not changed (non-breaking redirects that still land on relevant content): user-guide/managing-sending-domains/getting-started/setting-up-domains/, tech-resources/recipient-validation-sparkpost/recipient-validation/getting-started-recipient-validation/, tech-resources/enabling-inbound-email/tech-resources/inbound-email-relay-webhook/, tech-resources/managing-webhook-data/tech-resources/webhook-data-streams/.

@danielfsousa danielfsousa self-assigned this Jul 10, 2026
Comment thread content/docs/faq/retrieve-bounce-info.md Outdated
Comment thread content/docs/integrations/php-list.md Outdated
Comment thread content/docs/tech-resources/list-unsubscribe-functionality.md Outdated
Comment thread content/docs/tech-resources/smtp-engagement-tracking.md Outdated
Comment thread content/docs/user-guide/setting-up-unsubscribe-links.md Outdated
Comment thread content/docs/user-guide/using-unsubscribe-reports.md Outdated
change-log-sparkpost, comparing-data, and defining-webhooks no longer
exist on the docs site and no clear successor page was found, so drop
the links/sentences that pointed at them rather than leave dead links.
The defining-webhooks page no longer exists with no docs.sparkpost.com
successor, but developers.sparkpost.com/api/webhooks/ covers webhook
creation directly, so restore the links to that instead of leaving
plain text.
@danielfsousa danielfsousa merged commit 528d28b into main Jul 14, 2026
5 of 6 checks passed
@danielfsousa danielfsousa deleted the docs/update-links branch July 14, 2026 16:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants