Skip to content

docs: reorganize executor administration and deployment guidance#1818

Open
DaedalusG wants to merge 6 commits into
mainfrom
wg/plat/executors-docs-overhaul
Open

docs: reorganize executor administration and deployment guidance#1818
DaedalusG wants to merge 6 commits into
mainfrom
wg/plat/executors-docs-overhaul

Conversation

@DaedalusG

Copy link
Copy Markdown
Contributor

Closes PLAT-790

Summary

This reorganizes the executor documentation around a clearer path from administration concepts to infrastructure deployment and ongoing operations.

  • Refocuses admin/executors on executor concepts, Sourcegraph instance setup, authentication, monitoring, secrets, and sandboxing.
  • Turns self-hosted/executors into the deployment entry point, with a concise prerequisite checklist, deployment decision guidance, validation, and links to each supported deployment method.
  • Moves deployment-specific architecture, procedures, configuration, upgrade, and security guidance into the relevant Binary, Docker Compose, Kubernetes, Firecracker, AWS, and Google Cloud pages.
  • Splits private registry configuration, custom certificate configuration, and executor capacity planning into focused pages that are linked from the relevant deployment guides.
  • Removes the ambiguous deploy-executors catch-all page, preserves its useful content in the new structure, and adds redirects for its former URLs.
  • Improves sidebar navigation, in-page indexes, cross-links between administration and deployment content, and links from feature documentation to the appropriate executor guidance.

Testing

  • Tested the updated documentation and navigation locally with npm run dev.

@DaedalusG
DaedalusG requested a review from a team July 17, 2026 07:57
@vercel

vercel Bot commented Jul 17, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
sourcegraph-docs Ready Ready Preview, Comment Jul 17, 2026 7:59am

Request Review

- [Automatically indexing a repository for precise code navigation](/code-navigation/auto-indexing)
- [Running batch changes](/batch-changes/server-side)
- [Automatically index repositories for precise code navigation](/code-navigation/auto-indexing)
- [Run batch changes server-side](/batch-changes/server-side)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [Run batch changes server-side](/batch-changes/server-side)
- [Run batch changes server-side](/batch-changes/server-side), including [Agentic Batch Changes](/agentic-batch-changes)

- [Configure code host connections](/admin/code-hosts) for the repositories you want the agent to search and modify.
- [Configure Batch Changes credentials](/batch-changes/configuring-credentials) for each code host where the agent should publish pull requests or merge requests.
- [Deploy Sourcegraph executors](/self-hosted/executors/deploy-executors) so Agentic Batch Changes can run code-modification jobs in isolated workspaces. Executors are available with no additional setup on [Sourcegraph Cloud](/cloud).
- If you use self-hosted Sourcegraph, [deploy Sourcegraph executors](/self-hosted/executors) so Agentic Batch Changes can run code-modification jobs in isolated workspaces. [Sourcegraph Cloud](/cloud) includes Sourcegraph-managed executors by default, so Cloud customers using them do not need to deploy executor infrastructure.

@bobheadxi bobheadxi Jul 17, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can be in Cloud and have self-hosted executors

Suggested change
- If you use self-hosted Sourcegraph, [deploy Sourcegraph executors](/self-hosted/executors) so Agentic Batch Changes can run code-modification jobs in isolated workspaces. [Sourcegraph Cloud](/cloud) includes Sourcegraph-managed executors by default, so Cloud customers using them do not need to deploy executor infrastructure.
- Ensure [Sourcegraph executors](/admin/executors) are set up so Agentic Batch Changes can run code-modification jobs in isolated workspaces. [Sourcegraph Cloud](/cloud) includes Sourcegraph-managed executors by default, so Cloud customers using them do not need to deploy executor infrastructure. Otherwise, you will need to [deploy Sourcegraph executors](/self-hosted/executors).

@@ -11,7 +11,7 @@

By default, Batch Changes uses a command line interface in your local environment to [compute diffs](/batch-changes/how-src-executes-a-batch-spec) and create changesets. This can be impractical for creating batch changes affecting hundreds or thousands of repositories, with large numbers of workspaces, or if the batch change steps require CPU, memory, or disk resources that are unavailable locally.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this by default statement true anymore? probably not, right? let's update that while we are here

@bobheadxi
bobheadxi requested a review from a team July 18, 2026 00:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants