diff --git a/docs/admin/audit-log.mdx b/docs/admin/audit-log.mdx index 82d6574a6..db4b210d0 100644 --- a/docs/admin/audit-log.mdx +++ b/docs/admin/audit-log.mdx @@ -2,7 +2,7 @@ ## Philosophy -The audit log captures all critical events that affect entities of interest within Sourcegraph services. The audit log is built on top of our [logging standard](https://docs-legacy.sourcegraph.com/dev/how-to/add_logging), using structured logs as the base building block. Every captured entry is aligned with the following design mantra: +The audit log captures all critical events that affect entities of interest within Sourcegraph services. The audit log uses structured logs as the base building block. Every captured entry is aligned with the following design mantra: > Actor takes action on an entity within a context diff --git a/docs/admin/auth/login-form.mdx b/docs/admin/auth/login-form.mdx index 38576c8a9..21544d8b0 100644 --- a/docs/admin/auth/login-form.mdx +++ b/docs/admin/auth/login-form.mdx @@ -47,7 +47,6 @@ Example [site configuration](/admin/config/site-config): In this case, the GitLab auth provider will be shown above the GitHub auth provider on the login page. -![login form auth providers order screenshot](https://sourcegraphstatic.com/docs/images/administration/auth/login_form_order.png) Auth providers without `order` parameter will be put at the end of the auth providers list. diff --git a/docs/admin/auth/saml/one-login.mdx b/docs/admin/auth/saml/one-login.mdx index 90671da3e..1630bda13 100644 --- a/docs/admin/auth/saml/one-login.mdx +++ b/docs/admin/auth/saml/one-login.mdx @@ -8,7 +8,7 @@ 1. Under the "Configuration" tab, set the following properties (replacing `https://sourcegraph.example.com` with your Sourcegraph URL): - `Audience`: `https://sourcegraph.example.com/.auth/saml/metadata` - `Recipient`: `https://sourcegraph.example.com/.auth/saml/acs` - - `ACS (Consumer) URL Validator`: https://sourcegraph\\.example\\.com\\/\\.auth\\/saml\\/acs + - `ACS (Consumer) URL Validator`: `https://sourcegraph\\.example\\.com\\/\\.auth\\/saml\\/acs` - (This is regular expression that matches the URL `https://sourcegraph.example.com/.auth/saml/acs`) - `ACS (Consumer) URL`: `https://sourcegraph.example.com/.auth/saml/acs` 1. Under the "Parameters" tab, ensure the following parameters exist: diff --git a/docs/admin/code-hosts/bitbucket-cloud.mdx b/docs/admin/code-hosts/bitbucket-cloud.mdx index 59c2849a0..27256bee5 100644 --- a/docs/admin/code-hosts/bitbucket-cloud.mdx +++ b/docs/admin/code-hosts/bitbucket-cloud.mdx @@ -31,7 +31,7 @@ Bitbucket Cloud code host connections can be configured with either a username a ### Username and app password -1. Visit your [Bitbucket account settings page](https://bitbucket.org/account/settings). +1. Visit your Bitbucket account settings page. 2. Navigate to **App passwords**. 3. Select **Create app password**. 4. Give your app password a label. diff --git a/docs/admin/security-event-logs.mdx b/docs/admin/security-event-logs.mdx index 7db2cb09d..8ed761a53 100644 --- a/docs/admin/security-event-logs.mdx +++ b/docs/admin/security-event-logs.mdx @@ -4,8 +4,6 @@ This guide goes into the details of Security Event Logging in Sourcegraph > Note: You can find more information about our audit logs setup [here](./audit-log) > -> [Here](https://docs-legacy.sourcegraph.com/dev/how-to/add_logging) is a guide on how to add logging to Sourcegraph backend - ## What are Security Event Logs - The purpose of Security Event Logs is to allow security specialists to be able to trace the steps of a user or an admin across the application. diff --git a/docs/batch-changes/design.mdx b/docs/batch-changes/design.mdx index 21f8d46b8..b03dd5e82 100644 --- a/docs/batch-changes/design.mdx +++ b/docs/batch-changes/design.mdx @@ -29,6 +29,6 @@ These docs explain more about Kubernetes' design: - [Kubernetes Object Management](https://kubernetes.io/docs/concepts/overview/working-with-objects/object-management/) - [Kubernetes Controllers](https://kubernetes.io/docs/concepts/architecture/controller/) - [Desired versus current state](https://kubernetes.io/docs/concepts/architecture/controller/#desired-vs-current) -- [Kubernetes Architecture](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/architecture/architecture) +- Kubernetes Architecture - [Kubernetes General Configuration Tips](https://kubernetes.io/docs/concepts/configuration/overview/#general-configuration-tips) - [Kubernetes Design and Development Explained](https://thenewstack.io/kubernetes-design-and-development-explained/) diff --git a/docs/batch-changes/faq.mdx b/docs/batch-changes/faq.mdx index 934be401f..ab7fa7975 100644 --- a/docs/batch-changes/faq.mdx +++ b/docs/batch-changes/faq.mdx @@ -13,7 +13,7 @@ Batch Changes has specific requirements for running on the Sourcegraph server ve When a user is deleted, their Batch Changes become inaccessible in the UI, but the data is not permanently deleted. This allows the batch changes to be recovered if the user is restored. -You can change the ownership of a batch change before or after soft deletion by using the instructions[here](https://help.sourcegraph.com/hc/en-us/articles/28471221973133-Changing-Ownership-Of-A-Batch-Change-Before-User-Deletion). +You can change the ownership of a batch change before or after soft deletion by using the instructions. However, if the user deletion is permanent (using the "Delete forever" option), deleting both account and data, then the associated Batch Changes are also permanently deleted from the database. This frees storage space and removes dangling references. @@ -68,8 +68,8 @@ There's a rule of thumb: Batch Changes does not support a declarative syntax for issues or tickets. However, [steps](/batch-changes/batch-spec-yaml-reference#stepsrun) can run any container. Some users have built scripts to create tickets for each apply: -- [Jira tickets](https://github.com/sourcegraph/batch-change-examples/blob/main/ticketing-systems/jira-tickets/README) -- [GitHub issues](https://github.com/sourcegraph/batch-change-examples/blob/main/ticketing-systems/github-issues/README) +- [Jira tickets](https://github.com/sourcegraph/batch-change-examples/blob/main/ticketing-systems/jira-tickets/README.md) +- [GitHub issues](https://github.com/sourcegraph/batch-change-examples/blob/main/ticketing-systems/github-issues/README.md) ## Can I use GitHub/GitLab runners to automate my batch changes? diff --git a/docs/batch-changes/how-src-executes-a-batch-spec.mdx b/docs/batch-changes/how-src-executes-a-batch-spec.mdx index fda4a96b0..2f729059a 100644 --- a/docs/batch-changes/how-src-executes-a-batch-spec.mdx +++ b/docs/batch-changes/how-src-executes-a-batch-spec.mdx @@ -40,7 +40,7 @@ Let's learn about each step in more detail. ## Parse the batch spec -`src` reads in, parses, and validates the batch spec YAML specified with the `-f` flag. It validates the batch spec against its [schema](https://github.com/sourcegraph/src-cli/blob/main/schema/batch_spec.schema.json). It then performs some semantic checks to make sure that, for example, `changesetTemplate` is specified if `steps` are specified or that no feature is used that's not supported by the Sourcegraph instance. +`src` reads in, parses, and validates the batch spec YAML specified with the `-f` flag. It validates the batch spec against its schema. It then performs some semantic checks to make sure that, for example, `changesetTemplate` is specified if `steps` are specified or that no feature is used that's not supported by the Sourcegraph instance. ## Resolving namespace diff --git a/docs/cloud/index.mdx b/docs/cloud/index.mdx index 04864de2c..9bbadceda 100644 --- a/docs/cloud/index.mdx +++ b/docs/cloud/index.mdx @@ -184,7 +184,7 @@ Supported destinations: - A dedicated project manager who serves as the point of contact for the rollout process. - A mutual non-disclosure agreement and any additional approvals or special status required to allow Sourcegraph to manage infrastructure access tokens (listed below). -- Acceptance of our [Terms of Service for private instances](https://about.sourcegraph.com/terms-private) or an enterprise contract. +- Acceptance of our [Terms of Service for private instances](https://sourcegraph.com/terms/cloud) or an enterprise contract. ### Technical diff --git a/docs/code-insights/references/repository-scope.mdx b/docs/code-insights/references/repository-scope.mdx index 7db4d63af..3f71dcbb6 100644 --- a/docs/code-insights/references/repository-scope.mdx +++ b/docs/code-insights/references/repository-scope.mdx @@ -10,8 +10,6 @@ A Code Insight runs on a list of repositories as specified on insight creation. ## Using the repository search query box -![Code Insights repository search box with a query for repo:sourcegraph](https://storage.googleapis.com/sourcegraph-assets/docs/images/code-insights/create_insight_repo_selection.png) - The repository search query box allows you to search for repositories on your Sourcegraph instance using standard Sourcegraph `repo` filters, as well as boolean operators. Some example use cases might be: diff --git a/docs/code-navigation/how-to/adding-scip-to-workflows.mdx b/docs/code-navigation/how-to/adding-scip-to-workflows.mdx index 88dc34ba9..9def71698 100644 --- a/docs/code-navigation/how-to/adding-scip-to-workflows.mdx +++ b/docs/code-navigation/how-to/adding-scip-to-workflows.mdx @@ -168,4 +168,4 @@ With periodic jobs, you should still receive precise code navigation on non-inde Indexes can be uploaded to a self-hosted Sourcegraph instance or to [Sourcegraph.com](https://sourcegraph.com). Using the [Sourcegraph.com](https://sourcegraph.com) endpoint will surface code navigation for your public repositories directly on GitHub via the [Sourcegraph browser extension](/integration/browser-extension) and at `https://sourcegraph.com/github.com//`. -Using the [Sourcegraph.com](https://sourcegraph.com) endpoint is free and your index is treated as User-Generated Content (you own it, as covered in our [Sourcegraph.com terms of service](https://about.sourcegraph.com/terms-dotcom#3-proprietary-rights-and-licenses)). If you run into trouble, or a situation arises where you need all of your index expunged, please reach out to us at [support@sourcegraph.com](mailto:support@sourcegraph.com). +Using the [Sourcegraph.com](https://sourcegraph.com) endpoint is free and your index is treated as User-Generated Content (you own it, as covered in our [Sourcegraph.com terms of service](https://sourcegraph.com/terms#3-proprietary-rights-and-licenses)). If you run into trouble, or a situation arises where you need all of your index expunged, please reach out to us at [support@sourcegraph.com](mailto:support@sourcegraph.com). diff --git a/docs/code-navigation/precise-code-navigation.mdx b/docs/code-navigation/precise-code-navigation.mdx index 5400a4308..b3df8d95a 100644 --- a/docs/code-navigation/precise-code-navigation.mdx +++ b/docs/code-navigation/precise-code-navigation.mdx @@ -33,9 +33,9 @@ Precise code navigation relies on the open source [SCIP Code Intelligence Protoc - [Index a Go repository](/code-navigation/how-to/index-a-go-repository#manual-indexing) - [Index a TypeScript or JavaScript repository](/code-navigation/how-to/index-a-typescript-and-javascript-repository#manual-indexing) - - [Index a Java, Scala, or Kotlin repository](https://sourcegraph.github.io/scip-java/docs/getting-started.html) - - [Index a Python repository](https://sourcegraph.com/github.com/sourcegraph/scip-python) - - [Index a Ruby repository](https://sourcegraph.com/github.com/sourcegraph/scip-ruby) + - [Index a Java, Scala, or Kotlin repository](https://github.com/sourcegraph/scip-java) + - [Index a Python repository](https://github.com/sourcegraph/scip-python) + - [Index a Ruby repository](https://github.com/sourcegraph/scip-ruby) 2. [**Automate indexing via CI**](/code-navigation/how-to/adding-scip-to-workflows): Add indexing and uploading to your CI setup. 3. [**Auto-indexing**](/code-navigation/auto-indexing#enable-auto-indexing): Sourcegraph will automatically index your repositories and enable precise code navigation for them. @@ -46,13 +46,13 @@ Precise Code Navigation requires language-specific indexes to be generated and u | Language | Indexer | Status | | ---------------------- | --------------------------------------------------------------------------------- | ---------------------- | -| Go | [scip-go](https://sourcegraph.com/github.com/sourcegraph/scip-go) | 🟢 Generally available | -| TypeScript, JavaScript | [scip-typescript](https://sourcegraph.com/github.com/sourcegraph/scip-typescript) | 🟢 Generally available | -| C, C++, CUDA | [scip-clang](https://sourcegraph.com/github.com/sourcegraph/scip-clang) | 🟢 Generally available | -| Java, Kotlin, Scala | [scip-java](https://sourcegraph.com/github.com/sourcegraph/scip-java) | 🟢 Generally available | -| Rust | [rust-analyzer](https://sourcegraph.com/github.com/rust-lang/rust-analyzer) | 🟢 Generally available | -| Python | [scip-python](https://sourcegraph.com/github.com/sourcegraph/scip-python) | 🟢 Generally available | -| Ruby | [scip-ruby](https://sourcegraph.com/github.com/sourcegraph/scip-ruby) | 🟢 Generally available | +| Go | [scip-go](https://github.com/sourcegraph/scip-go) | 🟢 Generally available | +| TypeScript, JavaScript | [scip-typescript](https://github.com/sourcegraph/scip-typescript) | 🟢 Generally available | +| C, C++, CUDA | [scip-clang](https://github.com/sourcegraph/scip-clang) | 🟢 Generally available | +| Java, Kotlin, Scala | [scip-java](https://github.com/sourcegraph/scip-java) | 🟢 Generally available | +| Rust | [rust-analyzer](https://github.com/rust-lang/rust-analyzer) | 🟢 Generally available | +| Python | [scip-python](https://github.com/sourcegraph/scip-python) | 🟢 Generally available | +| Ruby | [scip-ruby](https://github.com/sourcegraph/scip-ruby) | 🟢 Generally available | | C#, Visual Basic | [scip-dotnet](https://github.com/sourcegraph/scip-dotnet) | 🟢 Generally available | The easiest way to configure precise code navigation is with [auto-indexing](/code-navigation/auto-indexing). This feature uses [Sourcegraph executors](/admin/executors/) to automatically create indexes for the code, keeping precise code navigation available and up-to-date. diff --git a/docs/code-navigation/private-maven-repository-configuration.mdx b/docs/code-navigation/private-maven-repository-configuration.mdx index 713ea992e..fd191bea2 100644 --- a/docs/code-navigation/private-maven-repository-configuration.mdx +++ b/docs/code-navigation/private-maven-repository-configuration.mdx @@ -1,6 +1,6 @@ # Configuring Maven to Use a Private Repository for Auto-Indexing -Configuring Maven to use a private repository, such as Nexus or Artifactory, with Sourcegraph is essential when dependencies are retrieved from private repositories that require authentication (as opposed to public repositories such as Maven Central). This guide covers steps to set up Maven for [scip-java](https://sourcegraph.github.io/scip-java/) indexing with a private repository, ensuring secure and consistent dependency resolution. +Configuring Maven to use a private repository, such as Nexus or Artifactory, with Sourcegraph is essential when dependencies are retrieved from private repositories that require authentication (as opposed to public repositories such as Maven Central). This guide covers steps to set up Maven for [scip-java](https://github.com/sourcegraph/scip-java) indexing with a private repository, ensuring secure and consistent dependency resolution. ## Testing the Configuration on a Single Repository @@ -40,7 +40,7 @@ After verifying the configuration on a single repository, you can automate the s ### Create or Update the Lua Script -Navigate to `site-admin -> Code Graph -> Inference`, and replace or add the following Lua script for [scip-java](https://sourcegraph.github.io/scip-java/) indexing with Maven’s `settings.xml` setup: +Navigate to `site-admin -> Code Graph -> Inference`, and replace or add the following Lua script for [scip-java](https://github.com/sourcegraph/scip-java) indexing with Maven’s `settings.xml` setup: ```lua local path = require("path") diff --git a/docs/code-navigation/writing-an-indexer.mdx b/docs/code-navigation/writing-an-indexer.mdx index 176b42bc2..377a832ee 100644 --- a/docs/code-navigation/writing-an-indexer.mdx +++ b/docs/code-navigation/writing-an-indexer.mdx @@ -98,7 +98,7 @@ Here is slightly cleaned up snippet from running `scip snapshot` on the index ge The carets and contextual information make it easy to visually check that: - Occurrences are being emitted for the right source ranges -- Occurrences have the expected symbol strings. The exact syntax for the symbol strings is described in the doc comment for [`Symbol`](https://sourcegraph.com/github.com/sourcegraph/scip@12459c75fc15117e68b4c15a58e8581b738b855f/-/blob/scip.proto?L87-115) in the SCIP Protobuf schema +- Occurrences have the expected symbol strings. The exact syntax for the symbol strings is described in the doc comment for [`Symbol`](https://github.com/sourcegraph/scip/blob/12459c75fc15117e68b4c15a58e8581b738b855f/scip.proto#L87-L115) in the SCIP Protobuf schema - Symbols correspond to the right package. For example, the `ScriptElementKind` is defined in the `typescript` package (the compiler) whereas `scriptElementKind` is defined in `@sourcegraph/scip-typescript` ## Progressively adding support for language features @@ -217,7 +217,7 @@ We may lack the language expertise or bandwidth to implement certain features on description="Learn how to create an index for other programming languages and uploading it to Sourcegraph." /> - - - ## Initial setup Log in to your Sourcegraph.com Enterprise instance through codehosts like GitHub and GitLab or via traditional Google sign-in. This takes you to Sourcegraph’s web interface. From here, there are two ways to access the Cody chat: diff --git a/docs/cody/clients/install-jetbrains.mdx b/docs/cody/clients/install-jetbrains.mdx index 1d9d12b45..5e0357432 100644 --- a/docs/cody/clients/install-jetbrains.mdx +++ b/docs/cody/clients/install-jetbrains.mdx @@ -18,7 +18,7 @@ The Cody plugin by Sourcegraph enhances your coding experience in your IDE by pr ## Prerequisites -- You have the latest version of JetBrains IDEs installed +- You have the latest version of JetBrains IDEs installed - A Sourcegraph Enterprise account with Cody enabled - Cody is compatible with the following JetBrains IDEs: - [Android Studio](https://developer.android.com/studio) diff --git a/docs/cody/clients/install-neovim.mdx b/docs/cody/clients/install-neovim.mdx index d10ff958d..7842d4691 100644 --- a/docs/cody/clients/install-neovim.mdx +++ b/docs/cody/clients/install-neovim.mdx @@ -25,8 +25,8 @@ This guide will walk you through installing and setting up the Cody within your ## Prerequisites -- `nvim 0.9 or nvim nightly` version of Neovim installed -- `Node.js >= 18.17.0 (LTS)` at runtime for [cody-agent.js](https://github.com/sourcegraph/cody) +- `nvim 0.9 or nvim nightly` version of Neovim installed +- `Node.js >= 18.17.0 (LTS)` at runtime for cody-agent.js - You have enabled an instance for [Cody from your Sourcegraph.com](/cody/clients/cody-with-sourcegraph) account ## Installation diff --git a/docs/cody/faq.mdx b/docs/cody/faq.mdx index 4c7b6cf5d..104451f05 100644 --- a/docs/cody/faq.mdx +++ b/docs/cody/faq.mdx @@ -125,7 +125,7 @@ Yes, BYOK (Bring Your Own Key) is fully supported in the Enterprise plan. Yes, Cody supports the following cloud development environments: - vscode.dev and GitHub Codespaces (install from the VS Code extension marketplace) -- Any editor supporting the [Open VSX Registry](https://open-vsx.org/extension/sourcegraph/cody-ai), including [Gitpod](https://www.gitpod.io/blog/boosting-developer-productivity-unleashing-the-power-of-sourcegraph-cody-in-gitpod), Coder, and `code-server` (install from the [Open VSX Registry](https://open-vsx.org/extension/sourcegraph/cody-ai)) +- Any editor supporting the [Open VSX Registry](https://open-vsx.org/extension/sourcegraph/cody-ai), including Gitpod, Coder, and `code-server` (install from the [Open VSX Registry](https://open-vsx.org/extension/sourcegraph/cody-ai)) ### Can I use my LLM of preference to chat with Cody on CLI? @@ -209,19 +209,19 @@ Starting June 25, you cannot sign up for new Cody Free or Cody Pro accounts, and If you're a Cody Free user: - You will have access to Cody Free until July 23, 2025. After this, you'll no longer be able to use Cody. -- Instead, you can sign up with Amp and receive **$10 in free credits** at [ampcode.com](http://ampcode.com/). +- Instead, you can sign up with Amp and receive **$10 in free credits** at [ampcode.com](https://ampcode.com/). If you're a Cody Pro user: - You will have access to Cody Pro until July 23, 2025. After this, you'll no longer be able to use Cody. - You **will not be charged for Cody Pro** between now and July 23, 2025. -- Cody Pro customers can sign up with Amp today at [ampcode.com](http://ampcode.com) and receive **$10 in free credits** **plus $30 additional free credits** as a thank you for using Cody Pro. +- Cody Pro customers can sign up with Amp today at [ampcode.com](https://ampcode.com/) and receive **$10 in free credits** **plus $30 additional free credits** as a thank you for using Cody Pro. If you're on Enterprise Starter: - Your workspaces will have Cody access until \*July 23, 2025, after which Cody's access will be removed. - Your Enterprise Starter subscription remains fully supported for Code Search, with upcoming improvements like Deep Search. -- Enterprise Starter customers can sign up with Amp today at [ampcode.com](http://ampcode.com) and receive **$10 in free credits** **plus $30 additional free credits** as a thank you for using Enterprise Starter. +- Enterprise Starter customers can sign up with Amp today at [ampcode.com](https://ampcode.com/) and receive **$10 in free credits** **plus $30 additional free credits** as a thank you for using Enterprise Starter. If you're an Enterprise user: @@ -246,4 +246,4 @@ Amp is your way forward if you're using Cody Free or Pro. Sign up today for $10 ### How can I learn more about Amp? -We've built [Amp's Manual](https://ampcode.com/manual) to help you get started with Amp. In addition, if you need more help for this Cody > Amp transition please reach out to us in [Discord](https://discord.com/servers/sourcegraph-969688426372825169). +We've built [Amp's Manual](https://ampcode.com/manual) to help you get started with Amp. In addition, if you need more help for this Cody > Amp transition please reach out to us in [Discord](https://discord.gg/s2qDtYGnAE). diff --git a/docs/cody/index.mdx b/docs/cody/index.mdx index 8014d36ab..014ac2037 100644 --- a/docs/cody/index.mdx +++ b/docs/cody/index.mdx @@ -103,7 +103,7 @@ Cody collects and uses data in the following ways: - **Prompts and responses**: When you use Cody, Sourcegraph collects your prompts and responses to provide the service. For individuals using Cody via Sourcegraph.com, Sourcegraph may use your prompts and responses to enhance the user experience, but Sourcegraph does not use any of your data to train models. - **Usage data and feedback**: Sourcegraph also collects usage data and feedback to improve the user experience. - + Read more about Cody Usage and Privacy policy here → diff --git a/docs/getting-started/github-vs-sourcegraph.mdx b/docs/getting-started/github-vs-sourcegraph.mdx index f8d45c2f9..c00a9d475 100644 --- a/docs/getting-started/github-vs-sourcegraph.mdx +++ b/docs/getting-started/github-vs-sourcegraph.mdx @@ -178,7 +178,7 @@ Both GitHub and Sourcegraph display the most relevant search results first using GitHub analyzes how many matches are in the file, the quality of the matches, the kind of file, whether the searches match symbols, and the number of repository stars as inputs for ranking results. -Sourcegraph uses a repository’s number of stars to [rank](https://docs-legacy.sourcegraph.com/dev/background-information/architecture/indexed-ranking) the most important repositories first There are several other heuristic signals that help to make sure that the most important documents are searched first, including: +Sourcegraph uses a repository’s number of stars to rank the most important repositories first. There are several other heuristic signals that help to make sure that the most important documents are searched first, including: - Up rank files with a lot of symbols - Up rank small files @@ -335,6 +335,6 @@ GitHub is closed source, while Sourcegraph’s code is publicly available. ## Availability -GitHub code search is currently available through a beta preview (you can sign up for their [waitlist](https://github.com/features/code-search-code-view/signup) to request access). The beta preview is not yet available for GitHub Enterprise. +GitHub code search is currently available through a beta preview. The beta preview is not yet available for GitHub Enterprise. Sourcegraph’s code intelligence platform is generally available, and you can sign up for a free trial for your team [here](https://about.sourcegraph.com/get-started?t=enterprise/). diff --git a/docs/integration/bitbucket-server.mdx b/docs/integration/bitbucket-server.mdx index 9c806e9e6..2971c49fb 100644 --- a/docs/integration/bitbucket-server.mdx +++ b/docs/integration/bitbucket-server.mdx @@ -103,7 +103,7 @@ Sourcegraph's Bitbucket Server / Bitbucket Data Center adds support for webhooks The motivation behind this added functionality is to more efficiently react to updates to Bitbucket Server / Bitbucket Data Center pull requests when using [batch changes](/batch-changes/) by requiring only a single webhook to receive events for hundreds or thousands of pull requests across projects and repositories. -The plugin adds a `/webhook` endpoint that accepts `GET`, `POST` and `DELETE` HTTP request to list, create and delete webhooks respectively. The full URL for this endpoint would be something like `https://your-bbs-instance.example.com/rest/sourcegraph-admin/1.0/webhook`. See the [webhooks README](https://github.com/sourcegraph/bitbucket-server-plugin/blob/master/src/main/java/com/sourcegraph/webhook/README) for detailed information on which payloads this endpoint accepts. +The plugin adds a `/webhook` endpoint that accepts `GET`, `POST` and `DELETE` HTTP request to list, create and delete webhooks respectively. The full URL for this endpoint would be something like `https://your-bbs-instance.example.com/rest/sourcegraph-admin/1.0/webhook`. See the [webhooks README](https://github.com/sourcegraph/bitbucket-server-plugin/blob/master/src/main/java/com/sourcegraph/webhook/README.md) for detailed information on which payloads this endpoint accepts. Once the plugin is installed it registers an asynchronous listener (see [`WebhookListener.java`](https://github.com/sourcegraph/bitbucket-server-plugin/blob/master/src/main/java/com/sourcegraph/webhook/WebhookListener.java)) that listens to `PullRequestEvent`s and `BuildStatusEvent`s. When an event is dispatched to the listener it checks whether a webhook has been registered for the scope and type of the event and if so, it enqueues the sending of a request to the webhook's endpoint in a thread pool. (See [`WebhookListener.handle`](https://github.com/sourcegraph/bitbucket-server-plugin/blob/master/src/main/java/com/sourcegraph/webhook/WebhookListener.java#L62-L76) and [`Dispatcher.java`](https://github.com/sourcegraph/bitbucket-server-plugin/blob/master/src/main/java/com/sourcegraph/webhook/Dispatcher.java).) diff --git a/docs/integration/gitlab.mdx b/docs/integration/gitlab.mdx index 89b60cc4a..634ebfb92 100644 --- a/docs/integration/gitlab.mdx +++ b/docs/integration/gitlab.mdx @@ -1,6 +1,6 @@ # GitLab integration with Sourcegraph -You can use Sourcegraph with [GitLab.com](https://gitlab.com) and GitLab CE/EE. Read a high-level overview of how Sourcegraph and GitLab work together in our [GitLab solution brief](https://about.sourcegraph.com/guides/sourcegraph-gitlab-solution-brief.pdf). +You can use Sourcegraph with [GitLab.com](https://gitlab.com) and GitLab CE/EE. | Feature | Supported? | | ------------------------------------------------------------------------- | ---------- | diff --git a/docs/integration/gitolite.mdx b/docs/integration/gitolite.mdx index 1ac9de9d3..a5a2fc986 100644 --- a/docs/integration/gitolite.mdx +++ b/docs/integration/gitolite.mdx @@ -1,6 +1,6 @@ # Gitolite integration with Sourcegraph -You can use Sourcegraph with [Gitolite](http://gitolite.com/). +You can use Sourcegraph with [Gitolite](https://gitolite.com/). | Feature | Supported? | | ------------------------------------------------------------------- | ---------- | diff --git a/docs/integration/gitpod.mdx b/docs/integration/gitpod.mdx index 3531f53c2..78c8bb8bf 100644 --- a/docs/integration/gitpod.mdx +++ b/docs/integration/gitpod.mdx @@ -18,7 +18,7 @@ Our IDE extensions work with the following IDEs supported by Gitpod. #### Gitpod JetBrains IDEs -1. Follow the instructions in [Gitpod's JetBrains IDE support docs](https://www.gitpod.io/docs/ides-and-editors/jetbrains-gateway#jetbrains-ide-support) to setup your workspace. +1. Follow Gitpod's JetBrains IDE support instructions to set up your workspace. 2. In your Gitpod JetBrains IDE workspace, select `Preferences` 3. Select `Plugins: on host` 4. Search and install `Sourcegraph` diff --git a/docs/pricing/faqs.mdx b/docs/pricing/faqs.mdx index 1f96fa280..09904522f 100644 --- a/docs/pricing/faqs.mdx +++ b/docs/pricing/faqs.mdx @@ -35,7 +35,7 @@ User counts and usage metrics are in [Sourcegraph Analytics](../analytics). ## Is my data secure when connected to Code Search? -Sourcegraph has security and reliability controls built for the most demanding enterprises. To learn more, see our [Security page](https://sourcegraph.netlify.app/security). +Sourcegraph has security and reliability controls built for the most demanding enterprises. To learn more, see our [Security page](https://sourcegraph.com/security). ## Enterprise Starter diff --git a/docs/self-hosted/deploy/docker-compose/digitalocean.mdx b/docs/self-hosted/deploy/docker-compose/digitalocean.mdx index 93e4360f4..3f77b3e34 100644 --- a/docs/self-hosted/deploy/docker-compose/digitalocean.mdx +++ b/docs/self-hosted/deploy/docker-compose/digitalocean.mdx @@ -150,7 +150,7 @@ docker ps --filter="name=sourcegraph-frontend-0" After the initial deployment has been completed, it is strongly recommended to set up the following: - Restrict the accessibility of ports other than `80` and `443` via [Cloud - Firewalls](https://www.digitalocean.com/docs/networking/firewalls/quickstart/). + Firewalls](https://docs.digitalocean.com/products/networking/firewalls/getting-started/quickstart/). - Set up [TLS/SSL](/self-hosted/http-https-configuration#sourcegraph-via-docker-compose-caddy-2) in the Docker Compose deployment > NOTE: If you have configured a DNS entry for the IP, please ensure to update `externalURL` in your Sourcegraph instance's Site Configuration to reflect that diff --git a/docs/self-hosted/deploy/kubernetes/configure.mdx b/docs/self-hosted/deploy/kubernetes/configure.mdx index 3733bb13a..b3b1358f0 100644 --- a/docs/self-hosted/deploy/kubernetes/configure.mdx +++ b/docs/self-hosted/deploy/kubernetes/configure.mdx @@ -226,7 +226,7 @@ components: Follow these steps to configure the otel-collector to export traces to an external OTEL-compatible backend: 1. Create a subdirectory called 'patches' within the directory of your overlay -2. Copy and paste the [base/otel-collector/otel-collector.ConfigMap.yaml file](https://sourcegraph.com/github.com/sourcegraph/deploy-sourcegraph-k8s@master/-/tree/base/otel-collector/otel-collector.ConfigMap.yaml) to the new [patches subdirectory](/self-hosted/deploy/kubernetes/kustomize/#patches-directory) +2. Copy and paste the [base/otel-collector/otel-collector.ConfigMap.yaml file](https://github.com/sourcegraph/deploy-sourcegraph-k8s/blob/main/base/monitoring/otel-collector/otel-collector.ConfigMap.yaml) to the new patches subdirectory 3. In the copied file, make the necessary changes to the `exporters` and `service` blocks to connect to your backend based on the documentation linked above 4. Include the following content in your overlay: @@ -265,7 +265,7 @@ This will set namespace to the `namespace` value (`ns-sourcegraph` in this examp ### Create a namespace -To create a new namespace, include the [utils/namespace](https://sourcegraph.com/github.com/sourcegraph/deploy-sourcegraph-k8s/-/tree/components/resources/namespace) component in your overlay. +To create a new namespace, include the [utils/namespace](https://github.com/sourcegraph/deploy-sourcegraph-k8s/tree/main/components/resources/namespace) component in your overlay. ```yaml # instances/$INSTANCE_NAME/kustomization.yaml @@ -472,10 +472,10 @@ It also updates the storage class name for all resources to `sourcegraph`. **Step 1**: Follow the [official instructions](https://docs.aws.amazon.com/eks/latest/userguide/ebs-csi.html) to deploy the [Amazon Elastic Block Store (Amazon EBS) Container Storage Interface (CSI) driver](https://docs.aws.amazon.com/eks/latest/userguide/ebs-csi.html). -**Step 2**: Include one of the AWS storage class components in your overlay: [storage-class/aws/eks](https://sourcegraph.com/github.com/sourcegraph/deploy-sourcegraph-k8s/-/tree/components/storage-class/aws/eks) or [storage-class/aws/ebs](https://sourcegraph.com/github.com/sourcegraph/deploy-sourcegraph-k8s/-/tree/components/storage-class/aws/ebs) +**Step 2**: Include one of the AWS storage class components in your overlay: [storage-class/aws/ebs-csi](https://github.com/sourcegraph/deploy-sourcegraph-k8s/tree/main/components/storage-class/aws/ebs-csi) or [storage-class/aws/aws-ebs](https://github.com/sourcegraph/deploy-sourcegraph-k8s/tree/main/components/storage-class/aws/aws-ebs) -- The [storage-class/aws/ebs-csi](https://sourcegraph.com/github.com/sourcegraph/deploy-sourcegraph-k8s/-/tree/components/storage-class/aws/eks) component is configured with the `ebs.csi.aws.com` storage class provisioner for clusters with self-managed Amazon EBS Container Storage Interface driver installed -- The [storage-class/aws/aws-ebs](https://sourcegraph.com/github.com/sourcegraph/deploy-sourcegraph-k8s/-/tree/components/storage-class/aws/ebs) component is configured with the `kubernetes.io/aws-ebs` storage class provisioner for clusters with the [AWS EBS CSI driver installed as Amazon EKS add-on](https://docs.aws.amazon.com/eks/latest/userguide/managing-ebs-csi.html) +- The [storage-class/aws/ebs-csi](https://github.com/sourcegraph/deploy-sourcegraph-k8s/tree/main/components/storage-class/aws/ebs-csi) component is configured with the `ebs.csi.aws.com` storage class provisioner for clusters with self-managed Amazon EBS Container Storage Interface driver installed +- The [storage-class/aws/aws-ebs](https://github.com/sourcegraph/deploy-sourcegraph-k8s/tree/main/components/storage-class/aws/aws-ebs) component is configured with the `kubernetes.io/aws-ebs` storage class provisioner for clusters with the [AWS EBS CSI driver installed as Amazon EKS add-on](https://docs.aws.amazon.com/eks/latest/userguide/managing-ebs-csi.html) ```yaml # instances/$INSTANCE_NAME/kustomization.yaml @@ -923,11 +923,11 @@ Learn more about [Google Cloud Platform Firewall rules](https://cloud.google.com Sourcegraph should now be accessible at `$EXTERNAL_ADDR:30080`, where `$EXTERNAL_ADDR` is the address of _any_ node in the cluster. -Learn more about [AWS Security Group rules](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html). +Learn more about [AWS Security Group rules](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-security-groups.html). ### Rancher Kubernetes Engine -If your [Rancher Kubernetes Engine (RKE)](https://rancher.com/docs/rke/latest/en/) cluster is configured to use [NodePort](https://docs.ranchermanager.rancher.io/v2.0-v2.4/how-to-guides/new-user-guides/migrate-from-v1.6-v2.x/expose-services#nodeport), include the [network/nodeport/custom component](https://sourcegraph.com/github.com/sourcegraph/deploy-sourcegraph-k8s/-/tree/components/network/nodeport/custom) to change the port type for `sourcegraph-frontend` service from `ClusterIP` to `NodePort` to use `nodePort: 30080`: +If your [Rancher Kubernetes Engine (RKE)](https://rancher.com/docs/rke/latest/en/) cluster is configured to use NodePort, include the [network/nodeport/custom component](https://github.com/sourcegraph/deploy-sourcegraph-k8s/tree/main/components/network/nodeport/custom) to change the port type for `sourcegraph-frontend` service from `ClusterIP` to `NodePort` to use `nodePort: 30080`: ```yaml # instances/$INSTANCE_NAME/kustomization.yaml @@ -1065,7 +1065,7 @@ Similar changes will be required for other pods and services, depending on the s For optimal performance and resilience, it is recommended to use an external database when deploying Sourcegraph. For more information on database requirements, please refer to the [Postgres guide](/self-hosted/postgres). -To connect Sourcegraph to an existing PostgreSQL instance, add the relevant environment variables ([such as PGHOST, PGPORT, PGUSER, etc.](http://www.postgresql.org/docs/current/static/libpq-envars.html)) to the frontend ConfigMap by adding the new environment variables to the end of the _FRONTEND ENV VARS_ section at the bottom of your [kustomization file](/self-hosted/deploy/kubernetes/kustomize/#kustomizationyaml). For example: +To connect Sourcegraph to an existing PostgreSQL instance, add the relevant environment variables ([such as PGHOST, PGPORT, PGUSER, etc.](https://www.postgresql.org/docs/current/libpq-envars.html)) to the frontend ConfigMap by adding the new environment variables to the end of the _FRONTEND ENV VARS_ section at the bottom of your [kustomization file](/self-hosted/deploy/kubernetes/kustomize/#kustomizationyaml). For example: ```yaml # instances/$INSTANCE_NAME/kustomization.yaml @@ -1152,7 +1152,7 @@ components: - ../../components/enable/ssh/root ``` -> NOTE: If you are running Sourcegraph with privileges using our [privileged component](https://sourcegraph.com/github.com/sourcegraph/deploy-sourcegraph-k8s/-/tree/components/privileged), you are most likely running Sourcegraph with `root` access and should use the [ssh/root component](https://sourcegraph.com/github.com/sourcegraph/deploy-sourcegraph-k8s/-/tree/components/enable/ssh/root) to enable SSH cloning. +> NOTE: If you are running Sourcegraph with privileges using our [privileged component](https://github.com/sourcegraph/deploy-sourcegraph-k8s/tree/main/components/privileged), you are most likely running Sourcegraph with `root` access and should use the [ssh/root component](https://github.com/sourcegraph/deploy-sourcegraph-k8s/tree/main/components/enable/ssh/root) to enable SSH cloning. **Step 4:** Update code host configuration @@ -1185,8 +1185,7 @@ Once you have a license key, add it to your [site configuration](/admin/config/s ## Filtering cAdvisor metrics -cAdvisor can pick up metrics for services unrelated to the Sourcegraph deployment running on the same nodes -([Learn more](https://docs-legacy.sourcegraph.com/dev/background-information/observability/cadvisor#known-issues)) **when running with privileges**. To work around this: +cAdvisor can pick up metrics for services unrelated to the Sourcegraph deployment running on the same nodes **when running with privileges**. To work around this: 1\. Create a subdirectory called 'patches' within the directory of your overlay @@ -1313,7 +1312,7 @@ components: ## Outbound Traffic -When working with an [Internet Gateway](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Internet_Gateway.html) or VPC it may be necessary to expose ports for outbound network traffic. Sourcegraph must open port 443 for outbound traffic to code hosts, and to enable [telemetry](/admin/pings) with Sourcegraph.com. Port 22 must also be opened to enable git SSH cloning by Sourcegraph. In addition, please make sure to apply other required changes to secure your cluster in a manner that meets your organization's security requirements. +When working with an [Internet Gateway](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html) or VPC it may be necessary to expose ports for outbound network traffic. Sourcegraph must open port 443 for outbound traffic to code hosts, and to enable [telemetry](/admin/pings) with Sourcegraph.com. Port 22 must also be opened to enable git SSH cloning by Sourcegraph. In addition, please make sure to apply other required changes to secure your cluster in a manner that meets your organization's security requirements. --- diff --git a/docs/self-hosted/deploy/kubernetes/eks.mdx b/docs/self-hosted/deploy/kubernetes/eks.mdx index 07e07305b..afaef7d85 100644 --- a/docs/self-hosted/deploy/kubernetes/eks.mdx +++ b/docs/self-hosted/deploy/kubernetes/eks.mdx @@ -17,7 +17,7 @@ Before moving forward, you will need: - `awscli`: The command line tool provided by Amazon to work with AWS resources. [Installation guide](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html) and [Configuration guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html#cli-configure-quickstart-config). - `kubectl`: The command line tool used for working with Kubernetes clusters and resources. [Installation guide](https://kubernetes.io/docs/tasks/tools/). -- `eksctl`: A tool provided by Weaveworks for configuring and creating EKS clusters in Amazon. [Installation guide](https://eksctl.io/introduction/#installation). +- `eksctl`: A tool provided by Weaveworks for configuring and creating EKS clusters in Amazon. [Installation guide](https://eksctl.io/getting-started/). - **IAM permissions**: The user that will be performing the installation must have permissions to work with Amazon EKS IAM roles and service linked roles, AWS CloudFormation, and a VPC and related resources. Through this guide, we will be using a number of parameters starting with `$` that you will need to replace with your desired values: diff --git a/docs/self-hosted/deploy/kubernetes/kustomize.mdx b/docs/self-hosted/deploy/kubernetes/kustomize.mdx index cfa8f9457..65abcd570 100644 --- a/docs/self-hosted/deploy/kubernetes/kustomize.mdx +++ b/docs/self-hosted/deploy/kubernetes/kustomize.mdx @@ -35,7 +35,7 @@ Below is an overview of installing Sourcegraph on Kubernetes using Kustomize. [migrated](/self-hosted/deploy/kubernetes/kustomize/migrate) to [`deploy-sourcegraph-k8s`](https://github.com/sourcegraph/deploy-sourcegraph-k8s), please refer to the [legacy deployment docs for - Kubernetes](https://docs.sourcegraph.com/@v4.4.2/admin/deploy/kubernetes). + Kubernetes](/self-hosted/deploy/kubernetes). ### **Step 1**: Set up a release branch diff --git a/docs/self-hosted/deploy/kubernetes/kustomize/index.mdx b/docs/self-hosted/deploy/kubernetes/kustomize/index.mdx index 455435ace..11fe86f8f 100644 --- a/docs/self-hosted/deploy/kubernetes/kustomize/index.mdx +++ b/docs/self-hosted/deploy/kubernetes/kustomize/index.mdx @@ -260,6 +260,6 @@ The previous Kustomize structure we built for our Kubernetes deployments depends With the new Kustomize we have introduced in this documentation, these issues can now be avoided. The previous version of the Sourcegraph Kustomize Overlays are still available, but they should not be used for any new Kubernetes deployment. -See the [old deployment docs for deploying Sourcegraph on Kubernetes](https://docs.sourcegraph.com/@v4.4.2/admin/deploy/kubernetes). +See the [deployment docs for Sourcegraph on Kubernetes](/self-hosted/deploy/kubernetes). > NOTE: The latest version of our Kustomize overlays does not work on instances that are older than v4.5.0. diff --git a/docs/self-hosted/deploy/kubernetes/scale.mdx b/docs/self-hosted/deploy/kubernetes/scale.mdx index db343dbea..b322b1f45 100644 --- a/docs/self-hosted/deploy/kubernetes/scale.mdx +++ b/docs/self-hosted/deploy/kubernetes/scale.mdx @@ -25,7 +25,7 @@ Notes: - If your change requires restarting `gitserver` pods and they are rescheduled to other nodes, they may go offline briefly (showing a `Multi-Attach` error). This is due to volume detach/reattach. [Contact us](https://about.sourcegraph.com/contact/) for mitigation steps depending on your cloud provider. - See the docs to understand each service's role: - - [Sourcegraph Architecture Overview](https://docs-legacy.sourcegraph.com/dev/background-information/architecture) + - [Sourcegraph Architecture Overview](/admin/architecture) - [Scaling Overview per Service](/self-hosted/deploy/scale) --- diff --git a/docs/self-hosted/deploy/machine-images/index.mdx b/docs/self-hosted/deploy/machine-images/index.mdx index 6b6f4f730..1edb698eb 100644 --- a/docs/self-hosted/deploy/machine-images/index.mdx +++ b/docs/self-hosted/deploy/machine-images/index.mdx @@ -12,9 +12,9 @@ All Sourcegraph machine image instances are deployed via a single K3s server clu This deployment method is recommended for customers who do not wish to spend too much time on setup and maintenance, but still require full control over their instances. The Sourcegraph image instances also provide high-availability and flexibility in resource usage, with the capability for scaling and making additional customizations easy whenever your needs have changed, by simply adjusting the worker/agent nodes, while still being on a single node environment. -Everything we use to build and publish the images can be found in our [public deployment repository](https://sourcegraph.com/github.com/sourcegraph/deploy). You are also welcome to check out and follow our progress and updates there. +Everything we use to build and publish the images can be found in our [public deployment repository](https://github.com/sourcegraph/deploy). You are also welcome to check out and follow our progress and updates there. -Our deployment and release process is also documented in the [deployment docs](https://sourcegraph.com/github.com/sourcegraph/deploy@v4.0.1/-/blob/doc/development.md). +Our deployment and release process is also documented in the [deployment docs](https://github.com/sourcegraph/deploy/blob/v4.0.1/doc/development.md). All Sourcegraph machine images are free to download, and we encourage you to spin up a Sourcegraph AMI instance to experiment with. @@ -28,7 +28,7 @@ All Sourcegraph machine images are free to download, and we encourage you to spi - Self-hosted - Single node - Preconfigured according to your business size -- Deployed with our [Helm Charts](https://sourcegraph.com/github.com/sourcegraph/deploy-sourcegraph-helm) to a K3s, a highly available lightweight Kubernetes distribution cluster, using the containerd run time with built-in ingress, load balancer provider, and local storage provisioner ([Click here for the full K3s dependency list](https://sourcegraph.com/github.com/k3s-io/k3s#what-is-this)) +- Deployed with our [Helm Charts](https://github.com/sourcegraph/deploy-sourcegraph-helm) to a K3s, a highly available lightweight Kubernetes distribution cluster, using the containerd run time with built-in ingress, load balancer provider, and local storage provisioner ([Click here for the full K3s dependency list](https://github.com/k3s-io/k3s#what-is-this)) - Easy to maintain and configure - Supports all Sourcegraph features - Ability to perform upgrades easily with or without SSH access @@ -47,7 +47,7 @@ All Sourcegraph machine images are free to download, and we encourage you to spi ### Amazon Machine Images (AMIs) -All AMI instances are currently pinned with a Sourcegraph version that the instance is launched with to ensure restarting the instance will not cause upgrades accidentally. The version number is saved into a text file on both the root (file path: `/home/ec2-user/.sourcegraph-version`) and data volumes (file path: `/mnt/data/.sourcegraph-version`) where it will be read by the [reboot script](https://sourcegraph.com/github.com/sourcegraph/deploy@v5.2.5/-/blob/install/reboot.sh) on each reboot. Upgrades will only happen on reboot if the version numbers from both volumes are different. +All AMI instances are currently pinned with a Sourcegraph version that the instance is launched with to ensure restarting the instance will not cause upgrades accidentally. The version number is saved into a text file on both the root (file path: `/home/ec2-user/.sourcegraph-version`) and data volumes (file path: `/mnt/data/.sourcegraph-version`) where it will be read by the [reboot script](https://github.com/sourcegraph/deploy/blob/v5.2.5/install/reboot.sh) on each reboot. Upgrades will only happen on reboot if the version numbers from both volumes are different. Detailed deployment and upgrade instructions can be found in our [AWS AMIs docs](./machine-images/aws-ami). @@ -55,14 +55,14 @@ Unique AMI IDs can be found in our [release page](https://github.com/sourcegraph #### Creation process -Our AWS AMIs are all based on the HVM method, which provides us with the ability to create a Sourcegraph instance directly on the virtual machine using the verified `Amazon Linux 2 Kernel 5.10 x86_64 HVM` as the base image. The following steps are performed during the AMI creation process through our [installation script](https://sourcegraph.com/github.com/sourcegraph/deploy@v4.0.1/-/blob/install/install.sh): +Our AWS AMIs are all based on the HVM method, which provides us with the ability to create a Sourcegraph instance directly on the virtual machine using the verified `Amazon Linux 2 Kernel 5.10 x86_64 HVM` as the base image. The following steps are performed during the AMI creation process through our [installation script](https://github.com/sourcegraph/deploy/blob/v4.0.1/install/install.sh): 1. De-escalate to `ec2-user` to make sure tasks are performed by non-root user 2. Install Git 3. Clone the [deployment repository](https://github.com/sourcegraph/deploy) 4. Data volumes are formatted and labeled for the AMI instance to mount later -5. [Add configurations to the kernel](https://sourcegraph.com/github.com/sourcegraph/deploy@v4.0.1/-/blob/install/install.sh?L64-73) that would otherwise limit Sourcegraph search performance -6. [Adjust the local firewall settings](https://sourcegraph.com/github.com/sourcegraph/deploy@v4.0.1/-/blob/install/install.sh?L78-84) to ensure K3s cluster networking/DNS can pass through +5. [Add configurations to the kernel](https://github.com/sourcegraph/deploy/blob/v4.0.1/install/install.sh#L64-L73) that would otherwise limit Sourcegraph search performance +6. [Adjust the local firewall settings](https://github.com/sourcegraph/deploy/blob/v4.0.1/install/install.sh#L78-L84) to ensure K3s cluster networking/DNS can pass through 7. Link the ephemeral kubelet/pod storage to our data disk 8. Link the persistent volume pod storage to our data disk 9. Link the K3s's embedded database to our data disk @@ -72,7 +72,7 @@ Our AWS AMIs are all based on the HVM method, which provides us with the ability 13. Download Sourcegraph Helm Charts on root volume 14. Deploy Sourcegraph using the local Helm Charts 15. Save the version number to both root and data volumes -16. Add a cronjob to run the [reboot script](https://sourcegraph.com/github.com/sourcegraph/deploy@v4.0.1/-/blob/install/reboot.sh) on each reboot +16. Add a cronjob to run the [reboot script](https://github.com/sourcegraph/deploy/blob/v4.0.1/install/reboot.sh) on each reboot 17. K3s is stopped and disabled 18. The instance will then be stopped to create an AMI using the attached volumes @@ -107,6 +107,6 @@ Please refer to the official [CIS hardening guide](https://docs.k3s.io/security/ ## Additional resources -- [sourcegraph/deploy](https://sourcegraph.com/github.com/sourcegraph/deploy) -- [Scripts used for building the AWS AMIs](https://sourcegraph.com/github.com/sourcegraph/deploy@v4.0.1/-/blob/install/install.sh) -- [Sourcegraph machine images deployment and release process](https://sourcegraph.com/github.com/sourcegraph/deploy@v4.0.1/-/blob/doc/development.md) +- [sourcegraph/deploy](https://github.com/sourcegraph/deploy) +- [Scripts used for building the AWS AMIs](https://github.com/sourcegraph/deploy/blob/v4.0.1/install/install.sh) +- [Sourcegraph machine images deployment and release process](https://github.com/sourcegraph/deploy/blob/v4.0.1/doc/development.md) diff --git a/docs/self-hosted/deploy/scale.mdx b/docs/self-hosted/deploy/scale.mdx index 4ba657a1f..a572cc294 100644 --- a/docs/self-hosted/deploy/scale.mdx +++ b/docs/self-hosted/deploy/scale.mdx @@ -78,7 +78,7 @@ It exports container monitoring metrics scraped by Prometheus and visualized in | :---------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Overview` | Scaling is not necessary as it is designed to be a small footprint service | | `Factors` | Its primary traffic are the requests coming from Prometheus | -| `Guideline` | Read [the list of known issues](https://docs-legacy.sourcegraph.com/dev/background-information/observability/cadvisor#known-issues) that can cause performance issues for cAdvisor | +| `Guideline` | Review known cAdvisor issues that can cause performance problems | --- diff --git a/docs/self-hosted/external-services/postgres.mdx b/docs/self-hosted/external-services/postgres.mdx index ecd3c1ae6..4241472c1 100644 --- a/docs/self-hosted/external-services/postgres.mdx +++ b/docs/self-hosted/external-services/postgres.mdx @@ -108,7 +108,7 @@ Please refer to our [Postgres](/self-hosted/postgres) documentation to learn abo instead of `PGSSLMODE=require`. Note that this is potentially insecure. -Most standard PostgreSQL environment variables may be specified (`PGPORT`, etc). See http://www.postgresql.org/docs/current/static/libpq-envars.html for a full list. +Most standard PostgreSQL environment variables may be specified (`PGPORT`, etc). See https://www.postgresql.org/docs/current/libpq-envars.html for a full list. On Mac/Windows, if trying to connect to a PostgreSQL server on the same host @@ -273,7 +273,7 @@ spec: ## Postgres Permissions and Database Migrations -There is a tight coupling between the respective database service accounts for the Frontend DB, CodeIntel DB and Sourcegraph [database migrations](https://docs-legacy.sourcegraph.com/dev/background-information/sql/migrations). +There is a tight coupling between the respective database service accounts for the Frontend DB, CodeIntel DB and Sourcegraph database migrations. By default, the migrations that Sourcegraph runs expect `SUPERUSER` permissions. Sourcegraph migrations contain SQL that enable extensions and modify roles. diff --git a/docs/self-hosted/observability/alerts.mdx b/docs/self-hosted/observability/alerts.mdx index 8e7520ee2..02df5e978 100644 --- a/docs/self-hosted/observability/alerts.mdx +++ b/docs/self-hosted/observability/alerts.mdx @@ -400,7 +400,7 @@ Generated query for warning alert: `max((sum by (status) (increase(src_graphql_s **Next steps** -- This indicates a bug in Sourcegraph, please [open an issue](https://github.com/sourcegraph/sourcegraph/issues/new/choose). +- This indicates a bug in Sourcegraph; please contact support. - Learn more about the related dashboard panel in the [dashboards reference](dashboards#frontend-search_codeintel_alert_user_suggestions). - **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: @@ -5801,7 +5801,7 @@ Generated query for critical alert: `min((sum by (app) (up{app=~".*indexed-searc - Check the Container monitoring (not available on server) panels and try increasing resources for Prometheus if necessary. - If the rule group taking a long time to evaluate belongs to `/sg_prometheus_addons`, try reducing the complexity of any custom Prometheus rules provided. -- If the rule group taking a long time to evaluate belongs to `/sg_config_prometheus`, please [open an issue](https://github.com/sourcegraph/sourcegraph/issues/new?assignees=&labels=&template=bug_report.md&title=). +- If the rule group taking a long time to evaluate belongs to `/sg_config_prometheus`, please contact support. - More help interpreting this metric is available in the [dashboards reference](dashboards#prometheus-prometheus_rule_eval_duration). - **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: @@ -5834,7 +5834,7 @@ Generated query for warning alert: `max((sum by (rule_group) (avg_over_time(prom - Check Prometheus logs for messages related to rule group evaluation (generally with log field `component="rule manager"`). - If the rule group failing to evaluate belongs to `/sg_prometheus_addons`, ensure any custom Prometheus configuration provided is valid. -- If the rule group taking a long time to evaluate belongs to `/sg_config_prometheus`, please [open an issue](https://github.com/sourcegraph/sourcegraph/issues/new?assignees=&labels=&template=bug_report.md&title=). +- If the rule group taking a long time to evaluate belongs to `/sg_config_prometheus`, please contact support. - More help interpreting this metric is available in the [dashboards reference](dashboards#prometheus-prometheus_rule_eval_failures). - **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: @@ -7975,4 +7975,4 @@ Generated query for warning alert: `max((max(src_workerutil_queue_duration_secon -
\ No newline at end of file +
diff --git a/docs/self-hosted/observability/logs.mdx b/docs/self-hosted/observability/logs.mdx index 6e5302963..bada0c8b9 100644 --- a/docs/self-hosted/observability/logs.mdx +++ b/docs/self-hosted/observability/logs.mdx @@ -28,7 +28,7 @@ The valid values are: - For certain services and log entries, Sourcegraph exports a [OpenTelemetry-compliant log data model](#opentelemetry). - `json_gcp`: Machine-readable JSON format, tailored to [GCP cloud-logging expected structure.](https://cloud.google.com/logging/docs/structured-logging#special-payload-fields) - `logfmt`: The [logfmt](https://github.com/kr/logfmt) format. - - Note that `logfmt` is no longer supported with [Sourcegraph's new internal logging standards](https://docs-legacy.sourcegraph.com/dev/how-to/add_logging/dev/how-to/add_logging) - if you need structured logs, we recommend using `json` instead. If set to `logfmt`, log output from new loggers will be in `condensed` format. + - Note that `logfmt` is no longer supported with Sourcegraph's new internal logging standards - if you need structured logs, we recommend using `json` instead. If set to `logfmt`, log output from new loggers will be in `condensed` format. ### OpenTelemetry diff --git a/docs/self-hosted/observability/troubleshooting.mdx b/docs/self-hosted/observability/troubleshooting.mdx index f990ceaab..beb61a0a6 100644 --- a/docs/self-hosted/observability/troubleshooting.mdx +++ b/docs/self-hosted/observability/troubleshooting.mdx @@ -170,7 +170,7 @@ If your users are experiencing search timeouts or search performance issues, ple 1. Try appending variations of `index:only`, `timeout:60s` and `count:999999` to the search query to see if it is still slow. 1. [Access Grafana directly](/self-hosted/observability/metrics#accessing-grafana-directly). 1. Select the **+** icon on the left-hand side, then choose **Import**. -1. Paste [this JSON](https://gist.githubusercontent.com/slimsag/3fcc134f5ce09728188b94b463131527/raw/f8b545f4ce14b0c30a93f05cd1ee469594957a2c/sourcegraph-debug-search-timeouts.json) into the input and click **Load**. +1. Paste the Sourcegraph debug search timeouts dashboard JSON into the input and click **Load**. 1. Once the dashboard appears, include screenshots of **the entire** dashboard in the issue report. 1. Include the logs of `zoekt-webserver` container in the `indexed-search` pods. If you are using single Docker container enable [debug logs](/self-hosted/observability/#Logs) first. diff --git a/docs/self-hosted/postgres.mdx b/docs/self-hosted/postgres.mdx index 16aa1c279..e66094353 100644 --- a/docs/self-hosted/postgres.mdx +++ b/docs/self-hosted/postgres.mdx @@ -105,8 +105,8 @@ When running an [external PostgreSQL instance](/self-hosted/external-services/po - [GCP CloudSQL](https://cloud.google.com/sql/docs/postgres/db-versions) - [Azure DB](https://docs.microsoft.com/en-us/azure/postgresql/concepts-supported-versions#managing-updates-and-upgrades) - [Heroku](https://devcenter.heroku.com/articles/upgrading-heroku-postgres-databases) -- [EnterpriseDB](https://www.enterprisedb.com/docs/en/9.6/pg/upgrading.html) -- [Citus](http://docs.citusdata.com/en/v8.1/admin_guide/upgrading_citus.html) +- [EnterpriseDB](https://www.enterprisedb.com/docs/pgd/latest/upgrades/) +- [Citus](https://docs.citusdata.com/en/v8.1/admin_guide/upgrading_citus.html) - [Aiven PostgreSQL](https://aiven.io/docs/platform/concepts/maintenance-window#related-pages) - [Your own PostgreSQL](https://www.postgresql.org/docs/16/pgupgrade.html) diff --git a/docs/self-hosted/updates/index.mdx b/docs/self-hosted/updates/index.mdx index bfa12e695..3f60f214d 100644 --- a/docs/self-hosted/updates/index.mdx +++ b/docs/self-hosted/updates/index.mdx @@ -73,7 +73,7 @@ Sourcegraph has two upgrade types. **Standard** upgrades and **Multiversion** up To facilitate the management of Sourcegraph's databases, we have created the `migrator` service. `migrator` is usually triggered automatically on Sourcegraph startup but can also be interacted with like a cli tool. Migrator's primary purpose is to manage and apply schema migrations. -- To learn more about migrations see our [developer docs](https://docs-legacy.sourcegraph.com/dev/background-information/sql/migrations_overview). +- To learn more about migrations, see the migrator documentation below. - For a full listing of migrator's command arguments see its [usage docs](/self-hosted/updates/migrator/migrator-operations). ### Best Practices @@ -106,7 +106,7 @@ Navigate to the `Site admin > Updates` page. Here you'll be notified if your ins If your instance has schema drift or unfinished oob migrations you may need to address these issues before upgrading. Feel free to reach out to us at [support@sourcegraph.com](mailto:support@sourcegraph.com). -- [More info on OOB migrations](https://docs-legacy.sourcegraph.com/dev/background-information/sql/migrations_overview#out-of-band-migrations) +- More info on OOB migrations is available on the Updates page in the site admin area. - [More info on schema drift](/self-hosted/updates/migrator/schema-drift) ## Instance Specific Procedures diff --git a/docs/self-hosted/url.mdx b/docs/self-hosted/url.mdx index b874398ad..db6123f88 100644 --- a/docs/self-hosted/url.mdx +++ b/docs/self-hosted/url.mdx @@ -1,6 +1,6 @@ # Configuring the external URL -It is highly recommended that you do NOT make any of the nodes running Sourcegraph directly accessible to the Internet. Instead, configure an [Internet Gateway](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Internet_Gateway.html) or equivalent to forward traffic to `httpNodePort` or `httpsNodePort` on any of the nodes in your cluster. +It is highly recommended that you do NOT make any of the nodes running Sourcegraph directly accessible to the Internet. Instead, configure an [Internet Gateway](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html) or equivalent to forward traffic to `httpNodePort` or `httpsNodePort` on any of the nodes in your cluster. When that is done, update your DNS records to point to your gateway's external IP, and change the following line in your [site configuration](/admin/config/site-config):