Skip to content

Commit e0ee09c

Browse files
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>

0 commit comments

Comments
 (0)