Skip to content

Commit 1184c68

Browse files
feat(docs) update /changelog url to /technical-changelog (#708)
<!-- Explain the changes introduced in your PR --> ## Pull Request approval Although pull request approval is not enforced for this repository in order to reduce friction, merging without a review will generate a ticket for the docs team to review your changes. So if possible, have your pull request approved before merging.
1 parent b24720c commit 1184c68

File tree

17 files changed

+4101
-5083
lines changed

17 files changed

+4101
-5083
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,4 @@ next-env.d.ts
4444
.idea
4545

4646
# We ignore the generated file as it should always be generated
47-
public/changelog.rss
47+
public/technical-changelog.rss

dev/rss.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ const fs = require('fs');
33
const path = require('path');
44

55
const loadChangelog = () => {
6-
const changelogPath = path.join(__dirname, '..', 'docs', 'CHANGELOG.mdx');
6+
const changelogPath = path.join(__dirname, '..', 'docs', 'technical-changelog.mdx');
77
return fs.readFileSync(changelogPath, 'utf8');
88
}
99

@@ -36,7 +36,7 @@ const generateRssFeed = () => {
3636
updated: date,
3737
generator: 'Sourcegraph RSS Feed',
3838
feedLinks: {
39-
rss2: `${siteURL}/changelog.rss`,
39+
rss2: `${siteURL}/technical-changelog.rss`,
4040
},
4141
author: {
4242
name: 'Sourcegraph',
@@ -55,7 +55,7 @@ const generateRssFeed = () => {
5555
continue;
5656
}
5757
const tag = comment.version.replace('v', '');
58-
const versionDocLink = `${siteURL}/CHANGELOG#${comment.version.replaceAll('.', '')}`;
58+
const versionDocLink = `${siteURL}/technical-changelog#${comment.version.replaceAll('.', '')}`;
5959
feed.addItem({
6060
title: `Sourcegraph ${tag}`,
6161
id: comment.version,
@@ -65,7 +65,7 @@ const generateRssFeed = () => {
6565
});
6666
}
6767

68-
fs.writeFileSync(path.join(__dirname, '../public/changelog.rss'), feed.rss2());
68+
fs.writeFileSync(path.join(__dirname, '../public/technical-changelog.rss'), feed.rss2());
6969
}
7070

7171
module.exports = { generateRssFeed }

docs/admin/deploy/docker-single-container/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ A [standard upgrade](/admin/updates/#standard-upgrades) occurs between two minor
147147
- Read our [update policy](/admin/updates/#update-policy) to learn about Sourcegraph updates.
148148
- Find the relevant entry for your update in the [update notes for single-container Sourcegraph with Docker](/admin/updates/server).
149149

150-
To update, just use the newer `sourcegraph/server:N.N.N` Docker image (where `N.N.N` is a patch or single minor release away your current version) in place of the older one, using the same Docker volumes. Your server's data will be migrated automatically if needed. You can always find the version number details of the latest release via the [changelog](/CHANGELOG).
150+
To update, just use the newer `sourcegraph/server:N.N.N` Docker image (where `N.N.N` is a patch or single minor release away your current version) in place of the older one, using the same Docker volumes. Your server's data will be migrated automatically if needed. You can always find the version number details of the latest release via the [technical changelog](/technical-changelog).
151151

152152
### Multi-version upgrades
153153

docs/admin/deploy/machine-images/aws-ami.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ Now that your instance is confirmed to be working, and you have HTTPS working th
174174

175175
Please take time to review the following before proceeding with the upgrades:
176176

177-
- [Changelog](/CHANGELOG)
177+
- [Technical changelog](/technical-changelog)
178178
- [Update policy](/admin/updates#update-policy)
179179
- [Update notes](/admin/updates/kubernetes)
180180

docs/admin/deploy/machine-images/gce.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ As a result, setting up a static IP for your Sourcegraph instance is strongly re
132132

133133
Please take time to review the following before proceeding with the upgrades:
134134

135-
- [Changelog](/CHANGELOG)
135+
- [Technical changelog](/technical-changelog)
136136
- [Update policy](/admin/updates#update-policy)
137137
- [Update notes](/admin/updates/kubernetes)
138138
- [Multi-version upgrade procedure](/admin/updates/kubernetes#multi-version-upgrade-procedure)

docs/admin/deploy/single-node/script.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Sourcegraph will be available on ports 80 and 443 (using a self signed certifica
7272
We recommend deploying your own reverse proxy to terminate TLS connections with a properly signed certificate.
7373

7474
## Upgrade
75-
- [Changelog](/CHANGELOG)
75+
- [Technical changelog](/technical-changelog)
7676
- [Update policy](/admin/updates#update-policy)
7777
- [Update notes](/admin/updates/kubernetes)
7878
- [Multi-version upgrade procedure](/admin/updates/kubernetes#multi-version-upgrade-procedure)

docs/admin/how-to/site-admin-quickstart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Regardless of the deployment option you choose, Sourcegraph can be self-hosted l
2323

2424

2525
## Updating your instance
26-
New versions of Sourcegraph are released monthly (with patches released in between, as needed). New updates are announced in the [Sourcegraph blog](https://about.sourcegraph.com/blog), and comprehensive update notes are available in the [changelog](/CHANGELOG).
26+
New versions of Sourcegraph are released monthly (with patches released in between, as needed). New updates are announced in the [Sourcegraph blog](https://about.sourcegraph.com/blog), and comprehensive update notes are available in the [technical changelog](/technical-changelog).
2727

2828
To check the current version of your instance, go to **User menu > Site admin > Updates**.
2929

docs/admin/migration/3_30.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@ The 3.30 release introduced a `pgsql` and `codeinteldb` base image change from d
1515
This caused corruption in indexes that have collatable key columns (e.g. any index with a `text` column).
1616
Read more about this [here](https://postgresql.verite.pro/blog/2018/08/27/glibc-upgrade.html).
1717

18-
After we found the root-cause of the [issues many customers were seeing](https://github.com/sourcegraph/sourcegraph/issues/23288), we cut [a patch release, 3.30.3](/CHANGELOG#3-30-3), that reverted the images to be based on debian, buying us time to change the alpine based version of the images to [reindex affected indexes on startup, before accepting new connections](https://github.com/sourcegraph/sourcegraph/issues/23310).
18+
After we found the root-cause of the [issues many customers were seeing](https://github.com/sourcegraph/sourcegraph/issues/23288), we cut [a patch release, 3.30.3](/technical-changelog#3-30-3), that reverted the images to be based on debian, buying us time to change the alpine based version of the images to [reindex affected indexes on startup, before accepting new connections](https://github.com/sourcegraph/sourcegraph/issues/23310).
1919

2020
However, this means that after fixing the corrupt indexes on the alpine images in the affected releases, upgrading to debian based images in 3.30.3 will cause index corruption again. For this reason, **do not upgrade to 3.30.3** after fixing corrupt Postgres indexes. Instead, [please upgrade directly to 3.31](/admin/migration/3_31).

docs/admin/updates/docker_compose.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This page lists the changes that are relevant for upgrading Sourcegraph on **Doc
55
For upgrade procedures or general info about sourcegraph versioning see the links below:
66
- [Docker Compose Upgrade Procedures](/admin/deploy/docker-compose/upgrade)
77
- [General Upgrade Info](/admin/updates/)
8-
- [Product changelog](/CHANGELOG)
8+
- [Technical changelog](/technical-changelog)
99

1010
> ***Attention:** These notes may contain relevant information about the infrastructure update such as resource requirement changes or versions of depencies (Docker, Docker Compose, externalized databases).*
1111
>

docs/admin/updates/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This page is intended as an entry point into Sourcegraph versioning, upgrades, a
44

55
**If you are already familiar with Sourcegraph upgrades [skip to instance specific procedures](#instance-specific-procedures).**
66

7-
> *Note: For product update notes, please refer to the [changelog](/CHANGELOG).*
7+
> *Note: For product update notes, please refer to the [technical changelog](/technical-changelog).*
88
99
## General concepts
1010

0 commit comments

Comments
 (0)