Merge branch 'main' into ask-ai

Author: MaedahBatool

README.md

@@ -1,7 +1,8 @@
 # Sourcegraph Docs
 
-<!-- Working branch for August Release -->
-<!-- This is the PR to ship AI in docs -->
+
+<!-- Working branch for September 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.
 

docs.config.js

@@ -1,5 +1,5 @@
 const config = {
-	DOCS_LATEST_VERSION: '5.6'
+	DOCS_LATEST_VERSION: '5.7'
 };
 
 module.exports = config;

docs/CHANGELOG.mdx

@@ -1,4 +1,4 @@
 # Webhooks
 
 - [Incoming webhooks](/admin/config/webhooks/incoming)
-- [Outgoing webhooks](/admin/config/webhooks/outgoing) (Beta)
+- [Outgoing webhooks](/admin/config/webhooks/outgoing)

docs/admin/config/webhooks/index.mdx

@@ -1,6 +1,6 @@
 # Outgoing webhooks
 
-<Callout type="note"> This feature is currently in beta and supported on Sourcegraph versions 5.0 or more.</Callout>
+<Callout type="note"> This feature is supported on Sourcegraph versions 5.0 or more.</Callout>
 
 Outgoing webhooks can be configured on a Sourcegraph instance in order to send Sourcegraph events to external tools and services. This allows for deeper integrations between Sourcegraph and other applications.
 

docs/admin/config/webhooks/outgoing.mdx

@@ -1,32 +1,27 @@
 # Administration
 
-Administration is usually handled by site administrators are the admins responsible for deploying, managing, and configuring Sourcegraph for regular users. They have [special privileges](/admin/privileges) on a Sourcegraph instance. Check out this [quickstart guide](/admin/how-to/site-admin-quickstart) for more info on Site Administration.
+Sourcegraph administration is primarily managed by site administrators, who are responsible for the deployment, management, and configuration of Sourcegraph instances for end users. For a comprehensive introduction to site administration, refer to our [quickstart guide](/admin/how-to/site-admin-quickstart).
+
 
 ## [Deploy Sourcegraph](/admin/deploy/)
 
+Get started running Sourcegraph on-prem.
+
 - [Deployment overview](/admin/deploy/)
-  - [Kubernetes with Helm](/admin/deploy/kubernetes/)
-  - [See all deployment options](/admin/deploy/#deployment-types)
 - [Best practices](/admin/deployment_best_practices)
-- [Using external services (PostgreSQL, Redis, S3/GCS)](/admin/external_services/)
-- [Deploying Executors](/admin/executors/deploy_executors)
-- [Validation](/admin/validation) (experimental)
+- [Validate a Sourcegraph deployment](/admin/validation) (experimental)
 
 ## [Upgrade Sourcegraph](/admin/updates/)
 
-> NOTE: The Sourcegraph [`migrator`](/admin/updates/migrator/migrator-operations) service can now perform upgrades across [multiple versions](/admin/updates/#multi-version-upgrades) on any instance 3.20 or later.
-
-- [Upgrade Sourcegraph](/admin/updates/)
-  - [Single-minor-version "standard" upgrades](/admin/updates/#standard-upgrades)
-  - [Multi-version upgrades](/admin/updates/#multi-version-upgrades)
-- [Migration guides](/admin/migration/)
+- [Upgrade Overview](/admin/updates/)
+- [Migrate to Sourcegraph](/admin/migration/)
 - [Upgrading PostgreSQL](/admin/postgres#upgrading-postgresql)
 
 ## [Configure Sourcegraph](/admin/config/)
 
 - [Site Administrator Quickstart](/admin/how-to/site-admin-quickstart)
 - [Integrations](/integration/)
-- [Adding Git repositories](/admin/repo/add) (from a code host or clone URL)
+- [Add Git repositories](/admin/repo/add) (from a code host or clone URL)
   - [Monorepo](/admin/monorepo)
   - [Repository webhooks](/admin/repo/webhooks)
 - [HTTP and HTTPS/SSL configuration](/admin/http_https_configuration)

docs/admin/index.mdx

@@ -22,7 +22,7 @@ Sourcegraph releases have three digits, for example: `v5.0.3`
 | minor         | `0`     |
 | patch         | `3`     |
 
-For more details on our release candence, refer to the [Sourcegraph handbook](https://handbook.sourcegraph.com/departments/engineering/dev/process/releases/#sourcegraph-releases).
+For more details on our release cadence, refer to the [Sourcegraph handbook](https://handbook.sourcegraph.com/departments/engineering/dev/process/releases/#sourcegraph-releases).
 
 Generally, we ship a new version of Sourcegraph with new features and bug fixes monthly, followed by a patch release later that month. Major and minor releases happen less frequently and contain substantial changes to Sourcegraph.
 
@@ -44,17 +44,17 @@ Sourcegraph has two upgrade types. **Standard** upgrades and **Multiversion** up
 
 > *Note: Patch versions don't determine upgrade type -- you should always upgrade to the latest patch.*
 
-| From Version | To Version | Upgrade Type | Notes                                |
-|--------------|------------|--------------|--------------------------------------|
-| `v5.0.0`     | `v5.1.0`   | Standard     | A minor version                       |
-| `v5.0.0`     | `v5.2.0`   | Multiversion  | Two minor versions                    |
-| `v3.41.0`    | `v3.42.2`  | Standard     | A minor version and patch version     |
-| `v5.1.0`     | `v5.1.3`   | Standard     | Multiple patch versions     |
+| From Version | To Version | Upgrade Type | Notes                                                |
+|--------------|------------|--------------|------------------------------------------------------|
+| `v5.0.0`     | `v5.1.0`   | Standard     | A minor version                                      |
+| `v5.0.0`     | `v5.2.0`   | Multiversion | Two minor versions                                   |
+| `v3.41.0`    | `v3.42.2`  | Standard     | A minor version and patch version                    |
+| `v5.1.0`     | `v5.1.3`   | Standard     | Multiple patch versions                              |
 | `v3.43.0`    | `v4.0.0`   | Standard     | A major version change but only one absolute version |
-| `v5.0.0`     | `v5.2.2`   | Multiversion  | Two minor versions and patch          |
-| `v3.33.0`    | `v5.2.0`   | Multiversion  | Major and minor                       |
-| `v4.5.0`     | `v5.0.0`   | Standard     | This is a major version but only one version change |
-| `v4.4.2`     | `v5.0.3`   | Multiversion  | Major, minor, and patch               |
+| `v5.0.0`     | `v5.2.2`   | Multiversion | Two minor versions and patch                         |
+| `v3.33.0`    | `v5.2.0`   | Multiversion | Major and minor                                      |
+| `v4.5.0`     | `v5.0.0`   | Standard     | This is a major version but only one version change  |
+| `v4.4.2`     | `v5.0.3`   | Multiversion | Major, minor, and patch                              |
 
 > *Note:*
 > - *Our major releases do not occur on a consistent interval, so make sure to check our changelog if you aren't certain about whether a major version is multiple minor versions away from your current version. You can also reach out to our support team [[email protected]](mailto:[email protected])*
@@ -78,7 +78,7 @@ It is highly recommended to:
 Sourcegraph upgrades take the following general form:
 1. Determine if your instance is ready to Upgrade (check upgrade notes)
 2. Merge the latest Sourcegraph release into your deployment manifests
-3. If updating more than a single minor version, perform an [**automatic multi-version upgrade**]/admin/updates/automatic) if targeting **Sourcegraph 5.1 or later**; [manual multi-verison upgrades]/admin/updates/migrator/migrator-operations) are required if upgrading to an earlier version, which requires shutting off the instance and invoking the `migrator` container or job to perform the database rewrite and application of unfinished out-of-band migrations
+3. If updating more than a single minor version, perform an [**automatic multi-version upgrade**]/admin/updates/automatic) if targeting **Sourcegraph 5.1 or later**; [manual multi-version upgrades]/admin/updates/migrator/migrator-operations) are required if upgrading to an earlier version, which requires shutting off the instance and invoking the `migrator` container or job to perform the database rewrite and application of unfinished out-of-band migrations
 4. With upstream changes to your manifests merged, start the new instance
 
 > Note: For more explicit steps, specific to your deployment see the operations guides linked below.

docs/admin/updates/index.mdx

@@ -2,7 +2,7 @@
 
 <Callout type="note">This feature is in the Experimental stage. Please contact Sourcegraph directly via [prefered contact method](https://about.sourcegraph.com/contact) for more information.</Callout>
 
-As part of the [Enterprise tier](https://sourcegraph.com/pricing), Sourcegraph Cloud supports connecting private resouces on any on-prem private network by running Sourcegraph Connect tunne agent in customer infrastructure.
+As part of the [Enterprise tier](https://sourcegraph.com/pricing), Sourcegraph Cloud supports connecting private resources on any on-prem private network by running Sourcegraph Connect tunnel agent in customer infrastructure.
 
 ## How it works
 

docs/cloud/private_connectivity_sourcegraph_connect.mdx

@@ -71,4 +71,4 @@ Possible errors that can happen during upload include:
 - Unknown repository (404): check your `-endpoint` and make sure you can view the repository on your Sourcegraph instance
 - Invalid commit (404): try visiting the repository at that commit on your Sourcegraph instance to trigger an update
 - Invalid auth when using Sourcegraph.com or when [`lsifEnforceAuth`](/admin/config/site_config#lsifEnforceAuth) is `true` (401 for an invalid token or 404 if the repository cannot be found on GitHub.com): make sure your GitHub token is valid and that the repository is correct
-- Unexpected errors (500s): [file an issue](https://github.com/sourcegraph/sourcegraph/issues/new)
+- Unexpected errors (500s): reach out to your Sourcegraph support team for assistance

docs/code-search/code-navigation/how-to/index_other_languages.mdx

@@ -1,13 +1,25 @@
 # Search Jobs
 
-<p className="subtitle">Use Search Jobs to search code at scale for large-scale organizations.</p>
-
-<Callout type="note" title="Beta"> Search Jobs feature is in Beta stage and only available for Enterprise accounts. It is enabled by default since 5.3.0.</Callout>
+Use Search Jobs to search code at scale for large-scale organizations.
 
 Search Jobs allows you to run search queries across your organization's codebase (all repositories, branches, and revisions) at scale. It enhances the existing Sourcegraph's search capabilities, enabling you to run searches without query timeouts or incomplete results.
 
 With Search Jobs, you can start a search, let it run in the background, and then download the results from the Search Jobs UI when it's done. Site administrators can **enable** or **disable** the Search Jobs feature, making it accessible to all users on the Sourcegraph instance.
 
+## Using Search Jobs
+
+To use Search Jobs, you need to:
+
+- Run a search query from your Sourcegraph instance
+- Click the result menu below the search bar to see if your query is supported by Search Jobs
+
+![run-query-for-search-jobs](https://storage.googleapis.com/sourcegraph-assets/Docs/search-jobs/search-jobs-create.png)
+
+- If your query is valid, click **Create a search job** to initiate the search job
+- You will be redirected to the "Search Jobs UI" page at `/search-jobs`, where you can view all your created search jobs. If you're a site admin, you can also view search jobs from other users on the instance
+
+![view-search-jobs](https://storage.googleapis.com/sourcegraph-assets/Docs/search-jobs/search-jobs-manage.png)
+
 ## Search results format
 
 The downloaded results are formatted as [JSON lines](https://jsonlines.org).
@@ -67,21 +79,6 @@ If you would like to allow your Sourcegraph instance to control the creation and
 
 - `SEARCH_JOBS_UPLOAD_MANAGE_BUCKET=true`
 
-## Using Search Jobs
-
-To use Search Jobs, you need to:
-
-- Run a search query from your Sourcegraph instance
-- Click the result menu below the search bar to see if your query is valid for the long search
-
-![run-query-for-search-jobs](https://storage.googleapis.com/sourcegraph-assets/Docs/query-serach-jobs.png)
-
-- If your query is valid, click **Run search job** to initiate the search job
-- You will be redirected to the "Search Jobs UI" page at `/search-jobs`, where you can view all your created search jobs. If you're a site admin, you can also view search jobs from other users on the instance
-
-![view-search-jobs](https://storage.googleapis.com/sourcegraph-assets/Docs/view-search-jobs.png)
-
-
 ## Supported result types
 
 Search jobs supports the following result types:
@@ -99,20 +96,20 @@ The following result types are not supported:
 The following elements of our query language are not supported:
 
 - file predicates, such as `file:has.content`, `file:has.owner`, `file:has.contributor`, `file:contains.content`
-- `.*` regexp search
+- catch-all `.*` regexp search
 - Multiple `rev` filters
 - Queries with `index: filter`
 
-<Callout type="note">The search bar already supports exhaustive searches with the `count:all` operator. However, these searches are subject to lower timeouts, making them harder to use in large codebases.</Callout>
 
-## Disable Search Jobs
+<Callout type="note">
+    Alternatively, the search bar supports the `count:all` operator which increases result limits and timeouts.
+    This works well if the search completes within a few minutes and the number of results is less than the configured display limit.
+    For longer running searches and searches with huge result sets, Search Jobs is the better choice.
+</Callout>
 
-Follow these steps to disable Search Jobs and to hide the feature in the Sourcegraph UI:
+## Disable Search Jobs
 
-- Login to your Sourcegraph instance and go to the site admin
-- Next, click the site configuration
-- From here, you'll see `experimentalFeatures`
-- Set `searchJobs` to `false` and then refresh the page
+To disable Search Jobs, set `DISABLE_SEARCH_JOBS=true` in your frontend and worker services.
 
 ## FAQ