Skip to content

Commit 762f3e9

Browse files
MaedahBatoolMaedahBatool
committed
Revamp Cody PLG+ENT docs
1 parent b5afc4b commit 762f3e9

File tree

8 files changed

+233
-54
lines changed

8 files changed

+233
-54
lines changed

‎docs/cody/clients/enable-cody-enterprise.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Enabling Cody on Sourcegraph Enterprise
1+
# Cody Enterprise
22

33
<p className="subtitle">This guide will walk you through the steps to install and set up Cody with your Sourcegraph Enterprise instance.</p>
44

‎docs/cody/content-tabs.mdx‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Test
2+
3+
<ContentTabs>
4+
<ContentTab title="VS Code" href="/cody/clients/install-vscode" />
5+
<ContentTab title="JetBrains (beta)" href="/cody/clients/install-jetbrains" />
6+
<ContentTab title="Neovim (experimental)" href="/cody/clients/install-neovim" />
7+
<ContentTab title="Web" href="/cody/clients/cody-with-sourcegraph" />
8+
<ContentTab title="Cody Enterprise" href="/cody/clients/enable-cody-enterprise" />
9+
</ContentTabs>

‎docs/cody/core-concepts/enterprise-architecture.mdx‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Enterprise architecture
1+
# Cody Enterprise Architecture
2+
3+
<p className="subtitle">The diagrams on this page explain the core architecture for Cody Enterprise users.</p>
24

35
[Cody Enterprise](/cody/clients/enable-cody-enterprise) can run in the Sourcegraph Cloud environment or on your own infrastructure. Here are a few possible deployment architectures.
46

@@ -15,4 +17,4 @@
1517

1618
## Data flow
1719

18-
<img src="https://sourcegraphstatic.com/docs/enterprise-architecture-data-flow-v0.png" />
20+
<img src="https://sourcegraphstatic.com/docs/enterprise-architecture-data-flow-v0.png" />

‎docs/cody/enterprise/configure-cody.mdx‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Advanced Features
2+
3+
<p className="subtitle">Learn about all the advanced features that users on Cody Enterprise get.</p>
4+
5+
<Tabs>
6+
<Tab title="IDE Token Expiry">
7+
Site administrators can customize the time duration of the access token used by other users on the Sourcegraph Enterprise instance to connect Cody from their IDEs via the **Site admin** page. Administrators can choose from various options, including 7, 14, 30, 60, and 90 days.
8+
9+
![ide-token-expiry](https://storage.googleapis.com/sourcegraph-assets/Docs/token-expiry.png)
10+
</Tab>
11+
<Tab title="Guardrails">
12+
<Callout type= "note">Guardrails for public code is currently in Beta stage and is supported with VS Code and JetBrains IDEs extensions.</Callout>
13+
14+
Open source attribution guardrails for public code reduce the exposure to copyrighted code, commonly called copyright guardrails. This involves the implementation of a verification mechanism within Cody to ensure that any code generated by the platform does not replicate open source code.
15+
16+
Guardrails for public code are available to all Sourcegraph Enterprise instances and are **disabled** by default. You can enable it from the **Site configuration**. You can do so by setting `"attribution.enabled": true` in site config.
17+
18+
It only matches code snippets that are at least **10 lines** or longer, and the search corpus **290,000** open source repositories.
19+
20+
<Callout type="info">Guardrails don't differentiate between license types. It matches any code snippet that is at least 10 lines long from the 290,000 indexed open source repositories.</Callout>
21+
</Tab>
22+
<Tab title="Admin Controls">
23+
<Callout type="note">Admin Controls is supported with VS Code and JetBrains IDE extension.</Callout>
24+
25+
Sourcegraph account admins have selective control over users' access to Cody Enterprise, which is now managed via the Sourcegraph role-based access control system. This provides a more intuitive user interface for assigning permission to use Cody.
26+
</Tab>
27+
<Tab title="Analytics">
28+
<Callout type= "note">Cody Analytics are supported with VS Code IDE extension and on the latest versions of JetBrains IDE.</Callout>
29+
30+
Cody Enterprise users get a clear view of usage analytics for their instance on a self-service basis. A separately managed cloud service for Cody analytics handles user auth, gets metrics data from Sourcegraph's BigQuery instance, and visualizes the metrics data.
31+
32+
The following metrics are available for Cody Enterprise users:
33+
34+
| **Metric Type** | **What is measured?** |
35+
| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
36+
| Active users | - Total active users <br /> - Average daily users <br /> - Average no. of days each user used Cody (of last 30 days) <br /> - Cody users by day (last 30 days) <br /> - Cody users by month (last two months) <br /> - Cody users by number of days used |
37+
| Completions | - Total accepted completions <br /> - Minutes saved per completion <br /> - Hours saved by completions <br /> - Cody completions by day <br /> - Completions acceptance rate <br /> - Weighted completions acceptance rate <br /> - Average completion latency <br /> - Acceptance rate by language <br /> |
38+
| Chat | - Total chat events <br /> - Minutes saved per chat <br /> - Hours saved by chats <br /> - Cody chats by day |
39+
| Commands | - Total command events <br /> - Minutes saved per command <br /> - Hours saved by commands <br /> - Cody commands by day <br /> - Most used commands |
40+
41+
To enable Cody Analytics:
42+
43+
- Create an account on [Sourcegraph Accounts](https://accounts.sourcegraph.com/)
44+
- A user already having an account on Sourcegraph.com gets automatically migrated to Sourcegraph Accounts. Users can sign in to Cody Analytics using their email and password
45+
- Users without a Sourcegraph.com account, please get in touch with one of our teammates. They can help with both the account setup and assigning instances to specific users
46+
- Map your user account to a Sourcegraph instance, and this gives you access to Cody's analytics
47+
48+
</Tab>
49+
50+
<Tab title="Multi-repository context">
51+
<Callout type="info">Multi-repo context for Sourcegraph Enterprise is supported with VS Code and JetBrains editor extensions.</Callout>
52+
53+
Cody Enterprise supports searching up to 10 repositories to find relevant context in chat.
54+
55+
* In VS Code, open a new Cody chat, type `@`, and select `Remote Repositories` to search other repositories for context
56+
* In JetBrains, use the enhanced context selector
57+
58+
### @-mention directory
59+
60+
<Callout type="info">@-mentioning directory is available for Enterprise users on VS Code, JetBrains, and Cody Web.</Callout>
61+
62+
To better support teams working with large monorepos, Enterprise users can `@-mention` directories when chatting with Cody. This helps you define more specific directories and sub-directories within that monorepo to give more precise context.
63+
64+
To do this, type `@` in the chat, and then select **Directories** to search other repositories for context in your codebase.
65+
66+
<video width="1920" height="1080" loop playsInline controls style={{ width: '100%', height: 'auto' }}>
67+
<source src="https://storage.googleapis.com/sourcegraph-assets/Docs/Media/%40-mention-dir-0824.mp4" type="video/mp4"/>
68+
</video>
69+
70+
Please note that you can only `@-mention` remote directories (i.e., directories in your Sourcegraph instance) but not local directories. This means any recent changes to your directories can't be utilized as context until your Sourcegraph instance re-indexes any changes.
71+
72+
If you want to include recent changes that haven't been indexed in your Sourcegraph instance, you can `@-mention` specific files, lines of code, or symbols.
73+
</Tab>
74+
</Tabs>

‎docs/cody/enterprise/index.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Cody for Admins

‎docs/cody/enterprise/llm-models.mdx‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Supported LLM Models and Configuration
2+
3+
<p className="subtitle">This page will help you explore and learn about all the LLM models and their configuratiojns that are supported on Cody Enterprise.</p>
4+
5+
Sourcegraph Enterprise supports many different LLM providers and models. You can use state of the art code completion models such as Anthropic's Claude or OpenAI's ChatGPT by adjusting your Sourcegraph instance's configuration.
6+
7+
Refer to the [Model Configuration](/cody/clients/model-configuration) or [Supported Models](/cody/capabilities/supported-models) sections for more information.
8+
Use the drop-down menu to make your desired selection and get a detailed breakdown of the supported LLM models for each provider on Cody Enterprise.
9+
10+
<FeatureParity type='ent' />
11+
For the supported LLM models listed above refer to the following notes:
12+
13+
1. Microsoft Azure is planning to deprecate the APIs used in SG version less than `5.3.3` on July 1, 2024 [Source](https://learn.microsoft.com/en-us/azure/ai-services/openai/api-version-deprecation)
14+
2. Claude 2.1 is not recommended
15+
3. Sourcegraph doesn't recommend GPT-4 non-turbo, Claude 1 or 2 models
16+
4. Only supported through legacy completions API
17+
5. BYOK with managed services are only supported for Self-hosted Sourcegraph instances
18+
6. GPT-4 and GPT-4o for completions has a bug that is resulting in many failed completions
19+
20+
### Supported model configuration
21+
22+
Use the drop-down menu to make your desired selection and get a detailed breakdown of the supported model configuration for each provider on Cody Enterprise. This is an on-site configuration. Admins should pick a value from the table for `chatModel` to configure their chat model.
23+
24+
<FeatureParity type='configuration' />
25+
26+
For the supported LLM model configuration listed above refer to the following notes:
27+
28+
1. Microsoft Azure is planning to deprecate the APIs used in SG version less than `5.3.3` on July 1, 2024 [Source](https://learn.microsoft.com/en-us/azure/ai-services/openai/api-version-deprecation)
29+
2. Claude 2.1 is not recommended
30+
3. Sourcegraph doesn't recommend GPT-4 non-turbo, Claude 1 or 2 models
31+
4. Only supported through legacy completions API
32+
5. BYOK with managed services are only supported for Self-hosted Sourcegraph instances

‎src/components/Logo.tsx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ export function Logo(props: React.ComponentPropsWithoutRef<'svg'>) {
55
<>
66
<img
77
className="hidden h-[23px] w-[190px] dark:block"
8-
src={`${basePath}/logo-theme-dark.svg`}
8+
src={`/docs/logo-theme-dark.svg`}
99
alt="Sourcegraph Docs"
1010
/>
1111
<img
1212
className="block h-[23px] w-[190px] dark:hidden"
13-
src={`${basePath}/logo-theme-light.svg`}
13+
src={`/docs/logo-theme-light.svg`}
1414
alt="Sourcegraph Docs"
1515
/>
1616
</>

‎src/data/navigation.ts‎

Lines changed: 110 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -24,62 +24,123 @@ export type VersionNavigations = Record<string, NavigationItem[]>;
2424

2525
export const navigation: NavigationItem[] = [
2626
{
27-
separator: "Code Intelligence",
27+
separator: "Cody",
2828
topics: [
2929
{
30-
title: "Cody",
30+
title: "Introduction",
3131
href: "/cody",
3232
sections: [
3333
{ title: "Quickstart", href: "/cody/quickstart" },
34-
{
35-
title: "Installation", href: "/cody/clients",
36-
subsections: [
37-
{ title: "Cody for VS Code", href: "/cody/clients/install-vscode", },
38-
{ title: "Cody for JetBrains", href: "/cody/clients/install-jetbrains", },
39-
{ title: "Cody for Web", href: "/cody/clients/cody-with-sourcegraph", },
40-
{ title: "Cody for CLI", href: "/cody/clients/install-cli", },
41-
{ title: "Cody for Enterprise", href: "/cody/clients/enable-cody-enterprise", },
42-
{ title: "Model Configuration", href: "/cody/clients/model-configuration", },
43-
]
44-
},
45-
{
46-
title: "Capabilities", href: "/cody/capabilities",
47-
subsections: [
48-
{ title: "Chat", href: "/cody/capabilities/chat", },
49-
{ title: "Autocomplete", href: "/cody/capabilities/autocomplete", },
50-
{ title: "Prompts & Commands", href: "/cody/capabilities/commands", },
51-
{ title: "OpenCtx", href: "/cody/capabilities/openctx", },
52-
{ title: "Debug Code", href: "/cody/capabilities/debug-code", },
53-
{ title: "Context Filters", href: "/cody/capabilities/ignore-context", },
54-
{ title: "Proxy Setup", href: "/cody/capabilities/proxy-setup", },
55-
{ title: "Supported Models", href: "/cody/capabilities/supported-models", },
56-
{ title: "Feature Parity Reference", href: "/cody/clients/feature-reference", },
57-
]
58-
},
59-
{
60-
title: "Core Concepts", href: "/cody/core-concepts/context",
61-
subsections: [
62-
{ title: "Context", href: "/cody/core-concepts/context", },
63-
{ title: "Token Limits", href: "/cody/core-concepts/token-limits", },
64-
// { title: "Embeddings", href: "/cody/core-concepts/embeddings", },
65-
{ title: "Keyword Search", href: "/cody/core-concepts/keyword-search", },
66-
// { title: "Code Graph", href: "/cody/core-concepts/code-graph", },
67-
{ title: "Cody Gateway", href: "/cody/core-concepts/cody-gateway", },
68-
{ title: "Enterprise Architecture", href: "/cody/core-concepts/enterprise-architecture", },
69-
]
70-
},
71-
// {
72-
// title: "Use Cases", href: "/cody/use-cases/generate-unit-tests",
73-
// subsections: [
74-
// { title: "Generate Unit Tests", href: "/cody/use-cases/generate-unit-tests", },
75-
// // { title: "Build UI", href: "/cody/use-cases/build-ui", },
76-
// ]
77-
// },
78-
{ title: "Usage and Pricing", href: "/cody/usage-and-pricing" },
79-
{ title: "Troubleshooting", href: "/cody/troubleshooting" },
80-
{ title: "FAQs", href: "/cody/faq" },
8134
],
8235
},
36+
{
37+
title: "Cody for Admins",
38+
href: "/cody/enterprise",
39+
sections: [
40+
{ title: "Get Started", href: "/cody/clients/enable-cody-enterprise" },
41+
{ title: "Configuring Cody", href: "/cody/enterprise/configure-cody" },
42+
{ title: "LLM Models & Configurations", href: "/cody/enterprise/llm-models" },
43+
{ title: "Enterprise Architecture", href: "/cody/core-concepts/enterprise-architecture" },
44+
45+
],
46+
},
47+
{
48+
title: "Cody for Users",
49+
href: "/clients",
50+
sections: [
51+
{ title: "VS Code", href: "/cody/clients/install-vscode" },
52+
{ title: "JetBrains", href: "/cody/clients/install-jetbrains" },
53+
{ title: "Web", href: "/cody/clients/cody-with-sourcegraph" },
54+
],
55+
},
56+
{
57+
title: "Features",
58+
href: "/capabilities",
59+
sections: [
60+
{ title: "Chat", href: "/cody/capabilities/chat" },
61+
{ title: "Autocomplete", href: "/cody/capabilities/autocomplete" },
62+
{ title: "Prompts & Commands", href: "/cody/capabilities/commands" },
63+
{ title: "Debug Code", href: "/cody/capabilities/debug-code" },
64+
{ title: "Context", href: "/cody/core-concepts/context" },
65+
{ title: "Cody CLI", href: "/cody/clients/install-cli" },
66+
{ title: "OpenCtx", href: "/cody/capabilities/openctx" },
67+
],
68+
},
69+
{
70+
title: "Cody at a Glance",
71+
href: "/cody",
72+
sections: [
73+
{ title: "Feature Parity Matrix", href: "/cody/clients/feature-reference" },
74+
{ title: "Supported LLM Models", href: "/cody/capabilities/supported-models" },
75+
{ title: "Token Limits", href: "/cody/core-concepts/token-limits" },
76+
],
77+
},
78+
{ title: "Usage and Pricing", href: "/cody/usage-and-pricing" },
79+
{ title: "Troubleshooting", href: "/cody/troubleshooting" },
80+
{ title: "FAQs", href: "/cody/faq" },
81+
],
82+
},
83+
84+
// {
85+
// separator: "Cody",
86+
// topics: [
87+
// {
88+
// title: "Introduction",
89+
// href: "/cody",
90+
// sections: [
91+
// { title: "QuickStart", href: "/code-search/features" },
92+
// {
93+
// title: "Cody for Admins", href: "/code-search/queries",
94+
// subsections: [
95+
// { title: "Get Started", href: "/code-search/working/search_filters", },
96+
// { title: "Configuring Cody", href: "/code-search/queries/examples", },
97+
// { title: "LLM Models & Configurations", href: "/code-search/types/symbol", },
98+
// { title: "Enterprise Architecture", href: "/code-search/queries/language", },
99+
// ]
100+
// },
101+
// {
102+
// title: "Cody for Users", href: "/code-search/queries",
103+
// subsections: [
104+
// { title: "Cody Clients", href: "/code-search/working/search_filters", },
105+
// ]
106+
// },
107+
// {
108+
// title: "Features", href: "/code-search/code-navigation",
109+
// subsections: [
110+
// { title: "Chat", href: "/code-search/code-navigation/features", },
111+
// { title: "Autocomplete", href: "/code-search/code-navigation/search_based_code_navigation", },
112+
// { title: "Prompts & Commands", href: "/code-search/code-navigation/precise_code_navigation", },
113+
// { title: "Debug Code", href: "/code-search/code-navigation/writing_an_indexer", },
114+
// { title: "Context", href: "/code-search/code-navigation/auto_indexing", },
115+
// { title: "OpenCtx", href: "/code-search/code-navigation/envvars", },
116+
// { title: "Cody CLI", href: "/code-search/code-navigation/troubleshooting", },
117+
// ]
118+
// },
119+
// {
120+
// title: "Resources", href: "/code-search/working/saved_searches",
121+
// subsections: [
122+
// { title: "Feature Parity Matrix", href: "/code-search/types/fuzzy", },
123+
// { title: "Token Limits", href: "/code-search/working/search_contexts", },
124+
// { title: "Supported LLM Models", href: "/code-search/types/search-jobs", },
125+
// ]
126+
// },
127+
// {
128+
// title: "Usage & Pricing", href: "/code-search/faq",
129+
// },
130+
// {
131+
// title: "Troubleshooting", href: "/code-search/faq",
132+
// },
133+
// {
134+
// title: "FAQs", href: "/code-search/faq",
135+
// },
136+
// ],
137+
// },
138+
// ],
139+
// },
140+
141+
{
142+
separator: "Code Search",
143+
topics: [
83144
{
84145
title: "Code Search",
85146
href: "/code-search",

0 commit comments

Comments
 (0)