docs/changelog: Deduplicate old technical changelog page, redirect releases to their records of truth - #1888
Draft
marcleblanc2 wants to merge 1 commit into
Draft
docs/changelog: Deduplicate old technical changelog page, redirect releases to their records of truth#1888marcleblanc2 wants to merge 1 commit into
marcleblanc2 wants to merge 1 commit into
Conversation
…record of truth Every Sourcegraph release has exactly one public record of its notes: - 5.7.0 and newer: sourcegraph.com/changelog/releases/<version> - 5.4.5099 through 5.6.2535: this docs page (published nowhere else) - 5.4.2198 and older: CHANGELOG.md in sourcegraph-public-snapshot Trim docs/technical-changelog.mdx (12,646 lines, frozen since January) to the 12 releases that only exist here, and add a client component that forwards version fragments (#v6121271, #v401, GitHub-style #56185) to the matching record. Point the /releases table rows for 4.0 through 5.3 at CHANGELOG.md, matching the 3.x rows. Redirect /CHANGELOG, which the GitHub release notes for 5.4 through 5.6 link to, onto the forwarding page. Co-authored-by: Amp <amp@ampcode.com> Amp-Thread-ID: https://ampcode.com/threads/T-01a07e67-73b3-779f-8880-7ba770fe7ade
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
marcleblanc2
changed the title
marcleblanc2
changed the title
marcleblanc2
changed the title
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.
Linear FE-499: Fix doc site issues
Summary
docs/technical-changelog.mdx(12,646 lines, 783 KB) has not been updated since v6.12.1271 in January; the changelog moved to sourcegraph.com. This PR stops the docs site from being a stale mirror while keeping every release's notes reachable.Record of truth per version range
https://sourcegraph.com/changelog/releases/<version>CHANGELOG.mdstops at 5.4.2198,sourcegraph.com/changelog/releases/5.6.*is 404, and the GitHub Releases for these tags are stubs that link back tosourcegraph.com/docs/CHANGELOG#<version>CHANGELOG.mdin sourcegraph-public-snapshot,#<version-slug>anchorsCHANGELOG.md(unchanged;/releasesalready linked there)Changes
docs/technical-changelog.mdxto the 12 releases that exist nowhere else, with a notice pointing at the other two records.TechnicalChangelogRedirect, a client component on that page that forwards version fragments to the right record:#v6121271→ sourcegraph.com,#v5312303→ GitHubCHANGELOG.md#5312303, and GitHub-style#56185→ the#v56185heading on the page. Fragments never reach the server, so this cannot be a middleware redirect./releasesdeprecated table rows for 4.0 – 5.3 atCHANGELOG.md, matching the existing 3.x rows. The 5.4 – 5.6 rows keep their docs anchors./CHANGELOG→/technical-changelog. The GitHub release notes for v5.4.0 through v5.6.185 link tosourcegraph.com/docs/CHANGELOG#<version>, which currently soft-404s.Open question
If losing the 5.4.5099 – 5.6.2535 notes is acceptable (all pre-6.0, out of support), the page can be deleted outright and
/technical-changelog*redirected tosourcegraph.com/changelogin middleware instead. This PR keeps them because deleting removes the only public copy.Verification
npx tsc --noEmit,node dev/check-links.mjs(no dead links),git diff --check, Prettier on touched files#v6121271→https://sourcegraph.com/changelog/releases/6.12.1271;#v570→.../releases/5.7.0;#v5312303and#v401→CHANGELOG.md#5312303/#401;#56185→ rewritten to#v56185and scrolled to the heading;#v547765stays and scrolls; unknown#v543500and no fragment stay on the pagecurlagainst middleware:/CHANGELOG→ 307/docs/technical-changelog;/technical-changelog.rssstill →sourcegraph.com/changelog/technical-changelog.rss/releasesrenders 4.0 – 5.3 "Notes" links toCHANGELOG.md#…and 5.4 – 5.6 to/technical-changelog#v…Amp threads