Merge branch 'main' into main

zahidalidev · web-flow · commit c0775ddec7a1 · 2024-10-09T20:46:42.000+05:00
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Sourcegraph Docs
 
-<!-- Working branch for September 2024 Release -->
+<!-- Working branch for October 2024 Release -->
 
 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.
 
diff --git a/docs.config.js b/docs.config.js
@@ -1,5 +1,5 @@
 const config = {
-	DOCS_LATEST_VERSION: '5.7'
+	DOCS_LATEST_VERSION: '5.8'
 };
 
 module.exports = config;
diff --git a/docs/CHANGELOG.mdx b/docs/CHANGELOG.mdx
diff --git a/docs/admin/code_hosts/aws_codecommit.mdx b/docs/admin/code_hosts/aws_codecommit.mdx
@@ -87,6 +87,24 @@ To add CodeCommit repositories in Docker Container:
 1. Follow the rest of the steps detailed in the [AWS SSH setup guide](https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-ssh-unixes.html) to make sure you can connect to the code host locally.
 1. Confirm you have the connection by running the following ssh command locally: `ssh git-codecommit.us-west-1.amazonaws.com` (Update link with your server region)
 1. Confirm you can clone the repository locally.
+
+### Configuring SSH credentials in the Web UI
+
+```json
+{
+  "gitURLType": "ssh",
+  "gitSSHKeyID": "<SSH key ID>",
+  "gitSSHCredential": {
+    // make sure the key is base64 encoded
+    // $ cat ~/.ssh/id_rsa | base64
+    "privateKey": "<base64 encoded of the SSH private key>",
+    "passphrase": "<passphrase if applicable, omit if none is needed>"
+  }
+}
+```
+
+### Mounting SSH keys into the container
+
 1. Copy all the files at your `$HOME/.ssh directory` to `$HOME/.sourcegraph/config/ssh` directory. See [docs](/admin/deploy/docker-single-container/#ssh-authentication-config-keys-knownhosts) for more information about our ssh file system.
     1. Read our [guide here](/admin/deploy/docker-compose/#git-ssh-configuration) for Docker Compose deployments
     1. Read our [guide here](/admin/deploy/kubernetes/configure#ssh-for-cloning) for Kubernetes deployments
diff --git a/docs/admin/repo/auth.mdx b/docs/admin/repo/auth.mdx
@@ -4,16 +4,47 @@ If authentication (HTTP(S) or SSH) is required to `git clone` a repository then
 
 First, ensure your **Site admin > Manage code hosts** code host configuration is configured to use SSH. For example, by setting the `gitURLType` field to "ssh". Alternatively, you may use the "Generic Git host" code host type, which allows you to directly specify Git repository URLs for cloning.
 
-Then, follow the directions below depending on your deployment type:
+Then, you need to supply the SSH keys and passphrase to Sourcegraph if applicable. You have two options:
+
+- **Option 1**: Configure the SSH credentials in code host configuration in the Web UI. (Recommended)
+- **Option 2**: Mount the SSH keys into the container.
+
+## Configuring SSH credentials in the Web UI (Recommended)
+
+In supported code hosts configuration, you can provide the credentials in the JSON configuration. For example:
+
+```json
+{
+  "url": "https://github.com",
+  "token": "<personal access token>",
+  "gitURLType": "ssh",
+  "gitSSHCredential": {
+    // make sure the key is base64 encoded
+    // $ cat ~/.ssh/id_rsa | base64
+    "privateKey": "<base64 encoded of the SSH private key>",
+    "passphrase": "<passphrase if applicable, omit if none is needed>"
+  }
+}
+```
+
+Some providers may require additional configuration, consult the [code host specific documentation](/admin/code_hosts/) for more information.
+
+## Mounting SSH keys into the container
 
 - [Sourcegraph with Docker Compose](/admin/deploy/docker-compose/): See [the Docker Compose git configuration guide](/admin/deploy/docker-compose/#git-configuration).
 - [Sourcegraph with Kubernetes](/admin/deploy/kubernetes/): See [Configure repository cloning via SSH](/admin/deploy/kubernetes/configure#ssh-for-cloning).
 - [Single-container Sourcegraph](/admin/deploy/docker-single-container/): See [the single-container git configuration guide](/admin/deploy/docker-single-container/#git-configuration-and-authentication).
 
->NOTE: Repository access over SSH is not yet supported on [Sourcegraph Cloud](/cloud/).
-
 ## Troubleshooting
 
+### Error: `illegal base64 data at input byte 0`
+
+This error indicates that the provided private key is not base64-encoded. Ensure that the private key is base64-encoded before providing it to Sourcegraph.
+
+```bash
+cat ~/.ssh/id_rsa | base64
+```
+
 ### What should be included in my config file?
 
 We recommend adding the `StrictHostKeyChecking no` and `AddKeysToAgent yes` flags to prevent the need to give permission interactively when cloning from a new host.
diff --git a/docs/cody/clients/feature-reference.mdx b/docs/cody/clients/feature-reference.mdx
@@ -4,35 +4,36 @@
 
 ## Chat
 
-|               **Feature**                | **VS Code** | **JetBrains** |       **Web**        |
-| ---------------------------------------- | ----------- | ------------- | -------------------- |
-| Chat with Cody                           | ✅           | ✅             | ✅                    |
-| Chat history                             | ✅           | ✅             | ✅                    |
-| Clear chat history                       | ✅           | ✅             | ✅                    |
-| Edit sent messages                       | ✅           | ❌             | ✅                    |
-| Show context files                       | ✅           | ✅             | ✅                    |
-| @-file                                   | ✅           | ✅             | ✅                    |
-| @-symbol                                 | ✅           | ❌             | ✅                    |
-| Ollama support (experimental)            | ✅           | ✅             | ❌                    |
-| LLM Selection                            | ✅           | ✅             | ✅                    |
-| **Context Selection**                    |             |               |                      |
-| Single-repo context                      | ✅           | ✅             | ✅                    |
-| Multi-repo context                       | ❌           | ❌             | ✅ (public code only) |
-| Local context                            | ✅           | ✅             | ❌                    |
-| OpenCtx context providers (experimental) | ✅           | ❌             | ❌                    |
+|               **Feature**                | **VS Code** | **JetBrains** |       **Web**        | **CLI** |
+| ---------------------------------------- | ----------- | ------------- | -------------------- | ------- |
+| Chat with Cody                           | ✅           | ✅             | ✅                    | ✅      |
+| Chat history                             | ✅           | ✅             | ✅                    | ❌      | 
+| Clear chat history                       | ✅           | ✅             | ✅                    | ❌      |
+| Edit sent messages                       | ✅           | ❌             | ✅                    | ❌      |
+| Show context files                       | ✅           | ✅             | ✅                    | ❌      |
+| @-file                                   | ✅           | ✅             | ✅                    | ❌      |
+| @-symbol                                 | ✅           | ❌             | ✅                    | ❌      |
+| Ollama support (experimental)            | ✅           | ✅             | ❌                    | ❌      |
+| LLM Selection                            | ✅           | ✅             | ✅                    | ❌      |
+| **Context Selection**                    |             |               |                      |         |
+| Single-repo context                      | ✅           | ✅             | ✅                    | ❌      |
+| Multi-repo context                       | ❌           | ❌             | ✅ (public code only) | ❌      |
+| Local context                            | ✅           | ✅             | ❌                    | ✅      |
+| OpenCtx context providers (experimental) | ✅           | ❌             | ❌                    | ❌      |
 | **Prompts and Commands**                 |             |               |                      |
-| Access to prompts and Prompt library     | ✅           | ✅             | ✅                    |
-| Custom commands                          | ✅           | ❌             | ❌                    |
-| Edit code                                | ✅           | ✅             | ❌                    |
-| Generate unit test                       | ✅           | ✅             | ❌                    |
-| Ask Cody to Fix                          | ✅           | ✅             | ❌                    |
+| Access to prompts and Prompt library     | ✅           | ✅             | ✅                    | ❌      |
+| Custom commands                          | ✅           | ❌             | ❌                    | ❌      |
+| Edit code                                | ✅           | ✅             | ❌                    | ❌      |
+| Generate unit test                       | ✅           | ✅             | ❌                    | ❌      |
+| Ask Cody to Fix                          | ✅           | ✅             | ❌                    | ❌      |
 
 ## Code Autocomplete
 
 |                  **Feature**                  | **VS Code** | **JetBrains** |
 | --------------------------------------------- | ----------- | ------------- |
 | Single and multi-line autocompletion          | ✅           | ✅             |
 | Cycle through multiple completion suggestions | ✅           | ✅             |
+| Accept suggestions word-by-word               | ✅           | ❌             |
 | Ollama support (experimental)                 | ✅           | ❌             |
 
 Few exceptions that apply to Cody Pro and Cody Enterprise users:
diff --git a/docs/cody/core-concepts/cody-gateway.mdx b/docs/cody/core-concepts/cody-gateway.mdx
@@ -6,6 +6,10 @@
 
 Sourcegraph Cody Gateway powers the default `"provider": "sourcegraph"` and Cody completions for Sourcegraph Enterprise users. It supports a variety of upstream LLM providers, such as [Anthropic](https://www.anthropic.com/) and [OpenAI](https://openai.com/), with rate limits, quotas, and model availability tied to your Sourcegraph Enterprise subscription.
 
+## Supported Models
+
+See our page on [Supported LLMs](/cody/capabilities/supported-models) for a current list of supported models and providers.
+
 ## Using Cody Gateway in Sourcegraph Enterprise
 
 To enable completions provided by Cody Gateway on your Sourcegraph Enterprise instance, make sure your license key is set, and Cody is enabled in your [site configuration](/admin/config/site_config):
@@ -14,6 +18,9 @@ To enable completions provided by Cody Gateway on your Sourcegraph Enterprise in
 {
   "licenseKey": "<...>",
   "cody.enabled": true,
+  "completions": {
+    "provider": "sourcegraph"
+  }
 }
 ```
 
@@ -27,25 +34,6 @@ Cody Gateway is hosted at `cody-gateway.sourcegraph.com`. To use Cody Gateway, y
 
 <Callout type="warning">Sourcegraph Cody Gateway access must be included in your Sourcegraph Enterprise subscription. You can verify it by checking it with your account manager. If you are a [Sourcegraph Cloud](/cloud/) user, Cody is enabled by default on your instance starting with Sourcegraph 5.1.</Callout>
 
-## Configuring custom models
-
-To configure custom models for various Cody configurations (for example, `"completions"`), specify the desired model with the upstream provider as a prefix to the name of the model. For example, to use the `claude-2` model from Anthropic, you would configure:
-
-```json
-{
-  "completions": { "chatModel": "anthropic/claude-2.0" },
-}
-```
-
-The currently supported upstream providers for models are:
-
-- [`anthropic/`](https://www.anthropic.com/)
-- [`openai/`](https://openai.com/)
-
-For Sourcegraph Enterprise customers, model availability depends on your Sourcegraph Enterprise subscription.
-
-<Callout type="warning">When using OpenAI models for completions, only chat completions will work - code completions are currently unsupported.</Callout>
-
 ## Rate limits and quotas
 
 Rate limits, quotas, and model availability are tied to your Sourcegraph Enterprise license for Sourcegraph Enterprise instances.
@@ -62,6 +50,4 @@ In addition to the above, we may throttle concurrent requests to Cody Gateway pe
 
 Sourcegraph Cody Gateway does not retain sensitive data (prompt test and source code included in requests, etc.) from any traffic received. Only rate limit consumption per Sourcegraph Enterprise license and some high-level diagnostic data (error codes from upstream, numeric/enum request parameters, etc) are tracked.
 
-The code that powers Cody Gateway is also [source-available](https://sourcegraph.com/search?q=context:global+repo:%5Egithub%5C.com/sourcegraph/sourcegraph$+f:cmd/cody-gateway+lang:go&patternType=keyword&groupBy=path) for audit.
-
 For more details about Cody Gateway security practices, please reach out to your account manager. You can also refer to the [Cody usage and privacy notice](https://about.sourcegraph.com/terms/cody-notice) for more privacy details about Cody in general.
diff --git a/docs/cody/troubleshooting.mdx b/docs/cody/troubleshooting.mdx
@@ -73,7 +73,7 @@ On the free plan, Cody provides **unlimited autocomplete suggestions** and **200
 
 On the Pro and Enterprise plans, there are much higher limits that are used to keep our services operational. These limits reset within a day.
 
-### Error logging in VS Code on Linux
+### Error logging in VS Code on Linux and Windows
 
 If you encounter difficulties logging in to Cody on Linux using your Sourcegraph instance URL, along with a valid access token, and notice that the sign-in process in VS Code hangs, it might be related to underlying networking rules concerning SSL certificates.
 
@@ -83,6 +83,12 @@ To address this, follow these steps:
 - In your terminal, type and run the following command: `echo "export NODE_TLS_REJECT_UNAUTHORIZED=0">> ~/.bashrc`
 - Restart VS Code and try the sign in process again
 
+On Windows,
+
+- Close Visual Studio Code
+- In your Command Prompt or PowerShell window, run the following command: `setx NODE_TLS_REJECT_UNAUTHORIZED 0`
+- Restart Visual Studio Code and try the sign in process again
+
 ### Error exceeding `localStorage` quota
 
 When using Cody chat, you may come across this error:
@@ -168,3 +174,18 @@ If you notice the Cody agent reaching 100% CPU utilization, try the following:
 1. Disable the Cody plugin.
 1. Re-enable the plugin.
 This simple action of turning the plugin off and on again can often resolve the high CPU usage issue.
+
+
+
+## Android Studio extension
+
+### Cody cannot start. Stuck on spinning icon.
+
+This issue occurs because JCEF isn't supported in Android Studio and causes Cody not to start. The suggested workaround is to;
+
+1. Go to `Help` > `Find Action: Registry`.
+1. Scroll to `ide.browser.jcef.sandbox.enable`.
+1. Disable that key and close.
+1. Then go to `Help` > `Find Action: Choose Boot runtime for the IDE`.
+1. Select the last option.
+1. Restart Android Studio.
diff --git a/docs/legacy.mdx b/docs/legacy.mdx
@@ -4,6 +4,7 @@
 
 <Accordion title="Sourcegraph 5.X">
 
+  - [5.7](https://5.7.sourcegraph.com/)
   - [5.6](https://5.6.sourcegraph.com/)
   - [5.5](https://5.5.sourcegraph.com/)
   - [5.4](https://5.4.sourcegraph.com/docs)
diff --git a/src/data/versions.ts b/src/data/versions.ts
@@ -15,8 +15,8 @@ export const versions: VersionI[] = [
         url: '/',
     },
     {
-        name: 'v5.6',
-        url: 'https://5.6.sourcegraph.com/'
+        name: 'v5.7',
+        url: 'https://5.7.sourcegraph.com/'
     },
 ];
 
