Skip to content

test: Example PR that fails the link check (do not merge) - #1964

Draft
marcleblanc2 wants to merge 1 commit into
mainfrom
marc/example-check-links
Draft

marcleblanc2 wants to merge 1 commit into
mainfrom
marc/example-check-links

Conversation

@marcleblanc2

@marcleblanc2 marcleblanc2 commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

Example for the docs-maintainer announcement: one PR, one failing check. Do not merge.

Adds one sentence to docs/batch-changes/server-side.mdx with three bad links: an absolute link to a moved page on this site (the check suggests the relative path), a link to a heading that does not exist, and an external link that returns 404. No missing-page link on purpose, so the Vercel build still passes and only the Check links workflow fails.

Siblings: #1963 spell check and #1965 redirect check. Replaces the all-in-one #1948 for the announcement.

Adds an absolute link to a moved page on this site, a link to a heading that does not exist, and a dead external link.

Amp-Thread-ID: https://ampcode.com/threads/T-01a0a6dc-7fb8-766d-8e8d-c2fda22ee1ce
Co-authored-by: Amp <amp@ampcode.com>
@vercel

vercel Bot commented Sep 15, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
sourcegraph-docs Ready Ready Preview Sep 15, 2026 9:04pm UTC

Request Review

@github-actions

Copy link
Copy Markdown
Contributor

❌ This PR introduces 3 broken link(s)

Outbound

Your PR includes links to pages or anchors that do not exist.

docs/batch-changes/server-side.mdx

  • line 40
    • Link: /batch-changes/server-side#docker-image-settings
    • Problem: Anchor "docker-image-settings" not found in "/batch-changes/server-side"
  • line 40
    • Link: https://github.com/sourcegraph/sourcegraph/blob/main/executor-images.md
    • Problem: External link returns HTTP 404

Absolute links

Write links on this site as relative paths (/admin/config/site-config), not https://sourcegraph.com/docs/…: absolute links leave the preview deployment and local dev server, and hide moved pages behind redirects.

docs/batch-changes/server-side.mdx

  • line 40
    • Link: https://sourcegraph.com/docs/admin/executors/deploy_executors
    • Problem: Absolute link to a moved page
    • Fix: /self-hosted/executors

Reproduce locally with pnpm check links --check-anchors --check-self-links (see dev/check-links.mjs).

Adding a redirect in src/data/redirects.ts does not satisfy this check, because it’s a workaround instead of a fix.


By default, docker on mac will build docker images for `linux/arm64`, which will result in errors when running server-side because executors provide `linux/amd64` hosts. If you're creating your own images to run in batch changes, this can be a problem. Use the `--platform linux/amd64` flag with `docker build` to build images compatible with the server-side host.

See [deploying executors](https://sourcegraph.com/docs/admin/executors/deploy_executors), the [Docker image settings](/batch-changes/server-side#docker-image-settings), and the [executor image list](https://github.com/sourcegraph/sourcegraph/blob/main/executor-images.md) for details.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link: https://sourcegraph.com/docs/admin/executors/deploy_executors
Problem: Absolute link to a moved page
Fix: /self-hosted/executors

Suggested change
See [deploying executors](https://sourcegraph.com/docs/admin/executors/deploy_executors), the [Docker image settings](/batch-changes/server-side#docker-image-settings), and the [executor image list](https://github.com/sourcegraph/sourcegraph/blob/main/executor-images.md) for details.
See [deploying executors](/self-hosted/executors), the [Docker image settings](/batch-changes/server-side#docker-image-settings), and the [executor image list](https://github.com/sourcegraph/sourcegraph/blob/main/executor-images.md) for details.

@github-actions

Copy link
Copy Markdown
Contributor

Direct preview links to pages changed in this PR:

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant