Fix broken external links found with automated link checking by Copilot · Pull Request #424 · SteeltoeOSS/Documentation

Copilot · 2026-02-05T14:57:26Z

Addresses broken external URLs across the documentation.

Broken link fixes (~150 files)

Broadcom TechDocs migrations: docs.pivotal.io and docs.vmware.com links updated to current techdocs.broadcom.com paths for Spring Cloud Services → Application Services, SSO, CredHub, MySQL, Postgres, RabbitMQ, Redis/Valkey, GemFire Native Client, Metric Registrar, Volume Services, CSB (AWS/Azure/GCP), Apps Manager
Microsoft: docs.microsoft.com → learn.microsoft.com, docs.asp.net → learn.microsoft.com, visualstudio.com → visualstudio.microsoft.com; reduced redirects where possible without forcing localization
Spring: projects.spring.io/spring-cloud → spring.io/projects/spring-cloud-*; trailing slash fixes
GitHub repo moves: spring-cloud-samples/hystrix-dashboard → Netflix-Skunkworks/hystrix-dashboard, cf-platform-eng/mssql-server-broker → cloudfoundry-attic/mssql-server-broker, cloudfoundry-incubator → cloudfoundry
CredHub API: credhub-api.cfapps.io → docs.cloudfoundry.org/api/credhub/version/main/ with corrected anchors (#_overwriting_credential_values, #_permissions)
Discontinued services: Hystrix Dashboard marked as deprecated (no longer available), Wavefront trial references removed, dead pivotal.io/platform-acceleration-lab links removed
Naming: "PCF" → "Tanzu Platform", "TAS Apps Manager" → "Apps Manager", "TAS SSO" / "TAS Single-Sign-on" → "Single Sign-On", "Azure Open Service Broker" → "Open Service Broker for Azure"
Misc: RabbitMQ docs path updates, tanzu.vmware.com/gemfire → vmware.com/products/..., tanzu.vmware.com/observability → broadcom.com/products/..., hhttps typo, start.steeltoe.io/api/config/ → /api/uiconfig/

Also fixes root-relative markdown links that docfx does not see (inadvertently broken in #363)

Original prompt

This section details on the original issue you should resolve

<issue_title>Scan for broken links to external URLs</issue_title>
<issue_description>We should run a tool that recursively follows all the links and reports which ones are broken. And then correct or remove them.

For example, there are many links pointing to docs.pivotal.io, such as https://docs.pivotal.io/spring-cloud-services/1-5/common/circuit-breaker/, which today redirects to the generic Broadcom page at https://techdocs.broadcom.com/us/en/vmware-tanzu.html.</issue_description>

Comments on the Issue (you are @copilot in this section)
@bart-vmware Remaining _hard_ broken links after the fixes in #385 are listed in the table below. Note this does not include soft broken links, such as the one mentioned above.

URL Anchor Text Linked From

https://credhub-api.cfapps.io/ CredHub API [https...</comment_new>

Fixes Scan for broken links to external URLs #375

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

docs/guides/messaging/Tutorials/Tutorial1/Readme.md

docs/docs/v3/security/credhub-api-client.md

docs/docs/v3/circuitbreaker/index.md

docs/docs/v2/security/credhub-api-client.md

.github/workflows/check-links.yml

--verbose is needed to see redirect details - locally: - set user-agent locally to avoid 403 on mysql links (doesn't seem to affect CI) - ignore build/docfx-net10-binaries (like playwright readme) - longer host-request-interval and retry-wait-time

docs/docs/v4/connectors/cosmosdb.md

- since redirect fixes are already in place in other PR, change verbosity now

- also include a paste-able snippet to bust the cache for a given PR

- external links to - CredHub API, Spring AMQP, and Spring Cloud projects - Broadcom/Pivotal/samples/Microsoft - CredHub/Samples/CircuitBreaker links - Reduce external redirects - Fix double 'the' in fileshares usage docs - Disambiguate Redis/Valkey versions, clarify Thinktecture reference - Fix 'n0t' typo in v3 fileshares docs - TAS SSO→Single Sign-On Co-authored-by: TimHess <3947063+TimHess@users.noreply.github.com>

Co-authored-by: Cursor <cursoragent@cursor.com>

- redirect reductions for docs.microsoft.com and trailing slashes - remove /en-US/ from mozilla links

bart-vmware · 2026-03-02T12:54:41Z

Additional broken link, found in Blazor sources: https://store.education.pivotal.io/confirm-course?courseid=EDU-1180

TimHess · 2026-03-02T14:16:56Z

Additional broken link, found in Blazor sources: https://store.education.pivotal.io/confirm-course?courseid=EDU-1180

That page wasn't linked anymore, analytics show no traffic in the last year, so I just removed it

bart-vmware

I've reviewed most of the changes. Most of docs/v2 is still pending.

docs/docs/v2/circuitbreaker/hystrix.md

docs/docs/v4/connectors/mysql.md

docs/docs/v4/connectors/redis.md

docs/docs/v4/connectors/microsoft-sql-server.md

docs/docs/v4/connectors/mysql.md

docs/docs/v2/logging/dynamic-logging-provider.md

docs/docs/v3/welcome/prerequisites.md

docs/docs/v3/connectors/postgresql.md

docs/docs/v3/connectors/mysql.md

docs/docs/v3/connectors/cosmosdb.md

Co-authored-by: Bart Koelman <104792814+bart-vmware@users.noreply.github.com>

- CredHub "on Tanzu Platform" links updated to Broadcom TechDocs (v2, v3) - Hystrix flow chart anchor corrected from #collapser-flow to #flow-chart (v2, v3) - NuGet profile URL corrected to SteeltoeOSS - CosmosDB, MySQL, PostgreSQL v2/v3: restore original broker names, drop dead links, add notes where service broker support has been retired - Redis v4: deduplicate Valkey links, rename to "Tanzu for Valkey on Tanzu Platform" - "Getting Started with C#" link updated to learn.microsoft.com/dotnet/csharp (v2, v3) Made-with: Cursor

bart-vmware

Please add an ignore filter for *.mysql.com.

bart-vmware · 2026-03-03T06:48:17Z

docs/docs/v2/management/metrics.md

-* Configure apps to emit custom metrics to [Loggregator](https://docs.pivotal.io/pivotalcf/2-2/loggregator/architecture.html) system.
-* Read custom metrics from the [Loggregator Firehose](https://docs.pivotal.io/pivotalcf/2-2/loggregator/architecture.html#firehose) using a Firehose consumer of their choice, including [community](https://github.com/cloudfoundry/loggregator-release/blob/develop/docs/community-nozzles.md) and third-party nozzles.
+* Configure apps to emit custom metrics to [Loggregator](https://docs.cloudfoundry.org/loggregator/architecture.html) system.
+* Read custom metrics from the [Loggregator Firehose](https://docs.cloudfoundry.org/loggregator/architecture.html) using a Firehose consumer of their choice, including [community](https://github.com/cloudfoundry/loggregator-release/blob/main/docs/community-nozzles.md) and third-party nozzles.


Loggregator Firehose could link to: https://docs.cloudfoundry.org/loggregator/architecture.html#-loggregator-firehose-architecture

Occurs multiple times.

docs/docs/v3/connectors/mysql.md

docs/docs/v2/connectors/cosmosdb.md

bart-vmware · 2026-03-03T08:23:34Z

docs/guides/service-discovery/consul.md

    public async Task<string> Get()
    {
-        return await _httpClient.GetStringAsync("http://Consul-Register-Example/WeatherForecast");
+        return await _httpClient.GetStringAsync("http://consul-register-example/WeatherForecast");


This needs to be reverted. I've followed the steps and found the instance is registered in Consul under the service name "Consul-Register-Example" (apparently, Steeltoe converts underscores to dashes):

Additionally, I noticed the command to add the package needs to be changed from:

dotnet add Steeltoe.Discovery.Consul

to (in alignment with existing docs):

dotnet add package Steeltoe.Discovery.Consul --version 3.2.0

Beware, this entry occurs twice on the page.

I've created #429 to use wildcards for the minor versions.

bart-vmware · 2026-03-03T08:37:16Z

Output is looking pretty great now. The 404s at the end are expected, as dotnet/docfx#11012 hasn't been integrated yet.

Co-authored-by: Bart Koelman <104792814+bart-vmware@users.noreply.github.com>

- #-loggregator-firehose-architecture - exclude mysql.com from lychee scan - restore Consul-Register-Example casing, use case-insensitive exclusion - fix consul add package example

TimHess · 2026-03-03T18:45:40Z

amqp.org appears to be down today, at this point I'm guessing it's temporary and think we should ignore it
[ERROR] https://www.amqp.org/resources/download

Copilot AI assigned Copilot and TimHess Feb 5, 2026

Copilot started work on behalf of TimHess February 5, 2026 14:57 View session

Copilot AI changed the title ~~[WIP] Scan for broken links to external URLs~~ Add link checking and fix broken documentation references Feb 5, 2026

Copilot AI requested a review from TimHess February 5, 2026 15:10

Copilot finished work on behalf of TimHess February 5, 2026 15:10

This comment was marked as resolved.

Sign in to view

Copilot started work on behalf of TimHess February 19, 2026 21:09 View session

TimHess changed the base branch from main to copilot/setup-copilot-instructions February 19, 2026 21:10

This comment was marked as resolved.

Sign in to view

Copilot finished work on behalf of TimHess February 19, 2026 21:14

This comment was marked as outdated.

Sign in to view

TimHess requested changes Feb 19, 2026

View reviewed changes

Copilot started work on behalf of TimHess February 19, 2026 21:33 View session

This comment was marked as off-topic.

Sign in to view

Copilot AI requested a review from TimHess February 19, 2026 21:38

Copilot finished work on behalf of TimHess February 19, 2026 21:38

This comment was marked as resolved.

Sign in to view

Copilot started work on behalf of TimHess February 19, 2026 22:05 View session

This comment was marked as resolved.

Sign in to view

Copilot AI requested a review from TimHess February 19, 2026 22:13

Copilot finished work on behalf of TimHess February 19, 2026 22:13

This comment was marked as resolved.

Sign in to view

Copilot started work on behalf of TimHess February 20, 2026 19:01 View session

This comment was marked as resolved.

Sign in to view

Copilot finished work on behalf of TimHess February 20, 2026 19:09

Base automatically changed from copilot/setup-copilot-instructions to main February 20, 2026 19:11

Copilot started work on behalf of TimHess February 20, 2026 19:22 View session

Copilot AI changed the title ~~Add link checking and fix broken documentation references~~ Add link checking workflow and fix broken external URLs Feb 20, 2026

Copilot finished work on behalf of TimHess February 20, 2026 19:27

TimHess force-pushed the copilot/scan-for-broken-links branch from 30baab7 to 18ceece Compare February 26, 2026 21:16

TimHess changed the title ~~Fix broken external links and add automated link checking~~ Fix broken external links found with automated link checking Feb 26, 2026

TimHess temporarily deployed to pr-424 February 26, 2026 21:24 — with GitHub Actions Inactive

TimHess reviewed Feb 26, 2026

View reviewed changes

docs/docs/v4/connectors/cosmosdb.md Outdated Show resolved Hide resolved

TimHess force-pushed the copilot/scan-for-broken-links branch from 18ceece to 4563611 Compare February 26, 2026 21:50

TimHess previously approved these changes Feb 26, 2026

View reviewed changes

TimHess self-requested a review February 26, 2026 21:53

TimHess temporarily deployed to pr-424 February 26, 2026 21:58 — with GitHub Actions Inactive

TimHess added 2 commits February 27, 2026 09:14

move settings to shared lychee.toml

b0140cd

- since redirect fixes are already in place in other PR, change verbosity now

fix exclude_paths broken in move to lychee.toml

b26c2cb

TimHess temporarily deployed to pr-424 February 27, 2026 16:29 — with GitHub Actions Inactive

TimHess and others added 6 commits February 27, 2026 11:57

isolate lychee caching to specific workstreams

83b2dab

- also include a paste-able snippet to bust the cache for a given PR

fix absolute .md links to relative paths

d7dab75

fix consul-register-example casing, fix broken eureka docs link

c6868d7

Co-authored-by: Cursor <cursoragent@cursor.com>

fix anchors, reduce unnecessary redirects

3394f3e

- redirect reductions for docs.microsoft.com and trailing slashes - remove /en-US/ from mozilla links

use default verbosity, update cosmos connectionstring link

b3cce71

drop training page

96cfde0

bart-vmware reviewed Mar 2, 2026

View reviewed changes

TimHess and others added 2 commits March 2, 2026 14:39

Apply suggestions from code review

d3a6e97

Co-authored-by: Bart Koelman <104792814+bart-vmware@users.noreply.github.com>

bart-vmware requested changes Mar 3, 2026

View reviewed changes

TimHess and others added 3 commits March 3, 2026 09:41

Update docs/docs/v2/connectors/cosmosdb.md

d373204

Co-authored-by: Bart Koelman <104792814+bart-vmware@users.noreply.github.com>

Merge branch 'main' into copilot/scan-for-broken-links

0efa22b

More PR feedback

a1a886e

- #-loggregator-firehose-architecture - exclude mysql.com from lychee scan - restore Consul-Register-Example casing, use case-insensitive exclusion - fix consul add package example

Conversation

Copilot AI commented Feb 5, 2026 • edited by TimHess Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Broken link fixes (~150 files)

Comments on the Issue (you are @copilot in this section)

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as outdated.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as off-topic.

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

Uh oh!

bart-vmware commented Mar 2, 2026

Uh oh!

TimHess commented Mar 2, 2026

Uh oh!

bart-vmware left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bart-vmware left a comment

Choose a reason for hiding this comment

Uh oh!

bart-vmware Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

bart-vmware Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

bart-vmware commented Mar 3, 2026

Uh oh!

TimHess commented Mar 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Feb 5, 2026 •

edited by TimHess

Loading