Skip to content

Commit e0ee09c

Browse files
zahidalidevzahidalidev
authored
Merge branch 'main' into upgrade
2 parents bbb3e30 + 73206cc commit e0ee09c

File tree

168 files changed

+14220
-11670
lines changed

Some content is hidden

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

168 files changed

+14220
-11670
lines changed

‎README.md

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

3-
<!-- Working branch for JAN 2025 Release -->
3+
<!-- Working branch for SG 6.3 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

@@ -18,7 +18,7 @@ Navigate to the project directory by typing the following command in your termin
1818
cd sourcegraph-docs
1919
```
2020

21-
Before the dependencies are install make sure your local machine has the following versions of `node` and `pnpm`:
21+
Before the dependencies are install make sure your local machine has the following versions of `node` and `pnpm` installed:
2222

2323
* node: `v20.8.1`
2424
* pnpm: `8.13.1`
@@ -148,11 +148,10 @@ 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** link from Vercel's deployment panel in your PRs and you get a preview of your docs
152152

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

155-
156155
## Submitting your Contribution
157156

158157
Once you're satisfied with your changes, follow these steps:

‎baseai/memory/docs/index.ts renamed to ‎baseai/memory/memory-sg-docs-live/index.ts

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
import { MemoryI } from '@baseai/core';
22

33
const memoryDocs = (): MemoryI => ({
4-
name: 'docs',
5-
description: 'Docs folder of sourcegraph docs repository as an auto-synced memory',
4+
name: 'memory-sg-docs-live',
5+
description: 'An AI memory storing all Sourcegraph docs.',
66
git: {
77
enabled: true,
88
include: ['**/*.mdx'],
99
gitignore: true,
10-
deployedAt: '39f2778ad2dce348bb762a85f765c21453cec4fe',
11-
embeddedAt: ''
10+
embeddedAt: '',
11+
deployedAt: '1b67d5c14520a898e2b9933ab3d2a9fe28515e31'
1212
},
1313
documents: {
1414
meta: doc => {
@@ -22,3 +22,6 @@ const memoryDocs = (): MemoryI => ({
2222
});
2323

2424
export default memoryDocs;
25+
26+
// Old
27+
// deployedAt: '5f3fec8530280d01a783aadcdeb0ccc3f9cd8b70',

‎contentlayer.config.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
/* eslint-disable */
2-
31
import { defineDocumentType, makeSource } from 'contentlayer/source-files';
42
import fs from 'fs';
53
import rehypeAutolinkHeadings from 'rehype-autolink-headings';

‎docs-chatbot.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# How we use Docs Chatbot?
2+
3+
Contact the docs team for any more questions on this.
4+
5+
## To sync all the latest docs changes in the `main` branch check out to the `main` branch and run
6+
7+
```sh
8+
pnpm langbase-sync
9+
```
10+
11+
This will verify all the changes since the last sync, update these files, and then write the commit hash to `baseai/memory/docs/index.ts` file which you should commit to keep track.
12+
13+
### Update llms.txt file
14+
15+
Run the following command to update the `llms.txt` file:
16+
17+
```sh
18+
pnpm llmstxt
19+
```

‎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: '6.0'
2+
DOCS_LATEST_VERSION: '6.3'
33
};
44

55
module.exports = config;

‎docs/admin/access_control/index.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Access control
22

3+
<TierCallout>
4+
Supported on [Enterprise](/pricing/enterprise) plans.
5+
<user>
6+
Available via the Web app.
7+
</user>
8+
</TierCallout>
9+
310
<Callout type="info">This feature is in Beta stage.</Callout>
411

512
> NOTE: This page refers to in-product permissions, which determine who can, for example, create a batch change, or who is a site admin. This is *not* the same as [repository permissions](/admin/permissions/), which enforces the same repository access on Sourcegraph as your code host.

‎docs/admin/analytics.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Analytics
22

3+
<TierCallout>
4+
Supported on [Enterprise](/pricing/enterprise) plans.
5+
<user>
6+
Available via the Web app.
7+
</user>
8+
</TierCallout>
9+
310
The analytics section helps Sourcegraph administrators understand user engagement across the various Sourcegraph features, identify power users, and convey value to internal leaders. Introduced in version 3.42, the section includes analytics breakdowns for our most common features such as Batch Changes, Search Notebooks and search, while also providing basic user-level analytics.
411

512
## Data Visualizations

‎docs/admin/architecture.mdx

Lines changed: 209 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/admin/auth/index.mdx

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# User authentication
22

3+
<TierCallout>
4+
Supported on [Enterprise](/pricing/enterprise) plans.
5+
<user>
6+
Available via the Web app.
7+
</user>
8+
</TierCallout>
9+
310
In order to use a Sourcegraph instance, users need an account on the instance. Accounts are used to store settings and preferences, but also to identify a person to make decisions about repository visibility.
411

512
For that, various authentication providers can be configured. Multiple options can be provided.
@@ -49,8 +56,7 @@ order:
4956
use the [OpenID Connect provider](#openid-connect).
5057
- If you wish to use LDAP and cannot use the GitHub/GitLab OAuth provider as described above, or if
5158
you wish to use another authentication mechanism that is not yet supported, please [contact
52-
us](https://github.com/sourcegraph/sourcegraph/issues/new?template=feature_request) (we respond
53-
promptly).
59+
us](https://sourcegraph.com/contact)
5460

5561
Most users will use only one auth provider, but you can use multiple auth providers if desired to
5662
enable sign-in via multiple services. Identities from different providers will be mapped to a

‎docs/admin/auth/saml/azure_ad.mdx

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
1-
# Configuring SAML with Microsoft Entra ID
1+
# Configuring SAML with Microsoft Entra ID
2+
<Callout type="note">Formerly known as Azure Active Directory, or Azure AD.</Callout>
23

34
## 1. Add an unlisted (non-gallery) application to your Microsoft Entra ID organization
45

56
1. In Microsoft Entra ID, create an unlisted (non-gallery) application [following the official documentation](https://docs.microsoft.com/en-us/azure/active-directory/manage-apps/add-non-gallery-app).
6-
1. Once the application is created, follow [these instructions to enable SAML SSO](https://docs.microsoft.com/en-us/azure/active-directory/manage-apps/configure-single-sign-on-non-gallery-applications). Use these configuration values (replacing "sourcegraph.example.com" with your Sourcegraph instance URL):
7-
* **Identifier (Entity ID):** `https://sourcegraph.example.com/.auth/saml/metadata`
8-
* **Reply URL (Assertion Consumer Service URL):** `https://sourcegraph.example.com/.auth/saml/acs`
9-
* **Sign-on URL, Relay State, and Logout URL** can be left empty.
10-
* **User Attributes & Claims:** Add the following attributes.
11-
- `emailaddress`: user.mail (required)
12-
- `name`: user.userprincipalname (optional)
13-
- `login`: user.userprincipalname (optional)
14-
* **Name ID**: `email`
15-
* You can leave the other configuration values set to their defaults.
16-
1. Record the value of the "App Federation Metadata Url". You'll need this in the next section.
7+
2. Once the application is created, follow [these instructions to enable SAML SSO](https://docs.microsoft.com/en-us/azure/active-directory/manage-apps/configure-single-sign-on-non-gallery-applications). Use these configuration values (replacing "sourcegraph.example.com" with your Sourcegraph instance URL):
8+
* **Identifier (Entity ID):** `https://sourcegraph.example.com/.auth/saml/metadata`
9+
* **Reply URL (Assertion Consumer Service URL):** `https://sourcegraph.example.com/.auth/saml/acs`
10+
* **Sign-on URL, Relay State, and Logout URL** can be left empty.
11+
* **User Attributes & Claims:** Add the following attributes.
12+
- `emailaddress`: user.mail (required)
13+
- `name`: user.userprincipalname (optional)
14+
- `login`: user.userprincipalname (optional)
15+
* **Name ID**: `email`
16+
* You can leave the other configuration values set to their defaults.
17+
3. Record the value of the "App Federation Metadata Url". You'll need this in the next section.
1718

1819
## 2. Add the SAML auth provider to Sourcegraph site config
1920

@@ -33,4 +34,4 @@
3334
}
3435
```
3536

36-
> NOTE: Optional, but recommended: [add automatic provisioning of users with SCIM](/admin/scim).
37+
<Callout type="note">Recommended: [add automatic provisioning of users with SCIM](/admin/scim).</Callout>

‎docs/admin/auth/saml/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Error prefetching SAML service provider metadata
8181

8282
> NOTE: Email or NameID changes in the identity provider are not automatically reflected in Sourcegraph. Admins may manually update a users email via the admin interface at `https://example-sourcegraph.com/users/<user>/settings/emails`, or remove the user and recreate a new account.
8383
>
84-
> Work is planned to support SCIM on SAML auth providers, which should automate this process. ([tracking issue](https://github.com/sourcegraph/sourcegraph/issues/22732))
84+
> Work is planned to support SCIM on SAML auth providers, which should automate this process.
8585
8686
### How to control user sign-up and sign-in
8787

‎docs/admin/beta_and_experimental_features.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Sourcegraph often beta tests major features before we make them generally availa
44

55
Exposing beta and experimental features gives you an opportunity to try our newest features sooner.
66

7-
In return, your feedback helps us make sure that our new features are reliable and useful, and we appreciate any and all feedback you want to provide. You can [file an issue](https://github.com/sourcegraph/sourcegraph/issues/new/choose), email it directly to [feedback@sourcegraph.com](mailto:feedback@sourcegraph.com), or use the in-app feedback modal.
7+
In return, your feedback helps us make sure that our new features are reliable and useful, and we appreciate any and all feedback you want to provide. You can email us directly to [feedback@sourcegraph.com](mailto:feedback@sourcegraph.com).
88

99
## Both beta and experimental features
1010

‎docs/admin/code_hosts/aws_codecommit.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# AWS CodeCommit
22

3+
<TierCallout>
4+
Supported on [Enterprise](/pricing/enterprise) plans.
5+
<user>
6+
Available via the Web app.
7+
</user>
8+
</TierCallout>
9+
310
Site admins can sync Git repositories hosted on [AWS CodeCommit](https://aws.amazon.com/codecommit/) with Sourcegraph so that users can search and navigate the repositories.
411

512
To connect AWS CodeCommit to Sourcegraph:

‎docs/admin/code_hosts/azuredevops.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Azure DevOps
22

3+
<TierCallout>
4+
Supported on [Enterprise](/pricing/enterprise) plans.
5+
<user>
6+
Available via the Web app.
7+
</user>
8+
</TierCallout>
9+
310
Site admins can sync Git repositories hosted on [Azure DevOps](https://dev.azure.com) with Sourcegraph so that users can search and navigate the repositories.
411

512
To connect Azure DevOps to Sourcegraph, create a personal access token from your user settings page by following the below steps:

‎docs/admin/code_hosts/bitbucket_cloud.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Bitbucket Cloud
22

3+
<TierCallout>
4+
Supported on [Enterprise](/pricing/enterprise) plans.
5+
<user>
6+
Available via the Web app.
7+
</user>
8+
</TierCallout>
9+
310
Site admins can sync Git repositories hosted on [Bitbucket Cloud](https://bitbucket.org) with Sourcegraph so that users can search and navigate the repositories.
411

512
To connect Bitbucket Cloud to Sourcegraph:

‎docs/admin/code_hosts/bitbucket_server.mdx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
# Bitbucket Server / Bitbucket Data Center
1+
# Bitbucket Server/Bitbucket Data Center
2+
3+
<TierCallout>
4+
Supported on [Enterprise](/pricing/enterprise) plans.
5+
<user>
6+
Available via the Web app.
7+
</user>
8+
</TierCallout>
29

310
Site admins can sync Git repositories hosted on [Bitbucket Server](https://www.atlassian.com/software/bitbucket/server) or [Bitbucket Data Center](https://www.atlassian.com/enterprise/data-center/bitbucket) with Sourcegraph so that users can search and navigate their repositories.
411

‎docs/admin/code_hosts/gerrit.mdx

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,23 @@
11
# Gerrit
22

3-
<Callout type="note">This feature is in beta and might change in the future.</Callout>
3+
<TierCallout>
4+
Supported on [Enterprise](/pricing/enterprise) plans.
5+
<user>
6+
Available via the Web app.
7+
</user>
8+
</TierCallout>
9+
10+
<Callout type="note">This feature is in beta and might change in the future.</Callout>
411

512
A Gerrit instance can be connected to Sourcegraph as follows:
613

714
- [Gerrit](#gerrit)
815
- [Configure Gerrit as a code host connection](#configure-gerrit-as-a-code-host-connection)
16+
- [Clone using SSH](#clone-using-ssh)
917
- [Add Gerrit as an authentication provider](#add-gerrit-as-an-authentication-provider)
1018
- [Have users authenticate their Sourcegraph accounts using their Gerrit HTTP credentials](#have-users-authenticate-their-sourcegraph-accounts-using-their-gerrit-http-credentials)
1119
- [Configuration](#configuration)
12-
- [admin/external\_service/gerrit.schema.json](#adminexternal_servicegerritschemajson)
20+
- [admin/code\_hosts/gerrit.schema.json](#admincode_hostsgerritschemajson)
1321

1422
## Configure Gerrit as a code host connection
1523

‎docs/admin/code_hosts/github.mdx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,8 @@ To create a GitHub App and connect it to Sourcegraph:
6666

6767
9. (Optional) If you want to sync repositories from other organization or user namespaces and your GitHub App is set to public visibility, you can create additional installations with **Add installation**.
6868

69+
> NOTE: When you create a GitHub App, Sourcegraph automatically sets up an [incoming webhook](/admin/config/webhooks/incoming) for the app. This webhook subscribes to events for any repository or organization the app has access to, allowing Sourcegraph to keep repository and permission data in sync with GitHub.
70+
6971
> NOTE: If you are using [Batch Changes](/batch-changes/), you can create a GitHub App to perform [commit signing](/admin/config/batch_changes#commit-signing-for-github) (Beta).
7072
7173
### Multiple installations
@@ -109,6 +111,11 @@ Once public, App can be installed in additional namespaces either from Sourcegra
109111

110112
5. To sync repositories from this installation, click **Add connection** under your new installation.
111113

114+
### Configuring Multiple Private GitHub Apps for Sourcegraph
115+
If you prefer not to make your GitHub App public and instead create separate private GitHub Apps for each organizations, users will need to authorize each GitHub App individually to ensure proper repository access and permissions syncing. This is because GitHub Apps have narrowly scoped permissions and do not share authentication across multiple installations. To streamline this process, users can go to `User Settings` > `Account Security` in Sourcegraph and connect all necessary GitHub Apps from there. Once authorized, Sourcegraph will use the user's GitHub identity to determine access across all configured GitHub Apps.
116+
117+
For customers using GitHub Enterprise Cloud, an alternative approach is to create an Enterprise GitHub App, which can be installed across multiple organizations within an enterprise account while maintaining private visibility. More details on this approach can be found in [GitHub's documentation](https://docs.github.com/en/enterprise-cloud@latest/admin/managing-your-enterprise-account/creating-github-apps-for-your-enterprise).
118+
112119
### Uninstalling an App
113120

114121
You can uninstall a GitHub App from a namespace or remove it altogether at any time.
@@ -234,7 +241,7 @@ There are four fields for configuring which repositories are mirrored/synchroniz
234241

235242
- [`repos`](/admin/code_hosts/github#repos)A list of repositories in `owner/name` format. The order determines the order in which we sync repository metadata and is safe to change.
236243
- [`orgs`](/admin/code_hosts/github#orgs)A list of organizations (every repository belonging to the organization will be cloned).
237-
- [`repositoryQuery`](/admin/code_hosts/github#repositoryQuery)A list of strings with three pre-defined options (`public`, `affiliated`, `none`, none of which are subject to result limitations), and/or a [GitHub advanced search query](https://github.com/search/advanced). Note: There is an existing limitation that requires the latter, GitHub advanced search queries, to return [less than 1000 results](#repositoryquery-returns-first-1000-results-only). See [this issue](https://github.com/sourcegraph/sourcegraph/issues/2562) for ongoing work to address this limitation.
244+
- [`repositoryQuery`](/admin/code_hosts/github#repositoryQuery)A list of strings with three pre-defined options (`public`, `affiliated`, `none`, none of which are subject to result limitations), and/or a [GitHub advanced search query](https://github.com/search/advanced). Note: There is an existing limitation that requires the latter, GitHub advanced search queries, to return [less than 1000 results](#repositoryquery-returns-first-1000-results-only).
238245
- [`exclude`](/admin/code_hosts/github#exclude)A list of repositories to exclude which takes precedence over the `repos`, `orgs`, and `repositoryQuery` fields.
239246

240247
## Rate limits

‎docs/admin/code_hosts/gitolite.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Gitolite
22

3+
<TierCallout>
4+
Supported on [Enterprise](/pricing/enterprise) plans.
5+
<user>
6+
Available via the Web app.
7+
</user>
8+
</TierCallout>
9+
310
> NOTE: While it is possible to connect Gitolite repositories to Sourcegraph, we currently do not recommend it. If you have specific questions, please discuss with your account team.
411
512
Site admins can link and sync Git repositories on [Gitolite](https://gitolite.com) with Sourcegraph so that users can search and navigate the repositories.

‎docs/admin/code_hosts/index.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Code host connections
22

3+
<TierCallout>
4+
[Enterprise Starter](/pricing/enterprise-starter) only supports GitHub. [Enterprise](/pricing/enterprise) supports all listed code hosts.
5+
<user>
6+
Available via the Web app.
7+
</user>
8+
</TierCallout>
9+
310
<Callout type="info">Sourcegraph Enterprise Starter supports only GitHub as a code host connection. Enterprise plan can connect to all supported code hosts listed on this page.</Callout>
411

512
Sourcegraph can sync repositories from code hosts and other similar services. We designate code hosts between Tier 1 and Tier 2 based on Sourcegraph's capabilities when used with those code hosts.
@@ -51,13 +58,6 @@ We recognize there are other code hosts including CVS, SVN, and many more. Today
5158
- [Non-Git code hosts](/admin/code_hosts/non-git)
5259
- [Perforce](/admin/repo/perforce)
5360
- [Plastic SCM](/admin/repo/plasticscm)
54-
- [Package repository hosts](/admin/code_hosts/package-repos)
55-
- [JVM dependencies](/admin/code_hosts/jvm)
56-
- [Go dependencies](/admin/code_hosts/go)
57-
- [npm dependencies](/admin/code_hosts/npm)
58-
- [Python dependencies](/admin/code_hosts/python)
59-
- [Ruby dependencies](/admin/code_hosts/ruby)
60-
- [Rust dependencies](/admin/code_hosts/rust)
6161

6262
## Rate limits
6363

‎docs/admin/code_hosts/non-git.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Non-Git code hosts (Perforce, Mercurial, Subversion, raw text, etc.)
22

3+
<TierCallout>
4+
Supported on [Enterprise](/pricing/enterprise) plans.
5+
<user>
6+
Available via the Web app.
7+
</user>
8+
</TierCallout>
9+
310
Sourcegraph natively supports all Git-based Version Control Systems (VCSs) and code hosts. For non-Git code hosts, Sourcegraph provides a CLI tool called `src-expose` to periodically sync and continuously serve local directories as Git repositories over HTTP.
411

512
>NOTE: If using Perforce, see the [Perforce repositories with Sourcegraph guide](/admin/repo/perforce).

‎docs/admin/code_hosts/other.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Other Git repository hosts
22

3+
<TierCallout>
4+
Supported on [Enterprise](/pricing/enterprise) plans.
5+
<user>
6+
Available via the Web app.
7+
</user>
8+
</TierCallout>
9+
310
Site admins can sync Git repositories on any Git repository host (by Git clone URL) with Sourcegraph so that users can search and navigate the repositories. Use this method only when your repository host is not named as a supported [code host](/admin/code_hosts/).
411

512
To connect generic Git host to Sourcegraph:

‎docs/admin/code_hosts/phabricator.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Phabricator
22

3+
<TierCallout>
4+
Supported on [Enterprise](/pricing/enterprise) plans.
5+
<user>
6+
Available via the Web app.
7+
</user>
8+
</TierCallout>
9+
310
Site admins can associate Git repositories on [Phabricator](https://phabricator.org) with Sourcegraph so that users can jump to the Phabricator repository from Sourcegraph and use the [Phabricator extension](#native-extension) and [browser extension](/integration/browser_extension) with Phabricator.
411

512
> ⚠️ NOTE: Sourcegraph support of Phabricator is limited ([learn more](/integration/phabricator)), and not expected to evolve due to the [announced](https://admin.phacility.com/phame/post/view/11/phacility_is_winding_down_operations/) cease of support for Phabricator.

0 commit comments

Comments
 (0)