Skip to content

Commit 9d82a30

Browse files
Updating sourcegraph.com search links first pass
1 parent 30c2072 commit 9d82a30

File tree

18 files changed

+32
-32
lines changed

18 files changed

+32
-32
lines changed

docs/admin/audit_log.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ Here's a word-by-word breakout to demonstrate how the captured entry aligns with
5252
### What is audited?
5353

5454
- [Security events](./security_event_logs)
55-
- [Gitserver access](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/cmd/gitserver/internal/accesslog/accesslog.go?L100-104)
56-
- [GraphQL requests](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/cmd/frontend/internal/httpapi/graphql.go?L226-244)
55+
- [Gitserver access](TODO/UPDATE SOURCEGRAPH SEARCH LINK/-/blob/cmd/gitserver/internal/accesslog/accesslog.go?L100-104)
56+
- [GraphQL requests](TODO/UPDATE SOURCEGRAPH SEARCH LINK/-/blob/cmd/frontend/internal/httpapi/graphql.go?L226-244)
5757

5858
This list is expected to grow in the future.
5959

@@ -125,7 +125,7 @@ If you are interested to use this feature or to stream to a different destinatio
125125

126126
## Developing
127127

128-
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.
128+
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.
129129

130130
Example call:
131131
```

docs/admin/config/advanced_config_file.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Where `extsvc.json` contains a JSON object that specifies _all_ of your code hos
9090
}
9191
```
9292

93-
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).
93+
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).
9494

9595
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.
9696

docs/admin/deploy/kubernetes/configure.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ Following these steps will allow Prometheus to successfully scrape metrics from
174174

175175
## Tracing
176176

177-
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).
177+
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).
178178

179179
By default, Sourcegraph supports exporting traces to multiple backends including Jaeger.
180180

docs/admin/enterprise_getting_started_guide/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ If you're deploying a new Enterprise instance, this page covers our most frequen
1818
- [GitHub integration](/integration/github)
1919
- [All code host integrations (not GitLab or GitHub)](/integration/#integrations)
2020
- [Full guide to site config options](/admin/config/site_config#auth-sessionExpiry)
21-
- [Changelog](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/CHANGELOG) to track releases and updates
21+
- [Changelog](TODO/UPDATE SOURCEGRAPH SEARCH LINK/-/blob/CHANGELOG) to track releases and updates
2222

2323
### Docker-compose
2424
- [Basic installation guide](/admin/deploy/docker-compose/)

docs/admin/executors/deploy_executors_binary.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ If you use the systemd service, simply run `systemctl start executor`, otherwise
155155
## Upgrading executors
156156

157157
Upgrading executors is relatively uninvolved. Simply follow the instructions below.
158-
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.
158+
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.
159159

160160
### **Step 1:** First, grab the executor binary for the new target Sourcegraph version.
161161

docs/admin/executors/deploy_executors_binary_offline.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ To install the Firecracker sandbox image, import the image using `docker`.
168168
$ docker pull <docker repository image for sourcegraph/ignite:v0.10.5>
169169
```
170170

171-
> 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.
171+
> 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.
172172
173173
If you are using a custom image instead of the Sourcegraph image, you will need to set the environment variable
174174
`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
181181
$ ignite kernel import --runtime docker <docker repository image for sourcegraph/ignite-kernel:5.10.135-amd64>
182182
```
183183

184-
> 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.
184+
> 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.
185185
186186
If you are using a custom image instead of the Sourcegraph image, you will need to set the environment variable
187187
`EXECUTOR_FIRECRACKER_KERNEL_IMAGE` to match the image name.

docs/admin/executors/deploy_executors_kubernetes.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Executors interact with the Kubernetes API to manage the lifecycle of individual
1313
| `batch` | `jobs` | `create`, `delete` | Executors create Job pods to run processes. Once Jobs are completed, they are cleaned up. |
1414
| | `pods`, `pods/log` | `get`, `list`, `watch` | Executors need to look up and steam logs from the Job Pods. |
1515

16-
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.
16+
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.
1717

1818
## Deployment
1919

@@ -94,5 +94,5 @@ The Executor Docker image is available on Docker Hub at [`sourcegraph/executor-k
9494
### Example Configuration YAML
9595

9696
See
97-
the [local development YAMLs](https://sourcegraph.com/github.com/sourcegraph/sourcegraph@main/-/blob/cmd/executor/kubernetes)
97+
the [local development YAMLs](TODO/UPDATE SOURCEGRAPH SEARCH LINK@main/-/blob/cmd/executor/kubernetes)
9898
for an example of how to configure the Executor in Kubernetes.

docs/admin/executors/firecracker.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,4 @@ Executor can be fined tuned with the following environment variables,
4141

4242
## Known caveats
4343

44-
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.
44+
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.

docs/admin/how-to/dirty_database_pre_3_37.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ _Note: for codeintel the schema version table is called `codeintel_schema_migrat
5151

5252
### 2. Run the sql queries to finish incomplete migrations
5353

54-
Sourcegraph's migration files take for form of `sql` files following the snake case naming schema `<version>_<description>.<up or down>.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_.
54+
Sourcegraph's migration files take for form of `sql` files following the snake case naming schema `<version>_<description>.<up or down>.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_.
5555

5656
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/\<YOUR-SOURCEGRAPH-VERSION\>/migrations](https://github.com/sourcegraph/sourcegraph/tree/main/migrations), making sure to go to \<YOUR-SOURCEGRAPH-VERSION\>
5757

docs/admin/how-to/monorepo-issues.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The following bullets provide a general guidline to which service may require mo
1818

1919
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.
2020

21-
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).
21+
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).
2222

2323
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).
2424

0 commit comments

Comments
 (0)