Skip to content

Commit d411126

Browse files
feedback
1 parent aa834a0 commit d411126

File tree

4 files changed

+26
-6
lines changed

4 files changed

+26
-6
lines changed

docs/docs/connections/overview.mdx

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ A JSON configuration file is used to specify connections. For example:
4141
}
4242
```
4343

44-
Configuration files must conform to the [JSON schema](https://raw.githubusercontent.com/sourcebot-dev/sourcebot/main/schemas/v3/index.json).
44+
Configuration files must conform to the [JSON schema](#schema-reference).
4545

4646
When running Sourcebot, this file must be mounted in a volume that is accessible to the container, with it's path specified in the `CONFIG_FILE` environment variable. For example:
4747

@@ -53,6 +53,23 @@ docker run \
5353
ghcr.io/sourcebot-dev/sourcebot:latest
5454
```
5555

56+
Sourcebot performs syncing in the background. Syncing consists of two steps:
57+
1. Fetch the latest changes from `HEAD` (and any [additional branches](/docs/features/search/multi-branch-indexing)) from the code host.
58+
2. Re-indexes the repository.
59+
60+
This is processed in a [job queue](/docs/overview#architecture), and is parallelized across multiple worker processes. Jobs will take longer to complete the first time a repository is synced, or when a diff is large.
61+
62+
On the home page, you can view the sync status of ongoing jobs:
63+
64+
<video
65+
autoPlay
66+
muted
67+
loop
68+
playsInline
69+
className="w-full aspect-video"
70+
src="https://framerusercontent.com/assets/7YyxK8ctPEy9Rf68X2kIdMI.mp4"
71+
></video>
72+
5673
## Getting started
5774
---
5875

docs/docs/deployment-guide.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,13 +79,17 @@ Watch this 1:51 minute video to get a quick overview of how to deploy Sourcebot
7979

8080
</Step>
8181

82-
<Step title="Done">
83-
You're all set! Navigate to `http://localhost:3000` to login and start searching.
82+
<Step title="Login">
83+
Navigate to `http://localhost:3000` and create an account. The first account which is registered on a fresh Sourcebot deployment is given the [owner role](/docs/configuration/auth/roles-and-permissions).
8484

8585
<Note>
86-
The first account which is registered on a fresh Sourcebot deployment is given the [owner role](/docs/configuration/auth/roles-and-permissions).
86+
By default, only email / password authentication is enabled. [Learn more about authentication](/docs/configuration/auth/overview).
8787
</Note>
8888
</Step>
89+
90+
<Step title="Done">
91+
You're all set! You can now start searching - checkout the [syntax guide](/docs/syntax-guide) to learn more about how to search.
92+
</Step>
8993
</Steps>
9094

9195
## Next steps

docs/docs/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Search across millions of lines of code in seconds using Sourcebot's blazingly f
7171
Connect your code from multiple code-host platforms and search across all of them from a single interface.
7272

7373
<Accordion title="Key benefits">
74-
- **Auto re-syncing:** Code-hosts will periodically sync with Sourcebot to pull the latest changes.
74+
- **Auto re-syncing:** Sourcebot will periodically sync with code hosts to pull the latest changes.
7575
- **Flexible configuration:** Sourcebot uses a expressive [JSON schema](/docs/connections/overview) config format to specify exaclty what repositories to index (and what not to index).
7676
- **Parallel indexing:** Repositories are indexed in parallel.
7777
</Accordion>

packages/web/src/features/entitlements/server.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@ export const getPlan = (): Plan => {
5555

5656
return licenseKey.seats === SOURCEBOT_UNLIMITED_SEATS ? "self-hosted:enterprise-unlimited" : "self-hosted:enterprise";
5757
} else {
58-
console.info(`No valid license key found. Falling back to oss plan.`);
5958
return "oss";
6059
}
6160
}

0 commit comments

Comments
 (0)