From 13dc6355c83d34827952465e8807c77f7c5cdf01 Mon Sep 17 00:00:00 2001 From: Marc LeBlanc <7050295+marcleblanc2@users.noreply.github.com> Date: Thu, 29 Oct 2026 19:43:31 -0600 Subject: [PATCH] docs: update stale docs.sourcegraph.com links docs.sourcegraph.com URLs in compose and config comments, the docker-compose READMEs, and the PR template redirected to new paths or, for operations#database-migrations, to the wrong page. Point them at the current sourcegraph.com/docs pages and drop the dead testing-principles link from the PR template. Amp-Thread-ID: https://ampcode.com/threads/T-01a18a77-bb16-74a4-b42c-bdbad59a3194 Co-authored-by: Amp --- .github/PULL_REQUEST_TEMPLATE.md | 7 +++---- codeinsights-db/conf/postgresql.conf | 2 +- codeintel-db/conf/postgresql.conf | 2 +- docker-compose/README.md | 2 +- docker-compose/dev/README.md | 2 +- docker-compose/docker-compose.yaml | 2 +- .../aws-rds-databases/docker-compose.override.yaml | 4 ++-- .../migrator-operations/docker-compose.override.yaml | 2 +- otel-collector/config.yaml | 2 +- pgsql/conf/postgresql.conf | 2 +- 10 files changed, 13 insertions(+), 14 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 81100d3cc..198c82ace 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,13 +2,12 @@ ### Checklist -* [ ] All images have a valid tag and SHA256 sum +- [ ] All images have a valid tag and SHA256 sum + ### Test plan diff --git a/codeinsights-db/conf/postgresql.conf b/codeinsights-db/conf/postgresql.conf index 1b9723fc1..34395f16b 100644 --- a/codeinsights-db/conf/postgresql.conf +++ b/codeinsights-db/conf/postgresql.conf @@ -54,4 +54,4 @@ max_locks_per_transaction = 64 #------------------------------------------------------------------------------ # Add your customization here -# Learn more: https://docs.sourcegraph.com/admin/config/postgres-conf +# Learn more: https://sourcegraph.com/docs/self-hosted/postgres-conf diff --git a/codeintel-db/conf/postgresql.conf b/codeintel-db/conf/postgresql.conf index f3e95b992..80092d095 100755 --- a/codeintel-db/conf/postgresql.conf +++ b/codeintel-db/conf/postgresql.conf @@ -53,4 +53,4 @@ effective_cache_size = 3GB #------------------------------------------------------------------------------ # Add your customization here -# Learn more: https://docs.sourcegraph.com/admin/config/postgres-conf +# Learn more: https://sourcegraph.com/docs/self-hosted/postgres-conf diff --git a/docker-compose/README.md b/docker-compose/README.md index 691af522d..c3d59a381 100644 --- a/docker-compose/README.md +++ b/docker-compose/README.md @@ -2,7 +2,7 @@ This directory contains the Sourcegraph with Docker Compose deployment reference. -To learn more about deploying, configuring, and upgrading a Sourcegraph with Docker Compose installation, please refer to our documentation: [Sourcegraph with Docker Compose](https://docs.sourcegraph.com/admin/install/docker-compose) +To learn more about deploying, configuring, and upgrading a Sourcegraph with Docker Compose installation, please refer to our documentation: [Sourcegraph with Docker Compose](https://sourcegraph.com/docs/self-hosted/deploy/docker-compose) ## Shared object storage diff --git a/docker-compose/dev/README.md b/docker-compose/dev/README.md index fc50215f8..bf75a6e23 100644 --- a/docker-compose/dev/README.md +++ b/docker-compose/dev/README.md @@ -1,7 +1,7 @@ # Development overlay For use developing Sourcegraph's docker-compose deployment only. -For deployments, refer to the official [Sourcegraph with Docker Compose](https://docs.sourcegraph.com/admin/install/docker-compose) documentation. +For deployments, refer to the official [Sourcegraph with Docker Compose](https://sourcegraph.com/docs/self-hosted/deploy/docker-compose) documentation. This folder includes a helper script, [run.sh](./run.sh), that will run the `docker-compose` command (with any provided arguments) while automatically specifying the appropriate set of overlays. diff --git a/docker-compose/docker-compose.yaml b/docker-compose/docker-compose.yaml index 461ca8268..34a992340 100644 --- a/docker-compose/docker-compose.yaml +++ b/docker-compose/docker-compose.yaml @@ -33,7 +33,7 @@ services: - CODEINTEL_PGSSLMODE=disable # If you are not running code insights, please see: - # https://docs.sourcegraph.com/admin/install/docker-compose/operations#database-migrations for more information + # https://sourcegraph.com/docs/self-hosted/deploy/docker-compose/operations#database-migrations for more information # for information on how to configure Sourcegraph migrations - CODEINSIGHTS_PGHOST=codeinsights-db - CODEINSIGHTS_PGPORT=5432 diff --git a/docker-compose/examples/aws-rds-databases/docker-compose.override.yaml b/docker-compose/examples/aws-rds-databases/docker-compose.override.yaml index 784705621..a5a8ca557 100644 --- a/docker-compose/examples/aws-rds-databases/docker-compose.override.yaml +++ b/docker-compose/examples/aws-rds-databases/docker-compose.override.yaml @@ -1,5 +1,5 @@ # Docker Compose override file for customers using AWS IAM authentication to databases on RDS -# See https://sourcegraph.com/docs/admin/external_services/postgres#usage-with-aws-rds-iam-auth +# See https://sourcegraph.com/docs/self-hosted/external-services/postgres#usage-with-aws-rds-iam-auth @@ -79,7 +79,7 @@ services: # command: ["add-log", "-db=codeinsights", "-version=1675347548"] # If you do fall a few versions behind, here's the command to run a multi-version upgrade - # See https://sourcegraph.com/docs/admin/deploy/docker-compose/upgrade#multi-version-upgrades + # See https://sourcegraph.com/docs/self-hosted/deploy/docker-compose/upgrade#multi-version-upgrades # command: ["upgrade", "--from=v6.4.0", "--to=v6.9.1277"] # Do not skip the drift check, or use other args, without instruction from Sourcegraph Customer Support Engineering diff --git a/docker-compose/examples/migrator-operations/docker-compose.override.yaml b/docker-compose/examples/migrator-operations/docker-compose.override.yaml index 51c0cc7fa..4fc3d4a98 100644 --- a/docker-compose/examples/migrator-operations/docker-compose.override.yaml +++ b/docker-compose/examples/migrator-operations/docker-compose.override.yaml @@ -32,7 +32,7 @@ services: ################################################################################ # Multi-version upgrades - # See https://sourcegraph.com/docs/admin/deploy/docker-compose/upgrade#multi-version-upgrades + # See https://sourcegraph.com/docs/self-hosted/deploy/docker-compose/upgrade#multi-version-upgrades # command: ["upgrade", "--from=v6.4.0", "--to=v6.9.1277"] # Do not skip the drift check, or use other args, without instruction from Sourcegraph Customer Support Engineering diff --git a/otel-collector/config.yaml b/otel-collector/config.yaml index c29a89cdf..a06de1961 100644 --- a/otel-collector/config.yaml +++ b/otel-collector/config.yaml @@ -11,7 +11,7 @@ exporters: # Add your exporter(s) configuration here. For each exporter, make sure it is enabled # in the service configuration below. # Refer to our OpenTelemetry docs for information on how to configure different exporters: - # https://docs.sourcegraph.com/admin/observability/opentelemetry + # https://sourcegraph.com/docs/self-hosted/observability/opentelemetry extensions: health_check: diff --git a/pgsql/conf/postgresql.conf b/pgsql/conf/postgresql.conf index f3e95b992..80092d095 100644 --- a/pgsql/conf/postgresql.conf +++ b/pgsql/conf/postgresql.conf @@ -53,4 +53,4 @@ effective_cache_size = 3GB #------------------------------------------------------------------------------ # Add your customization here -# Learn more: https://docs.sourcegraph.com/admin/config/postgres-conf +# Learn more: https://sourcegraph.com/docs/self-hosted/postgres-conf