Skip to content

feat: docs for batch spec library and templates #1244

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

bahrmichael
Copy link
Contributor

@bahrmichael bahrmichael commented Jul 7, 2025

This PR updates the documentation for the batch spec library following the introduction of batch spec templates.

Most notably it

  • gives an explanation of library examples vs templates for admins, along with a new section on how to use variables,
  • restructures the page about creating a batch change to show server side batch changes on the top with info about templates, and moves the info on how to use the src-cli to the bottom,
  • moves info on viewing batch changes into a dedicated page.

For easier reviewing of the new content, I created two PDFs:

Batch Changes site admin configuration reference - Sourcegraph docs.pdf
Creating a Batch Change - Sourcegraph docs.pdf

Pull Request approval

You will need to get your PR approved by at least one member of the Sourcegraph team. For reviews of docs formatting, styles, and component usage, please tag the docs team via the #docs Slack channel.

Copy link

vercel bot commented Jul 7, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sourcegraph-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 7, 2025 0:45am

@bahrmichael bahrmichael marked this pull request as ready for review July 7, 2025 12:45
@bahrmichael bahrmichael requested review from peterguy and aulorbe July 8, 2025 06:13
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.

1 participant