Skip to content

docs: reorganize executor administration and deployment guidance#1818

Merged
DaedalusG merged 11 commits into
mainfrom
wg/plat/executors-docs-overhaul
Jul 22, 2026
Merged

docs: reorganize executor administration and deployment guidance#1818
DaedalusG merged 11 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 22, 2026 11:04pm

Request Review

Comment thread docs/admin/executors/index.mdx Outdated
Comment thread docs/agentic-batch-changes/index.mdx Outdated
Comment thread docs/batch-changes/server-side.mdx Outdated
@bobheadxi
bobheadxi requested a review from a team July 18, 2026 00:02
Comment thread docs/batch-changes/how-src-executes-a-batch-spec.mdx
DaedalusG and others added 3 commits July 22, 2026 15:43
Co-authored-by: Robert Lin <robert@bobheadxi.dev>
Co-authored-by: Robert Lin <robert@bobheadxi.dev>
…s-overhaul

# Conflicts:
#	docs/self-hosted/executors/deploy-executors-kubernetes.mdx
#	docs/self-hosted/executors/executors-troubleshooting.mdx
@DaedalusG

Copy link
Copy Markdown
Contributor Author

Encorperated changes from #1820

@DaedalusG
DaedalusG merged commit b58be29 into main Jul 22, 2026
2 checks passed
@DaedalusG
DaedalusG deleted the wg/plat/executors-docs-overhaul branch July 22, 2026 23:06
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.

3 participants