🤖 Sync generated docs from sourcegraph/sourcegraph - #1883
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
sourcegraph-buildkite
force-pushed
the
sync/generated-docs
branch
from
September 9, 2026 12:35
39b8e84 to
bc22e86
Compare
sourcegraph-buildkite
force-pushed
the
sync/generated-docs
branch
from
September 10, 2026 07:37
bc22e86 to
7d56216
Compare
sourcegraph-buildkite
force-pushed
the
sync/generated-docs
branch
from
September 10, 2026 11:16
7d56216 to
d765981
Compare
sourcegraph-buildkite
force-pushed
the
sync/generated-docs
branch
from
September 10, 2026 14:10
d765981 to
80fb54e
Compare
marcleblanc2
added a commit
that referenced
this pull request
Sep 11, 2026
…#1899) ## What Rewrites every link to this site that was written as an absolute URL (`https://sourcegraph.com/docs/…`, `http://sourcegraph.com/docs/…`, `https://docs.sourcegraph.com/…`) as a relative link (`/admin/config/site-config`), in 15 files. - 32 pointed at the current route: prefix dropped. - 31 pointed at a moved page and only worked through `src/data/redirects.ts`: now link straight to the destination. - 4 needed a hand fix: the `commands#commands-id-mode` and `features#shard-merging` anchors no longer exist, `github#github-com-rate-limits` became `#rate-limits`, and the deleted gRPC guide now links to its archived 5.3 page. ## Why Absolute links leave the Vercel preview and the local dev server, and hide moved pages behind redirects. #1858 makes `dev/check-links.mjs` fail PRs that add them; this PR clears the backlog so that check starts from zero. ## Verification `node dev/check-links.mjs --check-anchors --root <this branch>` with the checker from #1858: 0 absolute self-links left, and no new findings against `main` (317 → 250 pre-existing findings; the 67 removed are all self-links). ## Notes for reviewers - Bare URLs in prose and code blocks (e.g. the `See https://docs.sourcegraph.com/admin/observability/tracing` cells in `docs/cli/references/*`) are not links and are untouched; #1851 covers those. - `docs/admin/repo/perforce.mdx`, `docs/self-hosted/observability/alerts.mdx` and `dashboards.mdx` are synced from sourcegraph/sourcegraph (#1883); the same links need the same fix upstream or the next sync reverts them. - `docs/technical-changelog.mdx` holds 31 of the links and is retired by #1888; if that lands first, take the deletion. Co-authored-by: Amp <amp@ampcode.com>
sourcegraph-buildkite
force-pushed
the
sync/generated-docs
branch
from
September 11, 2026 07:58
80fb54e to
91d8a8e
Compare
Contributor
❌ This PR introduces 26 broken link(s)Absolute linksWrite links on this site as relative paths (
Reproduce locally with Adding a redirect in |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| # Private metadata allowlist | ||
|
|
||
| This document lists all telemetry events that are allowed to export specific `privateMetadata` fields (from within [telemetry event parameters](/admin/telemetry/protocol#telemetrygateway-v1-EventParameters)). | ||
| This document lists all telemetry events that are allowed to export specific `privateMetadata` fields (from within [telemetry event parameters](https://sourcegraph.com/docs/admin/telemetry/protocol#telemetrygateway-v1-EventParameters)). |
Contributor
There was a problem hiding this comment.
https://sourcegraph.com/docs/admin/telemetry/protocol#telemetrygateway-v1-EventParameters: Absolute self-link; use "/admin/telemetry/protocol#telemetrygateway-v1-EventParameters" instead
Suggested change
| This document lists all telemetry events that are allowed to export specific `privateMetadata` fields (from within [telemetry event parameters](https://sourcegraph.com/docs/admin/telemetry/protocol#telemetrygateway-v1-EventParameters)). | |
| This document lists all telemetry events that are allowed to export specific `privateMetadata` fields (from within [telemetry event parameters](/admin/telemetry/protocol#telemetrygateway-v1-EventParameters)). |
|
|
||
| The only `metadata` we collect by default are non-sensitive numeric values. | ||
| To learn more, refer to the [telemetry documentation](/admin/telemetry). | ||
| To learn more, refer to the [telemetry documentation](https://sourcegraph.com/docs/admin/telemetry). |
Contributor
There was a problem hiding this comment.
https://sourcegraph.com/docs/admin/telemetry: Absolute self-link; use "/admin/telemetry" instead
Suggested change
| To learn more, refer to the [telemetry documentation](https://sourcegraph.com/docs/admin/telemetry). | |
| To learn more, refer to the [telemetry documentation](/admin/telemetry). |
| This page contains the core schema for telemetry event data that gets exported from Sourcegraph. | ||
|
|
||
| To learn more, refer to our [telemetry documentation](/admin/telemetry). | ||
| To learn more, refer to our [telemetry documentation](https://sourcegraph.com/docs/admin/telemetry). |
Contributor
There was a problem hiding this comment.
https://sourcegraph.com/docs/admin/telemetry: Absolute self-link; use "/admin/telemetry" instead
Suggested change
| To learn more, refer to our [telemetry documentation](https://sourcegraph.com/docs/admin/telemetry). | |
| To learn more, refer to our [telemetry documentation](/admin/telemetry). |
| If your alert isn't mentioned here, or if the next steps don't help, [contact us](mailto:support@sourcegraph.com) for assistance. | ||
|
|
||
| To learn more about Sourcegraph's alerting and how to set up alerts, see [our alerting guide](/self-hosted/observability/alerting). | ||
| To learn more about Sourcegraph's alerting and how to set up alerts, see [our alerting guide](https://sourcegraph.com/docs/admin/observability/alerting). |
Contributor
There was a problem hiding this comment.
https://sourcegraph.com/docs/admin/observability/alerting: Absolute self-link to a moved page; use "/self-hosted/observability/alerting" instead
Suggested change
| To learn more about Sourcegraph's alerting and how to set up alerts, see [our alerting guide](https://sourcegraph.com/docs/admin/observability/alerting). | |
| To learn more about Sourcegraph's alerting and how to set up alerts, see [our alerting guide](/self-hosted/observability/alerting). |
| - **Kubernetes:** Check CPU usage of zoekt-webserver in the indexed-search pod, consider increasing CPU limits in the `indexed-search.Deployment.yaml` if regularly hitting max CPU utilization. | ||
| - **Docker Compose:** Check CPU usage on the Zoekt Web Server dashboard, consider increasing `cpus:` of the zoekt-webserver container in `docker-compose.yml` if regularly hitting max CPU utilization. | ||
| - This alert may indicate that your instance is struggling to process symbols queries on a monorepo, [learn more here](/admin/monorepo). | ||
| - This alert may indicate that your instance is struggling to process symbols queries on a monorepo, [learn more here](https://sourcegraph.com/docs/admin/monorepo). |
Contributor
There was a problem hiding this comment.
https://sourcegraph.com/docs/admin/monorepo: Absolute self-link; use "/admin/monorepo" instead
Suggested change
| - This alert may indicate that your instance is struggling to process symbols queries on a monorepo, [learn more here](https://sourcegraph.com/docs/admin/monorepo). | |
| - This alert may indicate that your instance is struggling to process symbols queries on a monorepo, [learn more here](/admin/monorepo). |
| **Next steps** | ||
|
|
||
| - Ensure that your [`observability.alerts` configuration](/self-hosted/observability/alerting#setting-up-alerting) (in site configuration) is valid. | ||
| - Ensure that your [`observability.alerts` configuration](https://sourcegraph.com/docs/admin/observability/alerting#setting-up-alerting) (in site configuration) is valid. |
Contributor
There was a problem hiding this comment.
https://sourcegraph.com/docs/admin/observability/alerting#setting-up-alerting: Absolute self-link to a moved page; use "/self-hosted/observability/alerting#setting-up-alerting" instead
Suggested change
| - Ensure that your [`observability.alerts` configuration](https://sourcegraph.com/docs/admin/observability/alerting#setting-up-alerting) (in site configuration) is valid. | |
| - Ensure that your [`observability.alerts` configuration](/self-hosted/observability/alerting#setting-up-alerting) (in site configuration) is valid. |
| @@ -4,7 +4,7 @@ | |||
|
|
|||
| This document contains a complete reference on Sourcegraph's available dashboards, as well as details on how to interpret the panels and metrics. | |||
|
|
|||
| To learn more about Sourcegraph's metrics and how to view these dashboards, see [our metrics guide](/self-hosted/observability/metrics). | |||
| To learn more about Sourcegraph's metrics and how to view these dashboards, see [our metrics guide](https://sourcegraph.com/docs/admin/observability/metrics). | |||
Contributor
There was a problem hiding this comment.
https://sourcegraph.com/docs/admin/observability/metrics: Absolute self-link to a moved page; use "/self-hosted/observability/metrics" instead
Suggested change
| To learn more about Sourcegraph's metrics and how to view these dashboards, see [our metrics guide](https://sourcegraph.com/docs/admin/observability/metrics). | |
| To learn more about Sourcegraph's metrics and how to view these dashboards, see [our metrics guide](/self-hosted/observability/metrics). |
| @@ -16542,11 +16720,11 @@ max by (type) (ceil(rate(src_repo_perms_syncer_sync_errors_total[1m]))) | |||
| <p class="subtitle">Rate of users/repos scheduled for permissions sync</p> | |||
|
|
|||
| Indicates the per-minute rate at which users/repositories are scheduled for a permissions sync. | |||
| More about repository permissions synchronization [here](/admin/permissions/syncing#scheduling) | |||
| More about repository permissions synchronization [here](https://sourcegraph.com/docs/admin/permissions/syncing#scheduling) | |||
Contributor
There was a problem hiding this comment.
https://sourcegraph.com/docs/admin/permissions/syncing#scheduling: Absolute self-link; use "/admin/permissions/syncing#scheduling" instead
Suggested change
| More about repository permissions synchronization [here](https://sourcegraph.com/docs/admin/permissions/syncing#scheduling) | |
| More about repository permissions synchronization [here](/admin/permissions/syncing#scheduling) |
| @@ -26272,7 +26628,7 @@ sum by(job) (scrape_samples_post_metric_relabeling{job!=""}) | |||
| A high value here indicates Prometheus rule evaluation is taking longer than expected. | |||
| It might indicate that certain rule groups are taking too long to evaluate, or Prometheus is underprovisioned. | |||
|
|
|||
| Rules that Sourcegraph ships with are grouped under `/sg_config_prometheus`. [Custom rules are grouped under `/sg_prometheus_addons`](/self-hosted/observability/metrics#prometheus-configuration). | |||
| Rules that Sourcegraph ships with are grouped under `/sg_config_prometheus`. [Custom rules are grouped under `/sg_prometheus_addons`](https://sourcegraph.com/docs/admin/observability/metrics#prometheus-configuration). | |||
Contributor
There was a problem hiding this comment.
https://sourcegraph.com/docs/admin/observability/metrics#prometheus-configuration: Absolute self-link to a moved page; use "/self-hosted/observability/metrics#prometheus-configuration" instead
Suggested change
| Rules that Sourcegraph ships with are grouped under `/sg_config_prometheus`. [Custom rules are grouped under `/sg_prometheus_addons`](https://sourcegraph.com/docs/admin/observability/metrics#prometheus-configuration). | |
| Rules that Sourcegraph ships with are grouped under `/sg_config_prometheus`. [Custom rules are grouped under `/sg_prometheus_addons`](/self-hosted/observability/metrics#prometheus-configuration). |
| @@ -26296,7 +26652,7 @@ sum by(rule_group) (avg_over_time(prometheus_rule_group_last_duration_seconds[10 | |||
|
|
|||
| <p class="subtitle">Failed prometheus rule evaluations over 5m by rule group</p> | |||
|
|
|||
| Rules that Sourcegraph ships with are grouped under `/sg_config_prometheus`. [Custom rules are grouped under `/sg_prometheus_addons`](/self-hosted/observability/metrics#prometheus-configuration). | |||
| Rules that Sourcegraph ships with are grouped under `/sg_config_prometheus`. [Custom rules are grouped under `/sg_prometheus_addons`](https://sourcegraph.com/docs/admin/observability/metrics#prometheus-configuration). | |||
Contributor
There was a problem hiding this comment.
https://sourcegraph.com/docs/admin/observability/metrics#prometheus-configuration: Absolute self-link to a moved page; use "/self-hosted/observability/metrics#prometheus-configuration" instead
Suggested change
| Rules that Sourcegraph ships with are grouped under `/sg_config_prometheus`. [Custom rules are grouped under `/sg_prometheus_addons`](https://sourcegraph.com/docs/admin/observability/metrics#prometheus-configuration). | |
| Rules that Sourcegraph ships with are grouped under `/sg_config_prometheus`. [Custom rules are grouped under `/sg_prometheus_addons`](/self-hosted/observability/metrics#prometheus-configuration). |
Contributor
sourcegraph-buildkite
force-pushed
the
sync/generated-docs
branch
2 times, most recently
from
September 11, 2026 08:43
52f98f3 to
cda1eee
Compare
Contributor
|
I'm working on unblocking this in |
filiphaftek
approved these changes
Sep 11, 2026
sourcegraph-buildkite
force-pushed
the
sync/generated-docs
branch
from
September 11, 2026 16:59
cda1eee to
1fb3439
Compare
This was referenced Sep 11, 2026
sourcegraph-buildkite
force-pushed
the
sync/generated-docs
branch
from
September 14, 2026 08:37
1fb3439 to
744ecb5
Compare
| # Private metadata allowlist | ||
|
|
||
| This document lists all telemetry events that are allowed to export specific `privateMetadata` fields (from within [telemetry event parameters](/admin/telemetry/protocol#telemetrygateway-v1-EventParameters)). | ||
| This document lists all telemetry events that are allowed to export specific `privateMetadata` fields (from within [telemetry event parameters](https://sourcegraph.com/docs/admin/telemetry/protocol#telemetrygateway-v1-EventParameters)). |
Contributor
There was a problem hiding this comment.
Link: https://sourcegraph.com/docs/admin/telemetry/protocol#telemetrygateway-v1-EventParameters
Problem: Absolute link to this site
Fix: /admin/telemetry/protocol#telemetrygateway-v1-EventParameters
Suggested change
| This document lists all telemetry events that are allowed to export specific `privateMetadata` fields (from within [telemetry event parameters](https://sourcegraph.com/docs/admin/telemetry/protocol#telemetrygateway-v1-EventParameters)). | |
| This document lists all telemetry events that are allowed to export specific `privateMetadata` fields (from within [telemetry event parameters](/admin/telemetry/protocol#telemetrygateway-v1-EventParameters)). |
|
|
||
| The only `metadata` we collect by default are non-sensitive numeric values. | ||
| To learn more, refer to the [telemetry documentation](/admin/telemetry). | ||
| To learn more, refer to the [telemetry documentation](https://sourcegraph.com/docs/admin/telemetry). |
Contributor
There was a problem hiding this comment.
Link: https://sourcegraph.com/docs/admin/telemetry
Problem: Absolute link to this site
Fix: /admin/telemetry
Suggested change
| To learn more, refer to the [telemetry documentation](https://sourcegraph.com/docs/admin/telemetry). | |
| To learn more, refer to the [telemetry documentation](/admin/telemetry). |
| This page contains the core schema for telemetry event data that gets exported from Sourcegraph. | ||
|
|
||
| To learn more, refer to our [telemetry documentation](/admin/telemetry). | ||
| To learn more, refer to our [telemetry documentation](https://sourcegraph.com/docs/admin/telemetry). |
Contributor
There was a problem hiding this comment.
Link: https://sourcegraph.com/docs/admin/telemetry
Problem: Absolute link to this site
Fix: /admin/telemetry
Suggested change
| To learn more, refer to our [telemetry documentation](https://sourcegraph.com/docs/admin/telemetry). | |
| To learn more, refer to our [telemetry documentation](/admin/telemetry). |
| If your alert isn't mentioned here, or if the next steps don't help, [contact us](mailto:support@sourcegraph.com) for assistance. | ||
|
|
||
| To learn more about Sourcegraph's alerting and how to set up alerts, see [our alerting guide](/self-hosted/observability/alerting). | ||
| To learn more about Sourcegraph's alerting and how to set up alerts, see [our alerting guide](https://sourcegraph.com/docs/admin/observability/alerting). |
Contributor
There was a problem hiding this comment.
Link: https://sourcegraph.com/docs/admin/observability/alerting
Problem: Absolute link to a moved page
Fix: /self-hosted/observability/alerting
Suggested change
| To learn more about Sourcegraph's alerting and how to set up alerts, see [our alerting guide](https://sourcegraph.com/docs/admin/observability/alerting). | |
| To learn more about Sourcegraph's alerting and how to set up alerts, see [our alerting guide](/self-hosted/observability/alerting). |
| - **Kubernetes:** Check CPU usage of zoekt-webserver in the indexed-search pod, consider increasing CPU limits in the `indexed-search.Deployment.yaml` if regularly hitting max CPU utilization. | ||
| - **Docker Compose:** Check CPU usage on the Zoekt Web Server dashboard, consider increasing `cpus:` of the zoekt-webserver container in `docker-compose.yml` if regularly hitting max CPU utilization. | ||
| - This alert may indicate that your instance is struggling to process symbols queries on a monorepo, [learn more here](/admin/monorepo). | ||
| - This alert may indicate that your instance is struggling to process symbols queries on a monorepo, [learn more here](https://sourcegraph.com/docs/admin/monorepo). |
Contributor
There was a problem hiding this comment.
Link: https://sourcegraph.com/docs/admin/monorepo
Problem: Absolute link to this site
Fix: /admin/monorepo
Suggested change
| - This alert may indicate that your instance is struggling to process symbols queries on a monorepo, [learn more here](https://sourcegraph.com/docs/admin/monorepo). | |
| - This alert may indicate that your instance is struggling to process symbols queries on a monorepo, [learn more here](/admin/monorepo). |
| **Next steps** | ||
|
|
||
| - Ensure that your [`observability.alerts` configuration](/self-hosted/observability/alerting#setting-up-alerting) (in site configuration) is valid. | ||
| - Ensure that your [`observability.alerts` configuration](https://sourcegraph.com/docs/admin/observability/alerting#setting-up-alerting) (in site configuration) is valid. |
Contributor
There was a problem hiding this comment.
Link: https://sourcegraph.com/docs/admin/observability/alerting#setting-up-alerting
Problem: Absolute link to a moved page
Fix: /self-hosted/observability/alerting#setting-up-alerting
Suggested change
| - Ensure that your [`observability.alerts` configuration](https://sourcegraph.com/docs/admin/observability/alerting#setting-up-alerting) (in site configuration) is valid. | |
| - Ensure that your [`observability.alerts` configuration](/self-hosted/observability/alerting#setting-up-alerting) (in site configuration) is valid. |
| @@ -4,7 +4,7 @@ | |||
|
|
|||
| This document contains a complete reference on Sourcegraph's available dashboards, as well as details on how to interpret the panels and metrics. | |||
|
|
|||
| To learn more about Sourcegraph's metrics and how to view these dashboards, see [our metrics guide](/self-hosted/observability/metrics). | |||
| To learn more about Sourcegraph's metrics and how to view these dashboards, see [our metrics guide](https://sourcegraph.com/docs/admin/observability/metrics). | |||
Contributor
There was a problem hiding this comment.
Link: https://sourcegraph.com/docs/admin/observability/metrics
Problem: Absolute link to a moved page
Fix: /self-hosted/observability/metrics
Suggested change
| To learn more about Sourcegraph's metrics and how to view these dashboards, see [our metrics guide](https://sourcegraph.com/docs/admin/observability/metrics). | |
| To learn more about Sourcegraph's metrics and how to view these dashboards, see [our metrics guide](/self-hosted/observability/metrics). |
| @@ -16542,11 +16720,11 @@ max by (type) (ceil(rate(src_repo_perms_syncer_sync_errors_total[1m]))) | |||
| <p class="subtitle">Rate of users/repos scheduled for permissions sync</p> | |||
|
|
|||
| Indicates the per-minute rate at which users/repositories are scheduled for a permissions sync. | |||
| More about repository permissions synchronization [here](/admin/permissions/syncing#scheduling) | |||
| More about repository permissions synchronization [here](https://sourcegraph.com/docs/admin/permissions/syncing#scheduling) | |||
Contributor
There was a problem hiding this comment.
Link: https://sourcegraph.com/docs/admin/permissions/syncing#scheduling
Problem: Absolute link to this site
Fix: /admin/permissions/syncing#scheduling
Suggested change
| More about repository permissions synchronization [here](https://sourcegraph.com/docs/admin/permissions/syncing#scheduling) | |
| More about repository permissions synchronization [here](/admin/permissions/syncing#scheduling) |
| @@ -26272,7 +26628,7 @@ sum by(job) (scrape_samples_post_metric_relabeling{job!=""}) | |||
| A high value here indicates Prometheus rule evaluation is taking longer than expected. | |||
| It might indicate that certain rule groups are taking too long to evaluate, or Prometheus is underprovisioned. | |||
|
|
|||
| Rules that Sourcegraph ships with are grouped under `/sg_config_prometheus`. [Custom rules are grouped under `/sg_prometheus_addons`](/self-hosted/observability/metrics#prometheus-configuration). | |||
| Rules that Sourcegraph ships with are grouped under `/sg_config_prometheus`. [Custom rules are grouped under `/sg_prometheus_addons`](https://sourcegraph.com/docs/admin/observability/metrics#prometheus-configuration). | |||
Contributor
There was a problem hiding this comment.
Link: https://sourcegraph.com/docs/admin/observability/metrics#prometheus-configuration
Problem: Absolute link to a moved page
Fix: /self-hosted/observability/metrics#prometheus-configuration
Suggested change
| Rules that Sourcegraph ships with are grouped under `/sg_config_prometheus`. [Custom rules are grouped under `/sg_prometheus_addons`](https://sourcegraph.com/docs/admin/observability/metrics#prometheus-configuration). | |
| Rules that Sourcegraph ships with are grouped under `/sg_config_prometheus`. [Custom rules are grouped under `/sg_prometheus_addons`](/self-hosted/observability/metrics#prometheus-configuration). |
| @@ -26296,7 +26652,7 @@ sum by(rule_group) (avg_over_time(prometheus_rule_group_last_duration_seconds[10 | |||
|
|
|||
| <p class="subtitle">Failed prometheus rule evaluations over 5m by rule group</p> | |||
|
|
|||
| Rules that Sourcegraph ships with are grouped under `/sg_config_prometheus`. [Custom rules are grouped under `/sg_prometheus_addons`](/self-hosted/observability/metrics#prometheus-configuration). | |||
| Rules that Sourcegraph ships with are grouped under `/sg_config_prometheus`. [Custom rules are grouped under `/sg_prometheus_addons`](https://sourcegraph.com/docs/admin/observability/metrics#prometheus-configuration). | |||
Contributor
There was a problem hiding this comment.
Link: https://sourcegraph.com/docs/admin/observability/metrics#prometheus-configuration
Problem: Absolute link to a moved page
Fix: /self-hosted/observability/metrics#prometheus-configuration
Suggested change
| Rules that Sourcegraph ships with are grouped under `/sg_config_prometheus`. [Custom rules are grouped under `/sg_prometheus_addons`](https://sourcegraph.com/docs/admin/observability/metrics#prometheus-configuration). | |
| Rules that Sourcegraph ships with are grouped under `/sg_config_prometheus`. [Custom rules are grouped under `/sg_prometheus_addons`](/self-hosted/observability/metrics#prometheus-configuration). |
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
4 participants
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.
This is an automated pull request, created by //doc:generated.push on sourcegraph/sourcegraph