Merge branch 'main' into revamp-cody-docs

MaedahBatool · web-flow · commit 515509ed6b73 · 2024-09-26T12:33:25.000-04:00
diff --git a/docs/CHANGELOG.mdx b/docs/CHANGELOG.mdx
@@ -4,6 +4,39 @@ All notable changes to Sourcegraph are documented in this file.
 
 {/* CHANGELOG_START */}
 
+# v5.7.2474
+
+### Fix
+
+#### Batch Changes
+
+- workaround for a bug in GitHub [#584](https://github.com/sourcegraph/sourcegraph/pull/584)
+  - fix(batches): workaround for a bug in GitHub
+  Backport aad3a04f8c93561a61c404e69132e70a22d0acba from #576
+
+#### Release
+
+- remove the other embedding reference [#362](https://github.com/sourcegraph/sourcegraph/pull/362)
+  - n/a
+
+#### Search
+
+- remove query expansion [#586](https://github.com/sourcegraph/sourcegraph/pull/586)
+  - This fixes a bug where we added &quot;readme&quot; too often to the context.    Backport 28ff196a663f537c6cb6340f976a91431509a90e from #582
+
+### Reverts
+
+  There were no reverts for this release
+
+### Uncategorized
+
+#### Others
+
+- [Backport 5.7.x] Search: allow queries with only lang filters [#583](https://github.com/sourcegraph/sourcegraph/pull/583)
+
+{/* RSS={"version":"v5.7.2474", "releasedAt": "2024-09-18"} */}
+
+
 # v5.7.0
 
 ### Features
diff --git a/docs/admin/auth/index.mdx b/docs/admin/auth/index.mdx
@@ -89,7 +89,7 @@ Then add the following lines to your site configuration:
       "clientSecret": "replace-with-the-oauth-client-secret",
       "allowSignup": false,  // CAUTION: Set to true to enable signup. If nothing is specified in `allowOrgs` or `allowOrgsMap`, any GitHub user can sign up.
       "allowOrgs": ["your-org-name"], // Restrict logins and sign-ups if enabled to members of these orgs.
-      "allowOrgsMap": { "orgName": ["your-team-name"]} // Restrict logins and sign-ups if enabled to members of teams that belong to a given org.
+      "allowOrgsMap": { "orgName": ["Your Team Name"]} // Restrict logins and sign-ups if enabled to members of teams that belong to a given org.
     }
   ]
 }
@@ -154,15 +154,20 @@ When combined with `"allowSignup": false` or unset, an admin should first create
 
   Note that subteams inheritance is not supported — the name of child teams (subteams) should be informed so their members can be granted access to Sourcegraph.
 
+  When configuring teams in allowOrgsMap, use the team's display name. If the team names do not match exactly, users will be unable to create an account.
+
   ```json
     {
        "type": "github",
       // ...
       "allowOrgsMap": {
         "org1": [
-          "team1", "subteam1"
+          "Your Team Name"
         ],
         "org2": [
+          "team1", "subteam1"
+        ],
+        "org3": [
           "subteam2"
         ]
       }
diff --git a/docs/cli/explanations/env.mdx b/docs/cli/explanations/env.mdx
@@ -22,7 +22,7 @@ If the environment variable is not set, it'll default to "https://sourcegraph.co
 
 To create an access token, please refer to "[Creating an access token](/cli/how-tos/creating_an_access_token)".
 
-## Adding request headers with `SRC_HEADER_`
+## Adding request headers with `SRC_HEADER_` (Proxy Authentication with `src`)
 
 If your instance is behind an authenticating proxy that requires additional headers, they can be supplied via environment variables. Any environment variable passed starting with the string `SRC_HEADER_{string-A}="String-B"` will be passed into the request with form `String-A: String-B`. See examples below:
 
diff --git a/docs/cloud/private_connectivity_sourcegraph_connect.mdx b/docs/cloud/private_connectivity_sourcegraph_connect.mdx
@@ -32,6 +32,8 @@ Tunnel client: forward proxy clients managed by sourcegraph. Every client has it
 Customer should reach out to their account manager to initiate the process. The account manager will work with the customer to collect the required information and initiate the process, including but not limited to:
 
 - The DNS name of the private code host, e.g. `gitlab.internal.company.net` or private artifact registry, e.g. `artifactory.internal.company.net`.
+- The port of the private code host, e.g., `443`, `80`, `22`.
+- The type of the TLS certificate used by the private resource, one of self-signed by internal private CA, or issued by a public CA.
 
 Finally, Sourcegraph will provide the following:
 
diff --git a/docs/cody/capabilities/index.mdx b/docs/cody/capabilities/index.mdx
@@ -27,6 +27,6 @@ Learn more about each by exploring their respective documentation:
 
 <QuickLink title="Debug Code" icon='presets' href="/cody/capabilities/debug-code" description="Identify and fix code errors and bugs." />
 
-<QuickLink title="Cody Ignore" icon='presets' href="/cody/capabilities/ignore-context" description="Cody can ignore selected files or folders from chat and autocomplete results." />
+<QuickLink title="Cody Context Filters" icon='presets' href="/cody/capabilities/ignore-context" description="Cody helps you filter context based on a set of exclude and include rules." />
 
 </QuickLinks>
diff --git a/docs/cody/faq.mdx b/docs/cody/faq.mdx
@@ -46,6 +46,10 @@ Cody supports a wide range of programming languages, including JavaScript, TypeS
 
 Cody's response quality on a programming language depends on many factors, including the underlying LLM being used. We monitor accuracy metrics across all languages and regularly make improvements. [Let us know](https://community.sourcegraph.com/) if you're seeing poor quality on a particular programming language.
 
+### Can Cody answer non-programming questions?
+
+Cody Chat is optimized for coding related use cases and can be used primarily for reviewing, analysis, testing, writing, and editing of software code. Use of Cody for any other purposes is against our [acceptable use policy](https://sourcegraph.com/terms/aup) and may result in your account being restricted. 
+
 ### What happened to the Cody App?
 
 We’ve deprecated the Cody App to streamline the experience for our Cody Free and Cody Pro users. Now, anyone with a Sourcegraph.com account can generate local embeddings for their personal projects within the VS Code extension without downloading and connecting the Cody App. Local embeddings are only supported for VS Code, but we’re working on adding the same functionality to JetBrains IDEs.
@@ -110,3 +114,13 @@ Yes, Cody supports the following cloud development environments:
 
 - vscode.dev and GitHub Codespaces (install from the VS Code extension marketplace)
 - Any editor supporting the [Open VSX Registry](https://open-vsx.org/extension/sourcegraph/cody-ai), including [Gitpod](https://www.gitpod.io/blog/boosting-developer-productivity-unleashing-the-power-of-sourcegraph-cody-in-gitpod), Coder, and `code-server` (install from the [Open VSX Registry](https://open-vsx.org/extension/sourcegraph/cody-ai))
+
+### Can I use my LLM of preference to chat with Cody on CLI?
+
+Yes you can. In the CLI you can use the following command to get started. Please replace `$name_of_the_model` with the LLM model of your choice.
+
+```
+cody chat --model '$name_of_the_model' -m 'Hi Cody!'
+```
+
+For example, to use Claude 3.5 Sonnet, you'd pass the following command in your terminal, `cody chat --model 'claude-3.5-sonnet' -m 'Hi Cody!'
diff --git a/docs/releases.mdx b/docs/releases.mdx
@@ -12,10 +12,11 @@ Currently supported versions of Sourcegraph:
 
 | **Release**                     | **General Availability Date** | **Supported** | **Release Notes**                                        | **Install**                                          |
 |---------------------------------|-------------------------------|---------------|----------------------------------------------------------|------------------------------------------------------|
-| 5.7         | September 2024                | ✅             | [Notes](https://sourcegraph.com/docs/CHANGELOG#v570)     | [Install](https://sourcegraph.com/docs/admin/deploy) |
-| 5.6.2 | August 2024                   | ✅             | [Notes](https://sourcegraph.com/docs/CHANGELOG#v562535)  | [Install](https://sourcegraph.com/docs/admin/deploy) |
-| 5.6.1 | August 2024                   | ✅             | [Notes](https://sourcegraph.com/docs/CHANGELOG#v56185)   | [Install](https://sourcegraph.com/docs/admin/deploy) |
-| 5.6         | August 2024                   | ✅             | [Notes](https://sourcegraph.com/docs/CHANGELOG#v560)     | [Install](https://sourcegraph.com/docs/admin/deploy) |
+| Sourcegraph 5 Release 7 Patch 1 | September 2024                | ✅             | [Notes](https://sourcegraph.com/docs/CHANGELOG#v572474)  | [Install](https://sourcegraph.com/docs/admin/deploy) |
+| Sourcegraph 5 Release 7         | September 2024                | ✅             | [Notes](https://sourcegraph.com/docs/CHANGELOG#v570)     | [Install](https://sourcegraph.com/docs/admin/deploy) |
+| Sourcegraph 5 Release 6 Patch 2 | August 2024                   | ✅             | [Notes](https://sourcegraph.com/docs/CHANGELOG#v562535)  | [Install](https://sourcegraph.com/docs/admin/deploy) |
+| Sourcegraph 5 Release 6 Patch 1 | August 2024                   | ✅             | [Notes](https://sourcegraph.com/docs/CHANGELOG#v56185)   | [Install](https://sourcegraph.com/docs/admin/deploy) |
+| Sourcegraph 5 Release 6         | August 2024                   | ✅             | [Notes](https://sourcegraph.com/docs/CHANGELOG#v560)     | [Install](https://sourcegraph.com/docs/admin/deploy) |
 | 5.5                             | July 2024                     | ✅             | [Notes](https://sourcegraph.com/docs/CHANGELOG#v553956)  | [Install](https://sourcegraph.com/docs/admin/deploy) |
 | 5.4                             | May 2024                      | ✅             | [Notes](https://sourcegraph.com/docs/CHANGELOG#v547765)  | [Install](https://sourcegraph.com/docs/admin/deploy) |
 | 5.3                             | February 2024                 | ✅             | [Notes](https://sourcegraph.com/docs/CHANGELOG#v5312303) | [Install](https://sourcegraph.com/docs/admin/deploy) |
diff --git a/src/components/MdxComponents.tsx b/src/components/MdxComponents.tsx
@@ -11,6 +11,7 @@ import { QuickLink, QuickLinks } from './mdx/QuickLinks';
 import { Tab, Tabs } from './mdx/Tabs';
 import { PreCodeBlock } from './PreCodeBlock';
 import ResourceEstimator from './resource-estimator/ResourceEstimator';
+import { Badge } from './ui/badge';
 
 const MdxComponents = (version?: string) => {
 	return {
@@ -62,7 +63,8 @@ const MdxComponents = (version?: string) => {
 			<div {...props} className="table-auto w-full overflow-x-auto">
 				<table>{props.children}</table>
 			</div>
-		)
+		),
+		Badge
 	};
 };
 
diff --git a/src/components/ui/badge.tsx b/src/components/ui/badge.tsx
@@ -0,0 +1,60 @@
+import * as React from "react";
+import { cva, type VariantProps } from "class-variance-authority";
+
+import { cn } from "@/lib/utils";
+
+const badgeVariants = cva(
+  "inline-flex items-center rounded-full border px-2.5 py-0.5 text-xs font-semibold transition-colors focus:outline-none focus:ring-2 focus:ring-ring focus:ring-offset-2",
+  {
+    variants: {
+      variant: {
+        default:
+          "border-transparent bg-primary text-primary-foreground hover:bg-primary/80",
+        secondary:
+          "border-transparent bg-secondary text-secondary-foreground hover:bg-secondary/80",
+        destructive:
+          "border-transparent bg-destructive text-destructive-foreground hover:bg-destructive/80",
+        outline: "text-foreground",
+      },
+    },
+    defaultVariants: {
+      variant: "default",
+    },
+  }
+);
+
+export interface BadgeProps
+  extends React.HTMLAttributes<HTMLDivElement>,
+  VariantProps<typeof badgeVariants> {
+  backgroundColor?: string;
+  textColor?: string;
+  textSize?: "text-xs" | "text-sm" | "text-base" | "text-lg" | "text-xl" | "text-2xl";
+}
+
+function Badge({
+  className,
+  variant,
+  backgroundColor,
+  textColor,
+  textSize = "text-xs",
+  ...props
+}: BadgeProps) {
+  return (
+    <div
+      className={cn(
+        badgeVariants({ variant }),
+        className,
+        backgroundColor,
+        textColor,
+        textSize
+      )}
+      style={{
+        backgroundColor: backgroundColor,
+        color: textColor,
+      }}
+      {...props}
+    />
+  );
+}
+
+export { Badge, badgeVariants };

Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@ Then add the following lines to your site configuration:`
`89`	`89`	`"clientSecret": "replace-with-the-oauth-client-secret",`
`90`	`90`	"allowSignup": false, // CAUTION: Set to true to enable signup. If nothing is specified in `allowOrgs` or `allowOrgsMap`, any GitHub user can sign up.
`91`	`91`	`"allowOrgs": ["your-org-name"], // Restrict logins and sign-ups if enabled to members of these orgs.`
`92`		`- "allowOrgsMap": { "orgName": ["your-team-name"]} // Restrict logins and sign-ups if enabled to members of teams that belong to a given org.`
	`92`	`+ "allowOrgsMap": { "orgName": ["Your Team Name"]} // Restrict logins and sign-ups if enabled to members of teams that belong to a given org.`
`93`	`93`	`}`
`94`	`94`	`]`
`95`	`95`	`}`
@@ -154,15 +154,20 @@ When combined with `"allowSignup": false` or unset, an admin should first create
`154`	`154`
`155`	`155`	`Note that subteams inheritance is not supported — the name of child teams (subteams) should be informed so their members can be granted access to Sourcegraph.`
`156`	`156`
	`157`	`+ When configuring teams in allowOrgsMap, use the team's display name. If the team names do not match exactly, users will be unable to create an account.`
	`158`	`+`
`157`	`159`	```json
`158`	`160`	`{`
`159`	`161`	`"type": "github",`
`160`	`162`	`// ...`
`161`	`163`	`"allowOrgsMap": {`
`162`	`164`	`"org1": [`
`163`		`- "team1", "subteam1"`
	`165`	`+ "Your Team Name"`
`164`	`166`	`],`
`165`	`167`	`"org2": [`
	`168`	`+ "team1", "subteam1"`
	`169`	`+ ],`
	`170`	`+ "org3": [`
`166`	`171`	`"subteam2"`
`167`	`172`	`]`
`168`	`173`	`}`