Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/admin/audit-log.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 0 additions & 1 deletion docs/admin/auth/login-form.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/auth/saml/one-login.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/code-hosts/bitbucket-cloud.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 0 additions & 2 deletions docs/admin/security-event-logs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/batch-changes/design.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
6 changes: 3 additions & 3 deletions docs/batch-changes/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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?

Expand Down
2 changes: 1 addition & 1 deletion docs/batch-changes/how-src-executes-a-batch-spec.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/cloud/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 0 additions & 2 deletions docs/code-insights/references/repository-scope.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/code-navigation/how-to/adding-scip-to-workflows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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/<your-username>/<your-repo>`.

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).
20 changes: 10 additions & 10 deletions docs/code-navigation/precise-code-navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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")
Expand Down
4 changes: 2 additions & 2 deletions docs/code-navigation/writing-an-indexer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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."
/>
<QuickLink
href="https://sourcegraph.github.io/scip-java/docs/getting-started.html"
href="https://github.com/sourcegraph/scip-java"
icon="theming"
imgAlt="Code Navigation"
title="Index a Java, Scala, or Kotlin repository"
Expand Down
2 changes: 1 addition & 1 deletion docs/code-search/how-to/opengrok.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

- [All Sourcegraph search documentation](/code-search/)
- [Sourcegraph query syntax](/code-search/queries)
- [Search product feature comparisons](https://about.sourcegraph.com/workflow)
- Search product feature comparisons
- [OpenGrok to Sourcegraph admin migration guide](/admin/migration/opengrok)

## Switching to Sourcegraph's query syntax
Expand Down
2 changes: 1 addition & 1 deletion docs/code-search/queries/language.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,7 @@ For example,

![repo-has-commit-after](https://storage.googleapis.com/sourcegraph-assets/Docs/CS-LANG/repo-has-commit-after.png)

Search only inside repositories that contain a commit after some specified time. See [git date formats](https://github.com/git/git/blob/master/Documentation/date-formats.txt) for accepted formats. Use this to filter out stale repositories that don’t contain commits past the specified time frame. This parameter is experimental.
Search only inside repositories that contain a commit after some specified time. See [git date formats](https://github.com/git/git/blob/master/Documentation/date-formats.adoc) for accepted formats. Use this to filter out stale repositories that don’t contain commits past the specified time frame. This parameter is experimental.

For example,

Expand Down
10 changes: 0 additions & 10 deletions docs/cody/clients/cody-with-sourcegraph.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,6 @@

In addition to the Cody extensions for [VS Code](/cody/clients/install-vscode), [JetBrains](/cody/clients/install-jetbrains), and [Visual Studio](/cody/clients/install-visual-studio) IDEs, Cody is also available in the Sourcegraph web app.

<LinkCards>
<LinkCard
href="https://sourcegraph.com/cody/chat"
imgSrc="https://storage.googleapis.com/sourcegraph-assets/Docs/sg-new-logo.svg"
imgAlt="Cody for Web"
title="Cody for Web"
description="Use Cody in the Sourcegraph Web app."
/>
</LinkCards>

## 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:
Expand Down
2 changes: 1 addition & 1 deletion docs/cody/clients/install-jetbrains.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="https://www.jetbrains.com/idea/" target="_blank">JetBrains IDEs</a> installed
- You have the latest version of <a href="https://www.jetbrains.com/idea/" target="_blank" rel="noopener noreferrer">JetBrains IDEs</a> installed
- A Sourcegraph Enterprise account with Cody enabled
- Cody is compatible with the following JetBrains IDEs:
- [Android Studio](https://developer.android.com/studio)
Expand Down
4 changes: 2 additions & 2 deletions docs/cody/clients/install-neovim.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="https://github.com/neovim/neovim/wiki/Installing-Neovim" target="_blank">Neovim</a> 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 <a href="https://github.com/neovim/neovim/wiki/Installing-Neovim" target="_blank" rel="noopener noreferrer">Neovim</a> 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
Expand Down
Loading
Loading