docs/admin: Remove stale version-gated notes for Sourcegraph < 6.0 - #1881
Closed
marcleblanc2 wants to merge 1 commit into
Closed
docs/admin: Remove stale version-gated notes for Sourcegraph < 6.0#1881marcleblanc2 wants to merge 1 commit into
marcleblanc2 wants to merge 1 commit into
Conversation
Sourcegraph 7.7 is the latest release and the SLA supports N-1 major
(6.x), with archived docs sites going back to v6.7. Notes that gate
behaviour on versions older than 6.0 ("as of 3.36", "supported in
5.4 or more", "will be removed in 3.34") no longer help anyone on
a supported version, so this removes them and states the current
behaviour unconditionally.
Also:
- Delete how-to pages that only described one-time migrations on
3.x/4.x versions (blobstore update notes, precise-code-intel-worker
CrashLoopBackOff, pre-3.37 dirty database, LSIF->SCIP migration,
version contexts -> search contexts) and add redirects.
- Drop the Campaigns->Batch Changes rename section and the
"older versions' limitations" sections from Code Insights docs.
- Rewrite the Postgres 12 EOL notice in past tense (it referenced
"upcoming" releases from 2024).
- Remove two changelog links to deleted pages so check-links passes.
Upgrade-path docs (migrator, multi-version upgrades, Kustomize
migration, Postgres 12->16) keep their old-version references since
multi-version upgrades from v3.20+ are still supported.
Co-authored-by: Amp <amp@ampcode.com>
Amp-Thread-ID: https://ampcode.com/threads/T-01a07e69-d410-7318-bb5b-b229f69e1956
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
Author
|
Moved to #1936 (branch renamed to |
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
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.
Why
The docs still carried version-conditional notes for releases that are years out of support: "as of release 3.36", "supported in Sourcegraph 5.4 or more", "these will be removed in Sourcegraph 3.34", etc. The latest docs version is 7.7, the SLA supports N‑1 major (6.x), and archived docs sites go back to v6.7. So any note that gates behaviour on a Sourcegraph version below 6.0 no longer helps anyone on a supported version, and readers on older versions have the legacy docs sites.
What changed
Removed version gates, kept the feature described unconditionally (~40 spots across ~30 files): search contexts,
rev:at.time, repo metadata, Batch Changes publishing/steps.mount/changesetTemplate.fork/schema versions, login form config, permission sync, Perforce,src serve-git, AWS CodeCommit, webhooks, telemetry allowlist, Code Insights (aggregations, retention, capture groups, language stats, repository scope, quickstart), Cody troubleshooting/Azure token, blobstore/minio, Docker Compose migration, Kubernetes custom resources, zoekt watchdog, SSH rsa-sha1, GitHub App badge.Deleted whole sections that only described a long-finished transition:
Deleted pages that only documented a one-time migration on a 3.x/4.x version, with redirects added in
src/data/redirects.tsand existing redirects retargeted so there are no chains:/self-hosted/how-to/blobstore-update-notes(4.2.1)/self-hosted/how-to/blobstore-debugging/self-hosted/how-to/precise-code-intel-worker-crashloopbackoff(3.22)/code-navigation/troubleshooting/self-hosted/how-to/dirty-database-pre-3-37/self-hosted/how-to/dirty-database/admin/how-to/lsif-scip-migration(4.5 → 4.6)/self-hosted/how-to/clear-codeintel-data/admin/how-to/converting-version-contexts-to-search-contexts/code-search/working/search-contextsInbound links from
self-hosted/index.mdx,self-hosted/how-to/index.mdx,admin/how-to/index.mdx,blobstore-debugging.mdx,dirty-database.mdx,clear-codeintel-data.mdx,code-search/features.mdx, andopengrok.mdxwere updated. Two links intechnical-changelog.mdxto the deleted pages were removed becausedev/check-links.mjsdoes not follow redirects.Upgrade docs: rewrote the Postgres 12 EOL notice in past tense (it still said the 5.10 release was "expected for November 25th, 2024"). Other upgrade-path docs (migrator, multi-version upgrades, Kustomize v4.5.0 migration, Postgres 12→16) deliberately keep their old-version references, since multi-version upgrades from v3.20+ are still supported.
Left alone on purpose
[3-6]when 8.0 ships.site-config.mdxschema comments and#deprecation-noticeanchor on the webhooks page — generated/linked from the product schema.managing-access-tokens.mdx"tokens created before 5.3 do not expire" — still true for those tokens.install-vscode.mdx"Sign In to Sourcegraph Instances v5.1 and above" — quotes a UI label.fetch-sboms.mdx/verify-container-signatures.mdx"5.9.0 through 7.0.2852" — precise, still-relevant range.How they were found
Every hit was read by hand; the regex also catches code-host versions,
rev:v4.5.0query examples, and Alpine image tags, which were left unchanged.Verification
npx tsc --noEmit— cleanpnpm build—✅ No dead links found!,✓ Compiled successfully, static pages generatedAmp threads