fix/links: Replace absolute self-links with relative links (67 links) - #1899
Open
marcleblanc2 wants to merge 1 commit into
Open
fix/links: Replace absolute self-links with relative links (67 links)#1899marcleblanc2 wants to merge 1 commit into
marcleblanc2 wants to merge 1 commit into
Conversation
Links to this site written as https://sourcegraph.com/docs/..., http://, or https://docs.sourcegraph.com/... leave the preview deployment and local dev server, and 31 of them pointed at moved pages that only worked through src/data/redirects.ts. Found and resolved by dev/check-links.mjs on #1858; four links needed a hand fix because their anchor or page is gone. Amp-Thread-ID: https://ampcode.com/threads/T-01a08a01-44c1-775b-84d0-d67ff9501905 Co-authored-by: Amp <amp@ampcode.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Rewrites every link to this site that was written as an absolute URL (
https://sourcegraph.com/docs/…,http://sourcegraph.com/docs/…,https://docs.sourcegraph.com/…) as a relative link (/admin/config/site-config), in 15 files.src/data/redirects.ts: now link straight to the destination.commands#commands-id-modeandfeatures#shard-merginganchors no longer exist,github#github-com-rate-limitsbecame#rate-limits, and the deleted gRPC guide now links to its archived 5.3 page.Why
Absolute links leave the Vercel preview and the local dev server, and hide moved pages behind redirects. #1858 makes
dev/check-links.mjsfail PRs that add them; this PR clears the backlog so that check starts from zero.Verification
node dev/check-links.mjs --check-anchors --root <this branch>with the checker from #1858: 0 absolute self-links left, and no new findings againstmain(317 → 250 pre-existing findings; the 67 removed are all self-links).Notes for reviewers
See https://docs.sourcegraph.com/admin/observability/tracingcells indocs/cli/references/*) are not links and are untouched; Point stale docs.sourcegraph.com links at sourcegraph.com/docs #1851 covers those.docs/admin/repo/perforce.mdx,docs/self-hosted/observability/alerts.mdxanddashboards.mdxare synced from sourcegraph/sourcegraph (🤖 Sync generated docs from sourcegraph/sourcegraph #1883); the same links need the same fix upstream or the next sync reverts them.docs/technical-changelog.mdxholds 31 of the links and is retired by docs/changelog: Deduplicate old technical changelog page, redirect releases to their records of truth #1888; if that lands first, take the deletion.