From 9d82a301a6baefbf3287981a3cd66169200415ee Mon Sep 17 00:00:00 2001 From: Alex Jean-Baptiste Date: Wed, 11 Dec 2024 20:45:35 -0500 Subject: [PATCH] Updating sourcegraph.com search links first pass --- docs/admin/audit_log.mdx | 6 +++--- docs/admin/config/advanced_config_file.mdx | 2 +- docs/admin/deploy/kubernetes/configure.mdx | 2 +- docs/admin/enterprise_getting_started_guide/index.mdx | 2 +- docs/admin/executors/deploy_executors_binary.mdx | 2 +- docs/admin/executors/deploy_executors_binary_offline.mdx | 4 ++-- docs/admin/executors/deploy_executors_kubernetes.mdx | 4 ++-- docs/admin/executors/firecracker.mdx | 2 +- docs/admin/how-to/dirty_database_pre_3_37.mdx | 2 +- docs/admin/how-to/monorepo-issues.mdx | 2 +- docs/admin/how-to/redis_configmap.mdx | 4 ++-- docs/admin/observability/opentelemetry.mdx | 6 +++--- docs/admin/pings.mdx | 4 ++-- docs/admin/repo/perforce.mdx | 8 ++++---- docs/admin/security_event_logs.mdx | 8 ++++---- docs/api/graphql/index.mdx | 2 +- docs/api/stream_api/index.mdx | 2 +- docs/cloud/index.mdx | 2 +- 18 files changed, 32 insertions(+), 32 deletions(-) diff --git a/docs/admin/audit_log.mdx b/docs/admin/audit_log.mdx index 05c837dfb..6e69f44f3 100644 --- a/docs/admin/audit_log.mdx +++ b/docs/admin/audit_log.mdx @@ -52,8 +52,8 @@ Here's a word-by-word breakout to demonstrate how the captured entry aligns with ### What is audited? - [Security events](./security_event_logs) -- [Gitserver access](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/cmd/gitserver/internal/accesslog/accesslog.go?L100-104) -- [GraphQL requests](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/cmd/frontend/internal/httpapi/graphql.go?L226-244) +- [Gitserver access](TODO/UPDATE SOURCEGRAPH SEARCH LINK/-/blob/cmd/gitserver/internal/accesslog/accesslog.go?L100-104) +- [GraphQL requests](TODO/UPDATE SOURCEGRAPH SEARCH LINK/-/blob/cmd/frontend/internal/httpapi/graphql.go?L226-244) This list is expected to grow in the future. @@ -125,7 +125,7 @@ If you are interested to use this feature or to stream to a different destinatio ## Developing -The single entry point to the audit logging API is made via the [`audit.Log`](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/internal/audit/audit.go?L19) function. This internal function can be used from any place in the app, and nothing else needs to be done for the logged entry to appear in the audit log. +The single entry point to the audit logging API is made via the [`audit.Log`](TODO/UPDATE SOURCEGRAPH SEARCH LINK/-/blob/internal/audit/audit.go?L19) function. This internal function can be used from any place in the app, and nothing else needs to be done for the logged entry to appear in the audit log. Example call: ``` diff --git a/docs/admin/config/advanced_config_file.mdx b/docs/admin/config/advanced_config_file.mdx index 347c402c5..c958bf4fd 100644 --- a/docs/admin/config/advanced_config_file.mdx +++ b/docs/admin/config/advanced_config_file.mdx @@ -90,7 +90,7 @@ Where `extsvc.json` contains a JSON object that specifies _all_ of your code hos } ``` -You can find a full list of [valid top-level keys here](https://sourcegraph.com/github.com/sourcegraph/sourcegraph-public-snapshot@b7ebb9024e3a95109fdedfb8057795b9a7c638bc/-/blob/cmd/frontend/graphqlbackend/schema.graphql#L1104-1110). +You can find a full list of [valid top-level keys here](TODO/UPDATE SOURCEGRAPH SEARCH LINK-public-snapshot@b7ebb9024e3a95109fdedfb8057795b9a7c638bc/-/blob/cmd/frontend/graphqlbackend/schema.graphql#L1104-1110). If you want to _allow_ edits to be made through the web UI (which will be overwritten with what is in the file on a subsequent restart), you may additionally set `EXTSVC_CONFIG_ALLOW_EDITS=true`. **Note** that if you do enable this, it is your responsibility to ensure the configuration on your instance and in the file remain in sync. diff --git a/docs/admin/deploy/kubernetes/configure.mdx b/docs/admin/deploy/kubernetes/configure.mdx index 988ed29d1..b1a29b0ba 100644 --- a/docs/admin/deploy/kubernetes/configure.mdx +++ b/docs/admin/deploy/kubernetes/configure.mdx @@ -174,7 +174,7 @@ Following these steps will allow Prometheus to successfully scrape metrics from ## Tracing -Sourcegraph exports traces in OpenTelemetry format. The OpenTelemetry collector, which must be configured as part of the deployment using the [otel component](#deploy-opentelemetry-collector), [collects and exports traces](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/docker-images/opentelemetry-collector/configs/logging.yaml). +Sourcegraph exports traces in OpenTelemetry format. The OpenTelemetry collector, which must be configured as part of the deployment using the [otel component](#deploy-opentelemetry-collector), [collects and exports traces](TODO/UPDATE SOURCEGRAPH SEARCH LINK/-/blob/docker-images/opentelemetry-collector/configs/logging.yaml). By default, Sourcegraph supports exporting traces to multiple backends including Jaeger. diff --git a/docs/admin/enterprise_getting_started_guide/index.mdx b/docs/admin/enterprise_getting_started_guide/index.mdx index 379c1f8f4..69cccde4b 100644 --- a/docs/admin/enterprise_getting_started_guide/index.mdx +++ b/docs/admin/enterprise_getting_started_guide/index.mdx @@ -18,7 +18,7 @@ If you're deploying a new Enterprise instance, this page covers our most frequen - [GitHub integration](/integration/github) - [All code host integrations (not GitLab or GitHub)](/integration/#integrations) - [Full guide to site config options](/admin/config/site_config#auth-sessionExpiry) -- [Changelog](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/CHANGELOG) to track releases and updates +- [Changelog](TODO/UPDATE SOURCEGRAPH SEARCH LINK/-/blob/CHANGELOG) to track releases and updates ### Docker-compose - [Basic installation guide](/admin/deploy/docker-compose/) diff --git a/docs/admin/executors/deploy_executors_binary.mdx b/docs/admin/executors/deploy_executors_binary.mdx index 9a9656dbb..a430ba9e4 100644 --- a/docs/admin/executors/deploy_executors_binary.mdx +++ b/docs/admin/executors/deploy_executors_binary.mdx @@ -155,7 +155,7 @@ If you use the systemd service, simply run `systemctl start executor`, otherwise ## Upgrading executors Upgrading executors is relatively uninvolved. Simply follow the instructions below. -Also, check the [changelog](https://sourcegraph.com/github.com/sourcegraph/sourcegraph@main/-/blob/CHANGELOG) for any Executors related breaking changes or new features that you might want to configure. +Also, check the [changelog](TODO/UPDATE SOURCEGRAPH SEARCH LINK@main/-/blob/CHANGELOG) for any Executors related breaking changes or new features that you might want to configure. ### **Step 1:** First, grab the executor binary for the new target Sourcegraph version. diff --git a/docs/admin/executors/deploy_executors_binary_offline.mdx b/docs/admin/executors/deploy_executors_binary_offline.mdx index 7e713581d..c84221d8a 100644 --- a/docs/admin/executors/deploy_executors_binary_offline.mdx +++ b/docs/admin/executors/deploy_executors_binary_offline.mdx @@ -168,7 +168,7 @@ To install the Firecracker sandbox image, import the image using `docker`. $ docker pull ``` -> Note: Check the [version](https://sourcegraph.com/github.com/sourcegraph/sourcegraph@main/-/blob/cmd/executor/internal/config/consts.go?L15) against the version of executors being installed. +> Note: Check the [version](TODO/UPDATE SOURCEGRAPH SEARCH LINK@main/-/blob/cmd/executor/internal/config/consts.go?L15) against the version of executors being installed. If you are using a custom image instead of the Sourcegraph image, you will need to set the environment variable `EXECUTOR_FIRECRACKER_SANDBOX_IMAGE` to match the image name. @@ -181,7 +181,7 @@ To install the Firecracker Kernel image, import the image (`sourcegraph/ignite-k $ ignite kernel import --runtime docker ``` -> Note: Check the [version](https://sourcegraph.com/github.com/sourcegraph/sourcegraph@main/-/blob/cmd/executor/internal/config/consts.go?L18) against the version of executors being installed. +> Note: Check the [version](TODO/UPDATE SOURCEGRAPH SEARCH LINK@main/-/blob/cmd/executor/internal/config/consts.go?L18) against the version of executors being installed. If you are using a custom image instead of the Sourcegraph image, you will need to set the environment variable `EXECUTOR_FIRECRACKER_KERNEL_IMAGE` to match the image name. diff --git a/docs/admin/executors/deploy_executors_kubernetes.mdx b/docs/admin/executors/deploy_executors_kubernetes.mdx index 20a87c983..17d2a4a0a 100644 --- a/docs/admin/executors/deploy_executors_kubernetes.mdx +++ b/docs/admin/executors/deploy_executors_kubernetes.mdx @@ -13,7 +13,7 @@ Executors interact with the Kubernetes API to manage the lifecycle of individual | `batch` | `jobs` | `create`, `delete` | Executors create Job pods to run processes. Once Jobs are completed, they are cleaned up. | | | `pods`, `pods/log` | `get`, `list`, `watch` | Executors need to look up and steam logs from the Job Pods. | -See the [example Role YAML](https://sourcegraph.com/github.com/sourcegraph/sourcegraph@main/-/blob/cmd/executor/kubernetes/batches/executor-batches.Role.yml) for more details on the exact RBAC requirements for native Kubernetes Executors. +See the [example Role YAML](TODO/UPDATE SOURCEGRAPH SEARCH LINK@main/-/blob/cmd/executor/kubernetes/batches/executor-batches.Role.yml) for more details on the exact RBAC requirements for native Kubernetes Executors. ## Deployment @@ -94,5 +94,5 @@ The Executor Docker image is available on Docker Hub at [`sourcegraph/executor-k ### Example Configuration YAML See -the [local development YAMLs](https://sourcegraph.com/github.com/sourcegraph/sourcegraph@main/-/blob/cmd/executor/kubernetes) +the [local development YAMLs](TODO/UPDATE SOURCEGRAPH SEARCH LINK@main/-/blob/cmd/executor/kubernetes) for an example of how to configure the Executor in Kubernetes. \ No newline at end of file diff --git a/docs/admin/executors/firecracker.mdx b/docs/admin/executors/firecracker.mdx index f5399da59..22298bd82 100644 --- a/docs/admin/executors/firecracker.mdx +++ b/docs/admin/executors/firecracker.mdx @@ -41,4 +41,4 @@ Executor can be fined tuned with the following environment variables, ## Known caveats -We [configure iptables](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/cmd/executor/internal/run/install.go?L229-255) to prevent Firecracker-isolated processes from talking on [Private IPv4 Addresses](https://en.wikipedia.org/wiki/Private_network#Private_IPv4_addresses) (providing network-level isolation). They can talk to DNS and Sourcegraph only, which prevents users from talking to a 10.x.x.x, 172.x.x.x, or 192.168.x.x range IP. +We [configure iptables](TODO/UPDATE SOURCEGRAPH SEARCH LINK/-/blob/cmd/executor/internal/run/install.go?L229-255) to prevent Firecracker-isolated processes from talking on [Private IPv4 Addresses](https://en.wikipedia.org/wiki/Private_network#Private_IPv4_addresses) (providing network-level isolation). They can talk to DNS and Sourcegraph only, which prevents users from talking to a 10.x.x.x, 172.x.x.x, or 192.168.x.x range IP. diff --git a/docs/admin/how-to/dirty_database_pre_3_37.mdx b/docs/admin/how-to/dirty_database_pre_3_37.mdx index c51fb233e..1899a81e5 100644 --- a/docs/admin/how-to/dirty_database_pre_3_37.mdx +++ b/docs/admin/how-to/dirty_database_pre_3_37.mdx @@ -51,7 +51,7 @@ _Note: for codeintel the schema version table is called `codeintel_schema_migrat ### 2. Run the sql queries to finish incomplete migrations -Sourcegraph's migration files take for form of `sql` files following the snake case naming schema `_..sql` and can be found [here](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/tree/migrations) in subdirectories for the specific database. _Note frontend is the pgsql database_. +Sourcegraph's migration files take for form of `sql` files following the snake case naming schema `_..sql` and can be found [here](TODO/UPDATE SOURCEGRAPH SEARCH LINK/-/tree/migrations) in subdirectories for the specific database. _Note frontend is the pgsql database_. 1. **Find the up migration starting with the migration's version number identified in [step 1](#1-identify-incomplete-migration):** [https://github.com/sourcegraph/sourcegraph/tree/\/migrations](https://github.com/sourcegraph/sourcegraph/tree/main/migrations), making sure to go to \ diff --git a/docs/admin/how-to/monorepo-issues.mdx b/docs/admin/how-to/monorepo-issues.mdx index d142b199f..6f37e6d3a 100644 --- a/docs/admin/how-to/monorepo-issues.mdx +++ b/docs/admin/how-to/monorepo-issues.mdx @@ -18,7 +18,7 @@ The following bullets provide a general guidline to which service may require mo If you are regularly seeing the `Processing symbols is taking longer than expected. Try again in a while` warning in your sidebar, its likely that your symbols and/or gitserver services are underprovisioned and need more CPU/mem resources. -The [symbols sidebar](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/client/web/src/repo/RepoRevisionSidebarSymbols.tsx?L42) is dependent on the symbols and gitserver services. Upon opening the symbols sidebar, a search query is made to the GraphQL API to retrieve the symbols associated with the current git commit. You can read more about the [symbol search behavior and performance](/code-search/types/symbol#symbol-search-behavior-and-performance). +The [symbols sidebar](TODO/UPDATE SOURCEGRAPH SEARCH LINK/-/blob/client/web/src/repo/RepoRevisionSidebarSymbols.tsx?L42) is dependent on the symbols and gitserver services. Upon opening the symbols sidebar, a search query is made to the GraphQL API to retrieve the symbols associated with the current git commit. You can read more about the [symbol search behavior and performance](/code-search/types/symbol#symbol-search-behavior-and-performance). To address this concern, allocate more resources to the symbols service (to provide more processing power for indexing operations) and allocate more resources to the gitserver (to provide for the extra load associated with responding to fetch requests from symbols, and speed up sending the large repo). diff --git a/docs/admin/how-to/redis_configmap.mdx b/docs/admin/how-to/redis_configmap.mdx index 0dc5b4f71..40ff35aea 100644 --- a/docs/admin/how-to/redis_configmap.mdx +++ b/docs/admin/how-to/redis_configmap.mdx @@ -44,7 +44,7 @@ Reference Materials -1. Locate the original redis-cache configuration file: [https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/docker-images/redis-cache/redis.conf](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/docker-images/redis-cache/redis.conf) Use this as the “Default redis.conf file” content in the ConfigMap. Adding `requirepass` sets the password for Redis authentication. +1. Locate the original redis-cache configuration file: [TODO/UPDATE SOURCEGRAPH SEARCH LINK/-/blob/docker-images/redis-cache/redis.conf](TODO/UPDATE SOURCEGRAPH SEARCH LINK/-/blob/docker-images/redis-cache/redis.conf) Use this as the “Default redis.conf file” content in the ConfigMap. Adding `requirepass` sets the password for Redis authentication. 2. Create the redis-cache-conf ConfigMap: ``` @@ -110,7 +110,7 @@ spec: ``` -4. Locate the original redis-store configuration file. [https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/docker-images/redis-store/redis.conf](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/docker-images/redis-store/redis.conf) Use this as the “Default redis.conf file” content in the ConfigMap. +4. Locate the original redis-store configuration file. [TODO/UPDATE SOURCEGRAPH SEARCH LINK/-/blob/docker-images/redis-store/redis.conf](TODO/UPDATE SOURCEGRAPH SEARCH LINK/-/blob/docker-images/redis-store/redis.conf) Use this as the “Default redis.conf file” content in the ConfigMap. 5. Create the redis-store-conf ConfigMap: diff --git a/docs/admin/observability/opentelemetry.mdx b/docs/admin/observability/opentelemetry.mdx index 069ad2887..1f16db869 100644 --- a/docs/admin/observability/opentelemetry.mdx +++ b/docs/admin/observability/opentelemetry.mdx @@ -10,7 +10,7 @@ This approach offers a great deal of flexibility. ## Configuration -Sourcegraph's OpenTelemetry Collector is deployed with a [custom image, `sourcegraph/opentelemetry-collector`](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/tree/docker-images/opentelemetry-collector), and is configured with a configuration YAML file. +Sourcegraph's OpenTelemetry Collector is deployed with a [custom image, `sourcegraph/opentelemetry-collector`](TODO/UPDATE SOURCEGRAPH SEARCH LINK/-/tree/docker-images/opentelemetry-collector), and is configured with a configuration YAML file. By default, `sourcegraph/opentelemetry-collector` is configured to not do anything with the data it receives, but [exporters to various backends](#exporters) can be configured for each signal we currently support—**currently, only [traces data](#tracing) is supported**. Refer to the [documentation](https://opentelemetry.io/docs/collector/configuration/) for an in-depth explanation of the parts that compose a full collector pipeline. @@ -35,7 +35,7 @@ To learn more about Sourcegraph traces in general, refer to our [tracing documen > NOTE: In case you require an additional exporter from the [`opentelemetry-collector-contrib` repository](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter), please [open an issue](https://github.com/sourcegraph/sourcegraph/issues). Basic configuration for each tracing backend type is described below. Note that just adding a backend to the `exporters` block does not enable it—it must also be added to the `service` block. -Refer to the next snippet for a basic but complete example, which is the [default out-of-the-box configuration](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/docker-images/opentelemetry-collector/configs/logging.yaml): +Refer to the next snippet for a basic but complete example, which is the [default out-of-the-box configuration](TODO/UPDATE SOURCEGRAPH SEARCH LINK/-/blob/docker-images/opentelemetry-collector/configs/logging.yaml): ```yaml receivers: @@ -215,7 +215,7 @@ Most Sourcegraph deployment methods still ship with an opt-in Jaeger instance— - [Kubernetes with Helm](/admin/deploy/kubernetes/helm#enable-the-bundled-jaeger-deployment) - [Docker Compose](/admin/deploy/docker-compose/operations#enable-the-bundled-jaeger-deployment) -If you wish to do additional configuration or connect to your own Jaeger instance, the deployed Collector image is bundled with a [basic configuration with Jaeger exporting](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/docker-images/opentelemetry-collector/configs/jaeger.yaml). +If you wish to do additional configuration or connect to your own Jaeger instance, the deployed Collector image is bundled with a [basic configuration with Jaeger exporting](TODO/UPDATE SOURCEGRAPH SEARCH LINK/-/blob/docker-images/opentelemetry-collector/configs/jaeger.yaml). If this configuration serves your needs, you do not have to provide a separate config—the Collector startup command can be set to `/bin/otelcol-sourcegraph --config=/etc/otel-collector/configs/jaeger.yaml`. Note that this requires the environment variable `$JAEGER_HOST` to be set on the Collector instance (i.e. the container in Kubernetes or Docker Compose): ```yaml diff --git a/docs/admin/pings.mdx b/docs/admin/pings.mdx index 50d0391d5..f64d5d469 100644 --- a/docs/admin/pings.mdx +++ b/docs/admin/pings.mdx @@ -252,7 +252,7 @@ The Cody app connects to Sourcegraph.com to send a limited selection of the ping It may happen that Sourcegraph will stop sending critical telemetry to Sourcegraph.com, if this happens it may indicate a problem with Sourcegraphs frontend database, or a site settings misconfiguration. Below are some debugging steps. -Sourcegraph telemetry pings are handled by a goroutine running on Sourcegraphs frontend service called [`updatecheck`](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/cmd/frontend/internal/app/updatecheck/client.go?subtree=true), `updatecheck` is [started](https://sourcegraph.com/search?q=context:global+repo:%5Egithub%5C.com/sourcegraph/sourcegraph%24+file:%5Ecmd/frontend/internal/cli/serve_cmd%5C.go+updatecheck.Start%28db%29&patternType=literal) on container startup and periodically requests a variety of queries be run in the `pgsql` database. +Sourcegraph telemetry pings are handled by a goroutine running on Sourcegraphs frontend service called [`updatecheck`](TODO/UPDATE SOURCEGRAPH SEARCH LINK/-/blob/cmd/frontend/internal/app/updatecheck/client.go?subtree=true), `updatecheck` is [started](https://sourcegraph.com/search?q=context:global+repo:%5Egithub%5C.com/sourcegraph/sourcegraph%24+file:%5Ecmd/frontend/internal/cli/serve_cmd%5C.go+updatecheck.Start%28db%29&patternType=literal) on container startup and periodically requests a variety of queries be run in the `pgsql` database. ### Misconfigured update.channel @@ -260,7 +260,7 @@ The most common scenario in which Sourcegraph stops sending pings is a change to ``` "update.channel": "release", ``` -*This setting [must be set to "release"](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/internal/updatecheck/client.go?L803-806) in order for the telemetry goroutine to run.* +*This setting [must be set to "release"](TODO/UPDATE SOURCEGRAPH SEARCH LINK/-/blob/internal/updatecheck/client.go?L803-806) in order for the telemetry goroutine to run.* ### Check if the goroutine is running diff --git a/docs/admin/repo/perforce.mdx b/docs/admin/repo/perforce.mdx index f20e8811c..81088b804 100644 --- a/docs/admin/repo/perforce.mdx +++ b/docs/admin/repo/perforce.mdx @@ -52,7 +52,7 @@ To enable Perforce code host connections, a site admin must: > NOTE: While the `fusionClient` configuration is optional, without it the code host connection uses `git p4`, which has performance issues so we strongly recommend `p4-fusion`. - Details of all `p4-fusion` configuration fields can be seen [here](https://sourcegraph.com/github.com/sourcegraph/sourcegraph@2a716bd70c294acf1b3679b790834c4dea9ea956/-/blob/schema/perforce.schema.json?L84-147). + Details of all `p4-fusion` configuration fields can be seen [here](TODO/UPDATE SOURCEGRAPH SEARCH LINK@2a716bd70c294acf1b3679b790834c4dea9ea956/-/blob/schema/perforce.schema.json?L84-147). 1. Click **Add repositories**. @@ -73,11 +73,11 @@ Perforce labels are converted to Git tags, but only under the following conditio Perforce label names are also more flexible than git tag names, so incompatible characters are replaced with underscores. (i.e. `v1:2:3` will become `v1_2_3`) -This behaviour can be disabled by setting `noConvertLabels` to `true` in the [fusion client configuration](https://sourcegraph.com/github.com/sourcegraph/sourcegraph@44e848d4ba5a3d47bc6e8651638cfe2279d02102/-/blob/schema/perforce.schema.json?L66-131). +This behaviour can be disabled by setting `noConvertLabels` to `true` in the [fusion client configuration](TODO/UPDATE SOURCEGRAPH SEARCH LINK@44e848d4ba5a3d47bc6e8651638cfe2279d02102/-/blob/schema/perforce.schema.json?L66-131). ## Repository permissions -To enforce file-level permissions for Perforce depots using the [Perforce protects file](https://www.perforce.com/manuals/cmdref/Content/CmdRef/p4_protect.html), include [the `authorization` field](https://sourcegraph.com/github.com/sourcegraph/sourcegraph@2a716bd70c294acf1b3679b790834c4dea9ea956/-/blob/schema/perforce.schema.json?L67-78) in the configuration of the Perforce code host connection you created [above](#add-a-perforce-code-host): +To enforce file-level permissions for Perforce depots using the [Perforce protects file](https://www.perforce.com/manuals/cmdref/Content/CmdRef/p4_protect.html), include [the `authorization` field](TODO/UPDATE SOURCEGRAPH SEARCH LINK@2a716bd70c294acf1b3679b790834c4dea9ea956/-/blob/schema/perforce.schema.json?L67-78) in the configuration of the Perforce code host connection you created [above](#add-a-perforce-code-host): ```json { @@ -130,7 +130,7 @@ File-level permissions eliminate the need for [syncing subdirectories to match p To enable file-level permissions: -1. Add the following entry to your [site configuration file](https://sourcegraph.com/github.com/sourcegraph/sourcegraph@2a716bd/-/blob/schema/site.schema.json?L227-249): +1. Add the following entry to your [site configuration file](TODO/UPDATE SOURCEGRAPH SEARCH LINK@2a716bd/-/blob/schema/site.schema.json?L227-249): ```json { diff --git a/docs/admin/security_event_logs.mdx b/docs/admin/security_event_logs.mdx index 2e00dc762..963847e70 100644 --- a/docs/admin/security_event_logs.mdx +++ b/docs/admin/security_event_logs.mdx @@ -15,7 +15,7 @@ This guide goes into the details of Security Event Logging in Sourcegraph ## How to log a security event -- All the logging for security event is done through our [security_event_log.go](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/internal/database/security_event_logs.go) functions +- All the logging for security event is done through our [security_event_log.go](TODO/UPDATE SOURCEGRAPH SEARCH LINK/-/blob/internal/database/security_event_logs.go) functions - Previously, events were created within the function where the action was taking place and then pushed to the logging location like this: ```go event := &SecurityEvent{ @@ -30,10 +30,10 @@ This guide goes into the details of Security Event Logging in Sourcegraph db.SecurityEventLogs().LogEvent(ctx, event) -- With a recent change to streamline the process, to log an event, the [LogSecurityEvent](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/internal/database/security_event_logs.go?L253:34&popover=pinned) function can be invoked which takes care of marshaling the arguments and creating the SecurityEvent. +- With a recent change to streamline the process, to log an event, the [LogSecurityEvent](TODO/UPDATE SOURCEGRAPH SEARCH LINK/-/blob/internal/database/security_event_logs.go?L253:34&popover=pinned) function can be invoked which takes care of marshaling the arguments and creating the SecurityEvent. - This function takes following information to create a log event - Context contains information on the acting user - - SecurityEventName which is predefined [here](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/internal/database/security_event_logs.go?L22-101) + - SecurityEventName which is predefined [here](TODO/UPDATE SOURCEGRAPH SEARCH LINK/-/blob/internal/database/security_event_logs.go?L22-101) - URL if available - userID of the user that the action is applied towards - anonymousUserID for unauthenticated users @@ -97,7 +97,7 @@ This guide goes into the details of Security Event Logging in Sourcegraph ## FAQ ### What events are currently being logged as security events? -- [These](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/internal/database/security_event_logs.go?L22-101) are the events that are currently being logged. +- [These](TODO/UPDATE SOURCEGRAPH SEARCH LINK/-/blob/internal/database/security_event_logs.go?L22-101) are the events that are currently being logged. ### What if I don't want these events to be logged? diff --git a/docs/api/graphql/index.mdx b/docs/api/graphql/index.mdx index 97c688dca..268d43b4f 100644 --- a/docs/api/graphql/index.mdx +++ b/docs/api/graphql/index.mdx @@ -8,7 +8,7 @@ The Sourcegraph GraphQL API supports the following types of queries: - Rich git-level metadata, including commits, branches, blame information, and file tree data - Repository and user metadata -The API is under active development. Backwards compatibility will be maintained in most cases, and backwards-incompatible changes will be documented in the [changelog](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/CHANGELOG). +The API is under active development. Backwards compatibility will be maintained in most cases, and backwards-incompatible changes will be documented in the [changelog](TODO/UPDATE SOURCEGRAPH SEARCH LINK/-/blob/CHANGELOG). ## Quickstart diff --git a/docs/api/stream_api/index.mdx b/docs/api/stream_api/index.mdx index cba40d0b2..4bf427da6 100644 --- a/docs/api/stream_api/index.mdx +++ b/docs/api/stream_api/index.mdx @@ -75,7 +75,7 @@ Events can be of the following types: | alert | info, warning and error messages | | done | always the last event | -Refer to the [interface definitions of our typescript client](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/client/shared/src/search/stream.ts?L12) to learn about the schema of the event-types. +Refer to the [interface definitions of our typescript client](TODO/UPDATE SOURCEGRAPH SEARCH LINK/-/blob/client/shared/src/search/stream.ts?L12) to learn about the schema of the event-types. ## Example (curl) diff --git a/docs/cloud/index.mdx b/docs/cloud/index.mdx index ecd2f44de..edcd87838 100644 --- a/docs/cloud/index.mdx +++ b/docs/cloud/index.mdx @@ -269,7 +269,7 @@ The below are for example purposes only: In the case of things like Code Search, latency is directly correlated with user input / shape of the query, ex. on our public [sourcegraph.com](https://sourcegraph.com/search) instance: -- searching for “squirrel” in the [sourcegraph/sourcegraph](https://sourcegraph.com/github.com/sourcegraph/sourcegraph) repo takes 30ms and returns 163 results +- searching for “squirrel” in the [sourcegraph/sourcegraph](TODO/UPDATE SOURCEGRAPH SEARCH LINK) repo takes 30ms and returns 163 results - searching for “squirrel” in all OSS repos, but only requesting 1000 matches takes 540ms - searching for all matches of “squirrel” in all OSS repos returns 1.7million results in 30000ms - In the case of other features, latency of Sourcegraph directly depends on latency / uptime / rate-limits of customer managed systems, ex. for: