Skip to content

Commit 8c63c6e

Browse files
authored
Merge branch 'main' into hackathon-cody-visual-studio
2 parents 7737d01 + 1d554c5 commit 8c63c6e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+2647
-2413
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Sourcegraph Docs
22

3-
<!-- Working branch for October 30th 2024 Release -->
3+
<!-- Working branch for Nov 25th 2024 Release -->
44

55
Welcome to the Sourcegraph documentation! We're excited to have you contribute to our docs. We've recently rearchitectured our docs tech stack — powered by Next.js, TailwindCSS and deployed on Vercel. This guide will walk you through the process of contributing to our documentation using the new tech stack.
66

@@ -148,7 +148,7 @@ As you make changes to the documentation, the development server will automatica
148148

149149
### Previewing Vercel Deployments
150150

151-
When you open a PR Vercel deploys and provides you with a preview deployment link. To view your deployment, click the "Visit Preview" and then append `/docs` at the end of the URL. The original link gives you a `404`.
151+
When you open a PR Vercel deploys and provides you with a preview deployment link. To view your deployment, click the "Visit Preview" and then append `/docs` at the end of the URL. The original link gives you a `404`.
152152

153153
![CleanShot 2024-11-05 at 10 11 29@2x](https://github.com/user-attachments/assets/b0911e2e-95a7-4f56-b2ff-b659d13077d8)
154154

baseai/memory/docs/index.ts

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,9 @@ const memoryDocs = (): MemoryI => ({
55
name: 'docs',
66
description: 'Docs folder of sourcegraph docs repository as an auto-synced memory',
77
config: {
8-
deployedCommitHash: '7a147cfb18f19d5584ffb3805b678db47191960a',
9-
useGitRepo: true,
10-
dirToTrack: path.posix.join('.', 'docs'),
11-
extToTrack: [".md",".mdx"]
8+
useGitRepo: true,
9+
dirToTrack: path.posix.join('.', 'docs'),
10+
extToTrack: [".md", ".mdx"]
1211
}
1312
});
1413

docs.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const config = {
2-
DOCS_LATEST_VERSION: '5.9'
2+
DOCS_LATEST_VERSION: '5.10'
33
};
44

55
module.exports = config;

docs/admin/auth/builtin.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,8 @@ New users can submit a form and site admins will see the request in the navbar o
5757

5858
![List of pending access requests for admin to approve](https://storage.googleapis.com/sourcegraph-assets/docs/images/admin/auth/pending-access-requests.png)
5959

60+
## Disable account requests from users
61+
6062
The account request feature can be disabled by setting `"auth.accessRequest": { "enabled": false }`. When disabled, new user accounts can only be created by the site admin manually.
6163

6264
## Creating builtin authentication users

docs/admin/code_hosts/github.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,8 @@ When creating your fine-grained access token, select the following permissions d
220220

221221
To clone and search private repositories, we need [a GitHub access token](#github-api-access) with the required scopes and at least read access to the relevant private repositories.
222222

223+
<Callout type="note">Due to GitHub limitations, non-admins of an outside organization must use a [Classic personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#types-of-personal-access-tokens) to provision the appropriate permissions for Sourcegraph to index that organization's private repositories.</Callout>
224+
223225
For more details, see [GitHub API access](#github-api-access).
224226

225227
## Selecting repositories to sync

docs/admin/code_hosts/go.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Each entry in the `"urls"` array can contain basic auth if needed (e.g. `https:/
2828
## Rate limiting
2929

3030
By default, requests to the Go module proxies will be rate-limited
31-
based on a default internal limit. ([source](https://github.com/sourcegraph/sourcegraph/blob/main/schema/go-modules.schema.json))
31+
based on a default internal limit. ([source](https://github.com/sourcegraph/sourcegraph-public-snapshot/blob/main/schema/go-modules.schema.json))
3232

3333
```json
3434
"rateLimit": {

docs/admin/code_hosts/non-git.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,4 +114,4 @@ For more complex setups, configure your `src-expose` by providing a local config
114114
src-expose -snapshot-config config.yaml
115115
```
116116

117-
See [an example YAML file containing available configuration options](https://github.com/sourcegraph/sourcegraph/blob/main/dev/src-expose/examples/example.yaml).
117+
See [an example YAML file containing available configuration options](https://github.com/sourcegraph/sourcegraph-public-snapshot/blob/main/dev/src-expose/examples/example.yaml).

docs/admin/config/private-network.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,12 @@ A **private network** refers to a secure network environment segregated from the
44
When deploying self-hosted Sourcegraph instances in private networks with specific compliance and policy requirements, additional configuration may be required to ensure all networking features function correctly. The reasons for applying the following configuration options depend on the specific functionality of the Sourcegraph service and the unique network and infrastructure requirements of the organization.
55

66
The following is a list of Sourcegraph services and how and when each initiates outbound connections to external services:
7+
- **executor**: Sourcegraph [Executor](../executors) batch change or precise indexing jobs may need to connect to services hosted within an organization's private network
78
- **frontend**: The frontend service communicates externally when connecting to external [auth providers](../auth), sending [telemetry data](../pings), testing code host connections, and connecting to [externally hosted](../external_services) Sourcegraph services
89
- **gitserver**: Executes git commands against externally hosted [code hosts](../external_service)
9-
- **repo-updater**: Communicates with [code hosts](../external_service) APIs to coordinate repository synchronization
1010
- **migrator**: Connects to Postgres instances (which may be [externally hosted](../external_services/postgres)) to process database migrations
11-
- **executor**: Sourcegraph [Executor](../executors) batch change or precise indexing jobs may need to connect to services hosted within an organization's private network
11+
- **repo-updater**: Communicates with [code hosts](../external_service) APIs to coordinate repository synchronization
12+
- **worker**: Sourcegraph [Worker](../workers) run various background jobs that may require establishing connections to services hosted within an organization's private network
1213

1314
## HTTP proxy configuration
1415
All Sourcegraph services respect the conventional `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` environment variables for routing Sourcegraph client application HTTP traffic through a proxy server. The steps for configuring proxy environment variables will depend on your Sourcegraph deployment method.
@@ -17,14 +18,14 @@ All Sourcegraph services respect the conventional `HTTP_PROXY`, `HTTPS_PROXY`, a
1718
Add the proxy environment variables to your Sourcegraph Helm chart [override file](https://github.com/sourcegraph/deploy-sourcegraph-helm/blob/main/charts/sourcegraph/values.yaml):
1819

1920
```yaml
20-
frontend|gitserver|repo-updater:
21+
executor|frontend|gitserver|migrator|repo-updater|worker:
2122
env:
2223
- name: HTTP_PROXY
2324
value: http://proxy.example.com:8080
2425
- name: HTTPS_PROXY
2526
value: http://proxy.example.com:8080
2627
- name: NO_PROXY
27-
value: "*.cluster.local,blobstore,codeinsights-db,codeintel-db,sourcegraph-frontend-internal,sourcegraph-frontend,github-proxy,gitserver,grafana,indexed-search-indexer,indexed-search,jaeger-query,pgsql,precise-code-intel-worker,prometheus,redis-cache,redis-store,repo-updater,searcher,symbols,syntect-server,worker-executors,worker"
28+
value: "blobstore,codeinsights-db,codeintel-db,sourcegraph-frontend-internal,sourcegraph-frontend,github-proxy,gitserver,grafana,indexed-search-indexer,indexed-search,jaeger-query,pgsql,precise-code-intel-worker,prometheus,redis-cache,redis-store,repo-updater,searcher,symbols,syntect-server,worker-executors,worker,cloud-sql-proxy,localhost,127.0.0.1,.svc,.svc.cluster.local,kubernetes.default.svc"
2829
```
2930
3031
<Callout type="warning">Failure to configure `NO_PROXY` correctly can cause the proxy configuration to interfere with local networking between internal Sourcegraph services.</Callout>

docs/admin/deploy/kubernetes/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1105,7 +1105,7 @@ Some Persistent Volumes may be retained after the uninstall phase is complete. I
11051105
[AWS EBS CSI driver]: https://docs.aws.amazon.com/eks/latest/userguide/managing-ebs-csi.html
11061106
[NGINX Ingress Controller]: https://github.com/kubernetes/ingress-nginx
11071107
[Helm Changelog]: https://github.com/sourcegraph/deploy-sourcegraph-helm/blob/main/charts/sourcegraph/CHANGELOG
1108-
[Sourcegraph Changelog]: https://github.com/sourcegraph/sourcegraph/blob/main/CHANGELOG
1108+
[Sourcegraph Changelog]: https://github.com/sourcegraph/sourcegraph-public-snapshot/blob/main/CHANGELOG
11091109
[Sourcegraph Migrator]: https://github.com/sourcegraph/deploy-sourcegraph-helm/blob/main/charts/sourcegraph-migrator
11101110
[Helm Diff]: https://github.com/databus23/helm-diff
11111111
[Secrets]: https://kubernetes.io/docs/concepts/configuration/secret/

docs/admin/executors/deploy_executors_terraform.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -410,7 +410,7 @@ Next, you can test whether the number of executors rises and shrinks as load spi
410410
## Upgrading executors
411411

412412
Upgrading executors is relatively uninvolved. Simply follow the instructions below.
413-
Also, check the [changelog](https://github.com/sourcegraph/sourcegraph/blob/main/CHANGELOG) for any Executors related breaking changes or new features or flags that you might want to configure. See [Executors maintenance](/admin/executors/deploy_executors#Maintaining-and-upgrading-executors) for version compatability.
413+
Also, check the [changelog](https://github.com/sourcegraph/sourcegraph-public-snapshot/blob/main/CHANGELOG) for any Executors related breaking changes or new features or flags that you might want to configure. See [Executors maintenance](/admin/executors/deploy_executors#Maintaining-and-upgrading-executors) for version compatability.
414414

415415
### **Step 1:** Update the source version of the terraform modules
416416

0 commit comments

Comments
 (0)