Skip to content

Commit 1e755c3

Browse files
MaedahBatoolbahrmichaelzahidalidevChickensoupwithricemichaellzc
authored
Docs working branch for the v6.0 release (#893)
This is the docs working branch for next release. - Updated logos and icons - @-mention prompts - Sourcegraph Analytics - Auto-edit docs - Brand refresh - New tier callouts - Agentic chat docs - Pricing docs - Chat docs - Query Types docs - Replace outdated screenshots --------- Co-authored-by: Michael Bahr <[email protected]> Co-authored-by: Zahid Ali <[email protected]> Co-authored-by: Anish Lakhwara <[email protected]> Co-authored-by: Michael Lin <[email protected]> Co-authored-by: Varun Gandhi <[email protected]> Co-authored-by: Justin Dorfman <[email protected]> Co-authored-by: Dan Adler <[email protected]> Co-authored-by: Dan Adler <[email protected]> Co-authored-by: Jacob Pleiness <[email protected]> Co-authored-by: Petri-Johan Last <[email protected]> Co-authored-by: Marc <[email protected]> Co-authored-by: Justin Dorfman <[email protected]> Co-authored-by: Valery Bugakov <[email protected]> Co-authored-by: Aravind Ramaraju <[email protected]> Co-authored-by: Beatrix <[email protected]> Co-authored-by: graceshih-sg <[email protected]>
1 parent bae5020 commit 1e755c3

File tree

91 files changed

+8321
-8408
lines changed

Some content is hidden

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

91 files changed

+8321
-8408
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Sourcegraph Docs
22

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

‎dev/rss.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ const generateRssFeed = () => {
3030
id: siteURL,
3131
link: baseURL,
3232
language: 'en',
33-
image: `${siteURL}/favicon.png`,
34-
favicon: `${siteURL}/favicon.ico`,
33+
image: `${siteURL}/sourcegraph-mark.png`,
34+
favicon: `${siteURL}/sourcegraph-mark.png`,
3535
copyright: `All rights reserved ${date.getFullYear()}, Sourcegraph`,
3636
updated: date,
3737
generator: 'Sourcegraph RSS Feed',

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

55
module.exports = config;

‎docs/admin/pricing.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,4 @@ A billable active Code Search or Code Intelligence Platform user is one who is s
4848

4949
A user who has accessed a Sourcegraph product is counted as active once they complete an action that represents usage reflected above.
5050

51-
User counts can be found in the **Site admin** section of the Sourcegraph web application, and Cody-specific usage metrics can be found in the [Cody Analytics service](../cody/clients/enable-cody-enterprise#analytics).
51+
User counts and more usage metrics can be found in [Sourcegraph Analytics](../analytics).

‎docs/analytics/cloud.mdx‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Sourcegraph Cloud Analytics
2+
3+
The following instructions are for all Sourcegraph Cloud and self-hosted customers who have upgraded to a sufficient version of Sourcegraph (5.9+) and fully enabled usage telemetry. Customers that self-host can also view our [self-hosted analytics enablement](/self-hosted).
4+
5+
![Sourcegraph-cloud-analytics](https://storage.googleapis.com/sourcegraph-assets/cloud-analytics.png)
6+
7+
## Enablement instructions
8+
9+
To enable Sourcegraph Analytics:
10+
11+
- Create an account on [Sourcegraph Accounts](https://accounts.sourcegraph.com/), or find the email address associated with your existing account.
12+
- Contact your Sourcegraph Technical Advisor or point of contact (or email us at [email protected] if you don't know your contact), provide them with the email address you used to register above and ask for access to Sourcegraph Analytics.
13+
- They will validate your account and link it to your Sourcegraph Enterprise instance's usage metrics.
14+
- Sign in to [Sourcegraph Analytics](https://cody-analytics.sourcegraph.com).
15+
16+
## Data export
17+
18+
Sourcegraph Cloud Analytics also includes a CSV export option with key metrics like the number of searches, chats, autocomplete suggestions, completion acceptance rate (CAR %), and more. The data is split by user, day, client/editor, and programming language, perfect for automating retrieval and analyzing data in ways that make the most sense to your organization.

‎docs/analytics/index.mdx‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# Sourcegraph Analytics
2+
3+
Enterprise customers can use Sourcegraph Analytics to get a clear view of usage, engagement, performance, and impact.
4+
5+
## Sourcegraph Cloud Analytics
6+
7+
[Sourcegraph Cloud](/cloud) customers can use our managed [cloud analytics service](https://cody-analytics.sourcegraph.com) for Cody and Code Search usage data.
8+
Self-hosted customers can also use this service, but they must
9+
10+
Upgrade to a supported version of Sourcegraph (5.9+)
11+
Have fully enabled usage telemetry.
12+
- [Enablement instructions](/analytics/cloud#enablement)
13+
14+
![Sourcegraph-cloud-analytics](https://storage.googleapis.com/sourcegraph-assets/Docs/Sourcegraph-Analytics-2025-01-28.png)
15+
16+
## Self-Hosted Analytics
17+
18+
Self-hosted customers will soon be able to use our self-hosted and locally deployed analytics service, built on Grafana, to see Sourcegraph usage data.
19+
20+
This product is in development now. If you would like to learn more, please contact your Sourcegraph representative.
21+
22+
## Metrics
23+
24+
We provide a set of metrics that can be used to monitor Sourcegraph usage, engagement, performance, and impact within your enterprise.
25+
26+
Learn more about how we think about [the ROI of Sourcegraph in our blog](https://sourcegraph.com/blog/measuring-the-impact-of-ai-coding-tools).
27+
28+
### User metrics available
29+
30+
| Metric | Description |
31+
| --------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
32+
| Total active users | Total number of unique users who have used any Sourcegraph product during the selected time |
33+
| Average daily users | The average number of unique users who use Sourcegraph per day during the selected time |
34+
| Average days of activity per user | The average number of days each user actively uses Sourcegraph during the selected time |
35+
| Daily active users | Number of unique users who used Sourcegraph by day |
36+
| Weekly active users | Number of unique users who used Sourcegraph by week |
37+
| Daily users by product | Count of daily users across different Sourcegraph products (Cody, Code Search, Code Insights, etc.) |
38+
| Product usage distribution (by percentage of users) | Percentage breakdown of users across different Sourcegraph product groupings during the selected time |
39+
| Detailed user activity (top 20 users) | List of the 20 most active users during the selected time and their usage patterns |
40+
| Frequency of usage | Count of users who used Sourcegraph _n_ times over the past 30 days |
41+
42+
Cody-only user metrics
43+
44+
Many of the metrics above are also available for Cody only. However, some user definitions are slightly different:
45+
46+
| User category | Description |
47+
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
48+
| Authenticated users | All users signed in to Cody in an editor or interacted with Cody on the web during the selected period. [Read more](/admin/pricing#authenticated-users). |
49+
| Active users | All users who sign in to Cody in an editor or interact with Cody on the web during the period selected. [Read more](/admin/pricing#billable-active-users). |
50+
51+
### Code Search & navigation metrics
52+
53+
| Metric | Description |
54+
| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
55+
| Total in-product searchers | Number of unique users who performed searches using the Sourcegraph search interface during the selected time |
56+
| Total result clicks | Count of times users clicked on search results to view files or other resources during the selected time |
57+
| Total file views | Number of times users viewed individual files through Sourcegraph during the selected time |
58+
| Daily in-product search activity | Count of search operations performed each day through the Sourcegraph interface |
59+
| Daily search users (in-product and API) | Number of unique users performing searches each day, including both UI and API usage |
60+
| All searches (in-product and API) by type | Breakdown of searches by category (e.g., literal, regex), including both UI and API usage |
61+
| Total code navigation actions | Count of all code navigation operations performed (e.g., go-to-definition, find references) during the selected time period |
62+
| Precise code navigation % | Percentage of code navigation actions that used precise intelligence rather than search-based results during the selected time |
63+
| Daily code navigation activity | Count of code navigation operations performed each day |
64+
| Daily code navigation users | Number of unique users utilizing code navigation features each day |
65+
| Precise vs. search-based code navigation actions by language | Comparison of precise vs. search-based navigation success rates broken down by programming language |
66+
67+
### Autocompletion metrics
68+
69+
| Metric | Description |
70+
| ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
71+
| Total accepted completions | Count of completions accepted by users during the selected time |
72+
| Hours saved | The number of hours saved by Cody users, assuming 2 minutes saved per completion |
73+
| Completions by day | The number of completions suggested by day and by editor. |
74+
| Completion acceptance rate (CAR) | The percent of completions presented to a user for at least 750ms accepted by day, the editor, day, and month. |
75+
| Weighted completion acceptance rate (wCAR) | Similar to CAR, but weighted by the number of characters presented in the completion, and only counting those fully retained by the user for X minutes after accepting the completion, by the editor, day, and month. |
76+
| Average completion latency (ms) | The average milliseconds of latency before a user is presented with a completion suggestion by an editor. |
77+
| Acceptance rate by language | CAR and total completion suggestions broken down by editor during the selected time |
78+
79+
### Chat and prompt metrics
80+
81+
| Metric | Description |
82+
| ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
83+
| Total chat events | Total number of chat interactions with Cody during the selected time |
84+
| Minutes saved per chat | Average time saved per chat interaction with Cody during the selected time |
85+
| Hours saved by chats | Total hours saved through Cody chat interactions during the selected time , assuming 5 minutes saved per chat |
86+
| Cody chats by day | Daily count of chat interactions |
87+
| Cody chat users | Daily count of chat users |
88+
| Prompts created, edited, and deleted by day | Daily count of prompt management activities, including creation, modification, and removal |
89+
| Users creating, editing, and deleting prompts by day | Number of unique users performing prompt management activities each day |
90+
91+
### Command metrics (deprecated)
92+
93+
_As of Sourcegraph version 5.10, commands are being deprecated in favor of our new feature, chat prompts. As a result, if your Sourcegraph instance is running version 5.10 or later, you may see decreased command usage. In the coming weeks, these command metrics will be deprecated and replaced with new prompt metrics on the Chats tab._
94+
95+
| Metric | Description |
96+
| ----------------------- | ----------------------------------------------------------------------------------------------------------- |
97+
| Total command events | Total number of command executions during the selected time |
98+
| Hours saved by commands | Total hours saved through command executions during the selected time, assuming 5 minutes saved per command |
99+
| Cody commands by day | Daily count of command executions |
100+
| Cody command users | Daily count of command users |
101+
| Most used commands | Ranking of most frequently used Cody commands during the selected time |

‎docs/analytics/self-hosted.mdx‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Sourcegraph Self-Hosted Analytics
2+
3+
<Callout type="note">This feature is not yet available. Coming soon.</Callout>
4+
5+
Sourcegraph Self-Hosted Analytics is coming soon! Self-hosted customers can view usage metrics in a locally deployed analytics service built on Grafana.
6+
7+
This product is in development now. If you would like to learn more, please contact your Sourcegraph representative.
8+
9+
## Set-up instructions
10+
11+
Coming soon.
12+
13+
## Updates
14+
15+
Coming soon.
16+
17+
## Custom metrics
18+
19+
Coming soon.

‎docs/batch-changes/index.mdx‎

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

3+
<TierCallout>
4+
Supported on [Enterprise](/pricing/enterprise) plans.
5+
<user>
6+
Currently available via the Web app.
7+
</user>
8+
</TierCallout>
9+
310
<p className="subtitle">This section is about Batch Changes, which helps you automate and ship large-scale code changes across many repositories and code hosts.</p>
411

512
Batch Changes helps you ship large-scale code changes across many repositories and code hosts. You can create pull requests on all affected repositories, and it tracks their progress until they're all merged. You can also preview the changes and update them at any time.

‎docs/code-search/code-navigation/auto_indexing.mdx‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
# Auto-indexing
22

3-
<p className="subtitle">Learn and understand how auto-indexing works.</p>
3+
<TierCallout>
4+
Supported on [Enterprise](/pricing/enterprise) plans.
5+
<user>
6+
Currently in Beta and available via Web app.
7+
</user>
8+
</TierCallout>
49

5-
<Callout type="note">Auto-indexing is currently in Beta stage.</Callout>
10+
<p className="subtitle">Learn and understand how auto-indexing works.</p>
611

712
With Sourcegraph deployments supporting [executors](/admin/executors/), your repository contents can be automatically analyzed to produce a code graph index file. Once [auto-indexing is enabled](/code-search/code-navigation/auto_indexing#enable-auto-indexing) and [auto-indexing policies are configured](/code-search/code-navigation/auto_indexing#configure-auto-indexing), repositories will be periodically cloned into an executor sandbox, analyzed, and the resulting index file will be uploaded back to the Sourcegraph instance.
813

‎docs/code-search/code-navigation/precise_code_navigation.mdx‎

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

3+
<TierCallout>
4+
Supported on [Enterprise](/pricing/enterprise) plans.
5+
<user>
6+
Available via the Web app.
7+
</user>
8+
</TierCallout>
9+
310
<p className="subtitle">Learn and understand about Precise Code Navigation.</p>
411

512
Precise Code Navigation is an opt-in feature that is enabled from your admin settings and requires you to upload indexes for each repository to your Sourcegraph instance. Once setup is complete on Sourcegraph, precise code navigation is available for use across popular development tools:

0 commit comments

Comments
 (0)