From fb0d08c5755ab801c6527eb9e119a8b447c47cf6 Mon Sep 17 00:00:00 2001 From: Marc LeBlanc <7050295+marcleblanc2@users.noreply.github.com> Date: Mon, 7 Sep 2026 16:32:44 -0600 Subject: [PATCH 1/2] Fix 25 anchor links whose slug drifted from the heading (case, underscores, punctuation) Co-authored-by: Amp Amp-Thread-ID: https://ampcode.com/threads/T-01a07623-9d65-7356-96b8-2bebb31ffa5a --- docs/admin/auth/index.mdx | 2 +- docs/admin/auth/saml/microsoft-adfs.mdx | 2 +- docs/admin/code-hosts/non-git.mdx | 2 +- docs/admin/search.mdx | 2 +- .../batch-spec-yaml-reference.mdx | 20 +++++++++---------- .../site-admin-configuration.mdx | 2 +- .../current-limitations-of-code-insights.mdx | 2 +- .../code-insights/references/requirements.mdx | 2 +- .../auto-indexing-configuration.mdx | 2 +- .../deploy/kubernetes/troubleshoot.mdx | 2 +- .../deploy/machine-images/aws-oneclick.mdx | 2 +- docs/self-hosted/faq.mdx | 6 +++--- docs/self-hosted/http-https-configuration.mdx | 4 ++-- 13 files changed, 25 insertions(+), 25 deletions(-) diff --git a/docs/admin/auth/index.mdx b/docs/admin/auth/index.mdx index a60f00e10..3b9f73667 100644 --- a/docs/admin/auth/index.mdx +++ b/docs/admin/auth/index.mdx @@ -547,7 +547,7 @@ Consequently, you can only sign in via an auth provider if your email on Sourceg Let's say the email field in your Sourcegraph account was kept blank when a site admin created the account for you, but the username matches your username on GitHub or GitLab. Will this work? If you try to sign in to SG with GitHub or GitLab, it won't work, and you will see an error informing you that a verified email is missing. Exceptions to this rule are [HTTP Proxies](#http-authentication-proxies), where there's an option to make the link via username only. -For [Bitbucket](/admin/config/authorization-and-authentication#bitbucket-server-bitbucket-data-center-authorization), we don't support OAuth. Still, the match between the chosen auth provider used with Bitbucket and a user's Bitbucket account happens via username. +For [Bitbucket](/admin/config/authorization-and-authentication#bitbucket-server--bitbucket-data-center-authorization), we don't support OAuth. Still, the match between the chosen auth provider used with Bitbucket and a user's Bitbucket account happens via username. Using only a username to match a Sourcegraph account to an auth provider account is not recommended, as you can see [here](/admin/code-hosts/gitlab#username), for example. Usernames in Sourcegraph are mutable, so a malicious user could change a username, elevating their privileges. diff --git a/docs/admin/auth/saml/microsoft-adfs.mdx b/docs/admin/auth/saml/microsoft-adfs.mdx index 9797efa52..95319b158 100644 --- a/docs/admin/auth/saml/microsoft-adfs.mdx +++ b/docs/admin/auth/saml/microsoft-adfs.mdx @@ -12,7 +12,7 @@ These instructions guide you through configuring Sourcegraph as a relying party - Active Directory instance where all users have email and username attributes. - An instance of ADFS running on Windows Server, joined to your Active Directory domain. -- Sourcegraph should be [configured to use HTTPS](/self-hosted/http-https-configuration#nginx-ssl-https-configuration). +- Sourcegraph should be [configured to use HTTPS](/self-hosted/http-https-configuration#nginx-sslhttps-configuration). - Ensure that `externalURL` in [site config](/admin/config/site-config) meets the following criteria: - It is the URL used by end users (no trailing slash). diff --git a/docs/admin/code-hosts/non-git.mdx b/docs/admin/code-hosts/non-git.mdx index fb4b8705c..8fc15c9d1 100644 --- a/docs/admin/code-hosts/non-git.mdx +++ b/docs/admin/code-hosts/non-git.mdx @@ -57,7 +57,7 @@ In order to keep the code in the local repository up to date, you will need to r In addition to serving a local directory, `src-expose` can periodically run a command of your choice to fetch changes from a remote and combine them into a single new Git commit. -For example, if your `src-expose` is using a [configuration YAML file](#next-steps--advanced-configuration) that contains the following: +For example, if your `src-expose` is using a [configuration YAML file](#next-steps-advanced-configuration) that contains the following: ```yaml # before is a command run before sync. before is run from root. diff --git a/docs/admin/search.mdx b/docs/admin/search.mdx index 3e871819b..a616770db 100644 --- a/docs/admin/search.mdx +++ b/docs/admin/search.mdx @@ -153,7 +153,7 @@ So, assuming that you have 300,000 repositories and a memory map limit of 65,536 ``` Sourcegraph's monitoring system also includes an [alert for this -scenario and mitigation steps](/self-hosted/observability/alerts#zoekt-memory-map-areas-percentage-used). +scenario and mitigation steps](/self-hosted/observability/alerts#zoekt-memory_map_areas_percentage_used). ### Shard merging diff --git a/docs/batch-changes/batch-spec-yaml-reference.mdx b/docs/batch-changes/batch-spec-yaml-reference.mdx index 82e595549..333578881 100644 --- a/docs/batch-changes/batch-spec-yaml-reference.mdx +++ b/docs/batch-changes/batch-spec-yaml-reference.mdx @@ -121,7 +121,7 @@ To match a branch other than the default, `branch` or `branches` can be used to If multiple branches are matched for the same repository, then - [`changesetTemplate.branch`](#changesettemplate-branch) will need to have a + [`changesetTemplate.branch`](#changesettemplatebranch) will need to have a different value for each branch. @@ -299,7 +299,7 @@ steps: ## `steps.outputs` -Output variables that are set after the [`steps.run`](#steps-run) command has been executed. These variables are available in the global `outputs` namespace as `outputs.` [template variables](/batch-changes/batch-spec-templating) in the `run`, `env`, and `outputs` properties of subsequent steps, and the [`changesetTemplate`](#changesettemplate). Two steps with the same output variable name will overwrite the previous contents. +Output variables that are set after the [`steps.run`](#stepsrun) command has been executed. These variables are available in the global `outputs` namespace as `outputs.` [template variables](/batch-changes/batch-spec-templating) in the `run`, `env`, and `outputs` properties of subsequent steps, and the [`changesetTemplate`](#changesettemplate). Two steps with the same output variable name will overwrite the previous contents. ### Examples @@ -596,7 +596,7 @@ The body (description) of the changeset on the code host. If the code supports M The name of the Git branch to create or update each repository with the changes. -If multiple branches within the same repository are matched in [`on.repository`](#on-repository), then this value must be dynamic since creating multiple branches with the same name in the same repository is impossible. This is often most easily accomplished with the `repository.branch` template variable. For example, this will create `new-feature-3.34` and `new-feature-3.35` branches: +If multiple branches within the same repository are matched in [`on.repository`](#onrepository), then this value must be dynamic since creating multiple branches with the same name in the same repository is impossible. This is often most easily accomplished with the `repository.branch` template variable. For example, this will create `new-feature-3.34` and `new-feature-3.35` branches: ```yaml on: @@ -852,11 +852,11 @@ The name of the directory in which file diffs should be grouped together. The na ## `transformChanges.group.branch` -The branch that should be used for this additional changeset. This **overwrites the [`changesetTemplate.branch`](#changesettemplate-branch)** when creating the additional changeset. +The branch that should be used for this additional changeset. This **overwrites the [`changesetTemplate.branch`](#changesettemplatebranch)** when creating the additional changeset. The branch cannot be nested under the - [`changesetTemplate.branch`](#changesettemplate-branch), i.e. if the + [`changesetTemplate.branch`](#changesettemplatebranch), i.e. if the `changesetTemplate.branch` is `my-batch-change` then this can _not_ be `my-batch-change/my-subdirectory` since [git doesn't allow that](https://stackoverflow.com/a/22630664). Additionally, branch names must @@ -865,9 +865,9 @@ The branch that should be used for this additional changeset. This **overwrites ## `transformChanges.group.title` -(Optional) The title that should be used for this additional changeset. This **overwrites the [`changesetTemplate.title`](#changesettemplate-title)** when creating the additional changeset. +(Optional) The title that should be used for this additional changeset. This **overwrites the [`changesetTemplate.title`](#changesettemplatetitle)** when creating the additional changeset. -The title supports the same template variables as [`changesetTemplate.title`](#changesettemplate-title). When rendering the group title, `${{ steps.path }}` is set to this group's [`directory`](#transformchangesgroupdirectory). +The title supports the same template variables as [`changesetTemplate.title`](#changesettemplatetitle). When rendering the group title, `${{ steps.path }}` is set to this group's [`directory`](#transformchangesgroupdirectory). ## `transformChanges.group.repository` @@ -877,12 +877,12 @@ The title supports the same template variables as [`changesetTemplate.title`](#c The optional `workspaces` property allows users to define where projects are located in repositories and cause the [`steps`](#steps) to be executed for each project instead of once per repository. That allows easier creation of multiple changesets in large repositories. -For each repository yielded by [`on`](#on), a Sourcegraph search is used to get the locations of the `rootAtLocationOf` file. Each location serves as a workspace for executing the `steps` instead of the repository's root. Use the [`workspaces.in`](#workspaces-in) property to scope the definitions of workspaces. Omitting it is treated as `*`. +For each repository yielded by [`on`](#on), a Sourcegraph search is used to get the locations of the `rootAtLocationOf` file. Each location serves as a workspace for executing the `steps` instead of the repository's root. Use the [`workspaces.in`](#workspacesin) property to scope the definitions of workspaces. Omitting it is treated as `*`. Since multiple workspaces in the same repository can produce multiple changesets, it's **required** to use templating to produce a unique - [`changesetTemplate.branch`](#changesettemplate-branch) for each produced + [`changesetTemplate.branch`](#changesettemplatebranch) for each produced changeset. See the [examples](#workspaces-examples) below. @@ -947,7 +947,7 @@ changesetTemplate: branch: ${{ join_if "-" "my-multi-workspace-batch-change" (replace steps.path "/" "-") }} ``` -Using [`steps.outputs`](#steps-outputs) to dynamically create unique branch names: +Using [`steps.outputs`](#stepsoutputs) to dynamically create unique branch names: ```yaml # [...] diff --git a/docs/batch-changes/site-admin-configuration.mdx b/docs/batch-changes/site-admin-configuration.mdx index 084499ae1..f49d799a1 100644 --- a/docs/batch-changes/site-admin-configuration.mdx +++ b/docs/batch-changes/site-admin-configuration.mdx @@ -17,7 +17,7 @@ Using Batch Changes requires a [code host connection](/admin/code-hosts/) to a s - [Rollout windows](/admin/config/batch-changes#rollout-windows), which control the rate at which Batch Changes will publish changesets on code hosts - [Forks](/admin/config/batch-changes#forks), which push branches created by Batch Changes onto forks of the upstream repository instead of the repository itself - [Outgoing webhooks](/admin/webhooks/outgoing), which publish events related to batch changes and changesets to enable deeper integrations with your other tools and systems - - [Auto-delete branch on merge/close](/admin/config/batch-changes#automatically-delete-branches-on-merge-close), which automatically deletes branches created by Batch Changes when changesets are merged or closed + - [Auto-delete branch on merge/close](/admin/config/batch-changes#automatically-delete-branches-on-mergeclose), which automatically deletes branches created by Batch Changes when changesets are merged or closed - [Commit signing for GitHub](/admin/config/batch-changes#commit-signing-for-github), which signs commits created by Batch Changes via a GitHub App (Beta) - [Batch spec library](/admin/config/batch-changes#batch-spec-library), which help your users write batch specs and follow best practices diff --git a/docs/code-insights/explanations/current-limitations-of-code-insights.mdx b/docs/code-insights/explanations/current-limitations-of-code-insights.mdx index 510610108..fd7b4fee0 100644 --- a/docs/code-insights/explanations/current-limitations-of-code-insights.mdx +++ b/docs/code-insights/explanations/current-limitations-of-code-insights.mdx @@ -78,7 +78,7 @@ Code Insights does not yet support running over specific revisions. ## VCS limitations -Code Insights by default can **not** query repositories that have [sub-repo permissions](/admin/permissions/api#Setting-sub-repository-permissions-for-users) configured. Note that some repositories can sync sub-repo permissions from the code host - Perforce depots currently (6.4). +Code Insights by default can **not** query repositories that have [sub-repo permissions](/admin/permissions/api#setting-sub-repository-permissions-for-users) configured. Note that some repositories can sync sub-repo permissions from the code host - Perforce depots currently (6.4). The reason for that restriction is security concerns around exposing the code in those repositories to users who should not be able to access it. diff --git a/docs/code-insights/references/requirements.mdx b/docs/code-insights/references/requirements.mdx index 4cbfde7b7..9e104cdd6 100644 --- a/docs/code-insights/references/requirements.mdx +++ b/docs/code-insights/references/requirements.mdx @@ -17,4 +17,4 @@ You can only use Code Insights on a [Docker Compose](/self-hosted/deploy/docker- Sourcegraph Code Insights is compatible with any [Sourcegraph-compatible code host](/admin/repo/). -If the repo has [sub-repo permissions](/admin/permissions/api#Setting-sub-repository-permissions-for-users) configured, an admin will need to set `experimentalSettings.subRepoPermissions.allowCodeInsights` to `true` in site config to allow Code Insights to query that repo. +If the repo has [sub-repo permissions](/admin/permissions/api#setting-sub-repository-permissions-for-users) configured, an admin will need to set `experimentalSettings.subRepoPermissions.allowCodeInsights` to `true` in site config to allow Code Insights to query that repo. diff --git a/docs/code-navigation/auto-indexing-configuration.mdx b/docs/code-navigation/auto-indexing-configuration.mdx index c89272953..ffe188d21 100644 --- a/docs/code-navigation/auto-indexing-configuration.mdx +++ b/docs/code-navigation/auto-indexing-configuration.mdx @@ -10,7 +10,7 @@ This document details the expected contents of [explicit index job configuration The root of the configuration has one top-level key, `index_jobs`, documented below. -### [`index_jobs`](#index-jobs) +### [`index_jobs`](#index_jobs) The index jobs field defines a set of [index job objects](#index-job-object) describing the actions to perform to successfully index a fresh clone of a repository. Each index job is executed independently (and possibly in parallel) by an executor. diff --git a/docs/self-hosted/deploy/kubernetes/troubleshoot.mdx b/docs/self-hosted/deploy/kubernetes/troubleshoot.mdx index 5b9a5a198..0cb98d459 100644 --- a/docs/self-hosted/deploy/kubernetes/troubleshoot.mdx +++ b/docs/self-hosted/deploy/kubernetes/troubleshoot.mdx @@ -155,7 +155,7 @@ SEARCHER_URL=http:searcher:3184 The issue described is related to the Code Intel hover feature, where it may get stuck in a loading state or return a 502 error with the message `Squirrel.LocalCodeIntel http status 502`. This is caused by the same issue described in [Symbols sidebar -and hovers are not working](#symbols-sidebar-and-hovers-are-not-working"). See that +and hovers are not working](#symbols-sidebar-and-hovers-are-not-working). See that section for solution. ## Help request diff --git a/docs/self-hosted/deploy/machine-images/aws-oneclick.mdx b/docs/self-hosted/deploy/machine-images/aws-oneclick.mdx index 1410b32e3..64c091aa9 100644 --- a/docs/self-hosted/deploy/machine-images/aws-oneclick.mdx +++ b/docs/self-hosted/deploy/machine-images/aws-oneclick.mdx @@ -10,7 +10,7 @@ Prefer manually installing on AWS yourself? See our [AMI](/self-hosted/deploy/ma ## Prerequisites -- An AWS account (most regions are supported, see our [Launcher](#deploy-sourcegraph) below for a complete list) +- An AWS account (most regions are supported, see our [Launcher](#deploy-sourcegraph-) below for a complete list) - General familiarity with AWS - An [EC2 keypair](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html) for SSH access - (optional) A Sourcegraph license to unlock features ([view plans](https://sourcegraph.com/pricing) or [learn how licenses work](/admin/licensing/)) diff --git a/docs/self-hosted/faq.mdx b/docs/self-hosted/faq.mdx index cf08c73b9..23f465286 100644 --- a/docs/self-hosted/faq.mdx +++ b/docs/self-hosted/faq.mdx @@ -45,7 +45,7 @@ Please refer to [Understanding alerts](/self-hosted/observability/alerting#under ### How do I know when more resources are needed for a specified service? -All resource dashboards contain a section called `Provisioning indicators` that provide information about the current resource usage of containers. These can be used to determine if a scale-up is needed ([example panel](/self-hosted/observability/dashboards#frontend-provisioning-container-cpu-usage-long-term)). +All resource dashboards contain a section called `Provisioning indicators` that provide information about the current resource usage of containers. These can be used to determine if a scale-up is needed ([example panel](/self-hosted/observability/dashboards#frontend-provisioning_container_cpu_usage_long_term)). More information on each available panel in the dashboards is available in the [Dashboards reference](/self-hosted/observability/dashboards). @@ -55,7 +55,7 @@ See [Alert solutions](/self-hosted/observability/alerts) to learn about each ale ### What’s the threshold for each resource? -All resources dashboards contain a section called `Container monitoring` that indicate thresholds at which alerts will fire for each resource ([example alert](/self-hosted/observability/alerts#frontend-container-cpu-usage)). +All resources dashboards contain a section called `Container monitoring` that indicate thresholds at which alerts will fire for each resource ([example alert](/self-hosted/observability/alerts#frontend-container_cpu_usage)). More information on each available panel in the dashboards is available in the [Dashboards reference](/self-hosted/observability/dashboards). @@ -75,7 +75,7 @@ Please refer to our guide on [setting up alerting](/self-hosted/observability/al Creating a custom alert is not recommended and currently not supported by Sourcegraph. However, please provide feedback on the monitoring dashboards and alerts if you find anything could be improved via our issue tracker. -More advanced users can also refer to [our FAQ item about custom consumption of Sourcegraph metrics](#can-i-consume-sourcegraph-s-metrics-in-my-own-monitoring-system-datadog-new-relic-etc). +More advanced users can also refer to [our FAQ item about custom consumption of Sourcegraph metrics](#can-i-consume-sourcegraphs-metrics-in-my-own-monitoring-system-datadog-new-relic-etc). ### Can I consume Sourcegraph's metrics in my own monitoring system (Datadog, New Relic, etc.)? diff --git a/docs/self-hosted/http-https-configuration.mdx b/docs/self-hosted/http-https-configuration.mdx index 8c954c2af..5661f9ce8 100644 --- a/docs/self-hosted/http-https-configuration.mdx +++ b/docs/self-hosted/http-https-configuration.mdx @@ -8,7 +8,7 @@ Overview: ## Sourcegraph single Docker image and Sourcegraph Cluster (Kubernetes): NGINX -Sourcegraph's single Docker image and Kubernetes deployments use [NGINX](https://www.nginx.com/resources/glossary/nginx/) as a [reverse proxy](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) for the Sourcegraph front-end server, meaning NGINX proxies external HTTP (and [HTTPS](#nginx-ssl-https-configuration)) requests to the Sourcegraph front-end. +Sourcegraph's single Docker image and Kubernetes deployments use [NGINX](https://www.nginx.com/resources/glossary/nginx/) as a [reverse proxy](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) for the Sourcegraph front-end server, meaning NGINX proxies external HTTP (and [HTTPS](#nginx-sslhttps-configuration)) requests to the Sourcegraph front-end. ![NGINX and Sourcegraph architecture](https://storage.googleapis.com/sourcegraph-assets/Docs/sourcegraph-nginx.svg) @@ -23,7 +23,7 @@ The first time Sourcegraph is run, it will create an [`nginx.conf`](https://gith SSL support requires two things: -1. [Manual editing](#nginx-ssl-https-configuration) of the NGINX configuration file if using the [quickstart docker run command](/#quick-install) as it presumes local or internal usage. +1. [Manual editing](#nginx-sslhttps-configuration) of the NGINX configuration file if using the [quickstart docker run command](/#quick-install) as it presumes local or internal usage. 1. (Now that NGINX is listening on port 7443), we need to configure the Sourcegraph container to forward 443 to 7443 by adding `--publish 443:7443` to the `docker run` command: From 3efd715dbbd40a09dc4f4645a384817107bf7d47 Mon Sep 17 00:00:00 2001 From: Marc LeBlanc <7050295+marcleblanc2@users.noreply.github.com> Date: Mon, 7 Sep 2026 17:43:20 -0600 Subject: [PATCH 2/2] Add three link fixes that share lines with this PR's slug fixes Amp-Thread-ID: https://ampcode.com/threads/T-01a07623-9d65-7356-96b8-2bebb31ffa5a Co-authored-by: Amp --- docs/batch-changes/batch-spec-yaml-reference.mdx | 2 +- docs/batch-changes/site-admin-configuration.mdx | 2 +- docs/self-hosted/http-https-configuration.mdx | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/batch-changes/batch-spec-yaml-reference.mdx b/docs/batch-changes/batch-spec-yaml-reference.mdx index 333578881..79a105c21 100644 --- a/docs/batch-changes/batch-spec-yaml-reference.mdx +++ b/docs/batch-changes/batch-spec-yaml-reference.mdx @@ -883,7 +883,7 @@ For each repository yielded by [`on`](#on), a Sourcegraph search is used to get Since multiple workspaces in the same repository can produce multiple changesets, it's **required** to use templating to produce a unique [`changesetTemplate.branch`](#changesettemplatebranch) for each produced - changeset. See the [examples](#workspaces-examples) below. + changeset. See the [examples](#examples-18) below. ### Examples diff --git a/docs/batch-changes/site-admin-configuration.mdx b/docs/batch-changes/site-admin-configuration.mdx index f49d799a1..524bce723 100644 --- a/docs/batch-changes/site-admin-configuration.mdx +++ b/docs/batch-changes/site-admin-configuration.mdx @@ -18,7 +18,7 @@ Using Batch Changes requires a [code host connection](/admin/code-hosts/) to a s - [Forks](/admin/config/batch-changes#forks), which push branches created by Batch Changes onto forks of the upstream repository instead of the repository itself - [Outgoing webhooks](/admin/webhooks/outgoing), which publish events related to batch changes and changesets to enable deeper integrations with your other tools and systems - [Auto-delete branch on merge/close](/admin/config/batch-changes#automatically-delete-branches-on-mergeclose), which automatically deletes branches created by Batch Changes when changesets are merged or closed - - [Commit signing for GitHub](/admin/config/batch-changes#commit-signing-for-github), which signs commits created by Batch Changes via a GitHub App (Beta) + - [Commit signing for GitHub](/admin/config/batch-changes#commit-signing-with-github-apps), which signs commits created by Batch Changes via a GitHub App (Beta) - [Batch spec library](/admin/config/batch-changes#batch-spec-library), which help your users write batch specs and follow best practices ## Disable Batch Changes diff --git a/docs/self-hosted/http-https-configuration.mdx b/docs/self-hosted/http-https-configuration.mdx index 5661f9ce8..11e5681ed 100644 --- a/docs/self-hosted/http-https-configuration.mdx +++ b/docs/self-hosted/http-https-configuration.mdx @@ -23,7 +23,7 @@ The first time Sourcegraph is run, it will create an [`nginx.conf`](https://gith SSL support requires two things: -1. [Manual editing](#nginx-sslhttps-configuration) of the NGINX configuration file if using the [quickstart docker run command](/#quick-install) as it presumes local or internal usage. +1. [Manual editing](#nginx-sslhttps-configuration) of the NGINX configuration file if using the [quickstart docker run command](/self-hosted/deploy) as it presumes local or internal usage. 1. (Now that NGINX is listening on port 7443), we need to configure the Sourcegraph container to forward 443 to 7443 by adding `--publish 443:7443` to the `docker run` command: