How to guides

Documentation

• How to write great docs (watch the video)
• How to maintain the Tech Radar

New features

• How to add support for a language
• Release Browser Extensions
• How to implement the authentication process for an IDE extension

Implementing Sourcegraph

• Developing the product documentation
• Observability
  • How to add observability
  • How to add logging
  • How to find monitoring
  • How to add monitoring
  • How to enable continuous profiling in production
• GraphQL
  • How to add a GraphQL query

Local Environment

• Set up local development with Zoekt and Sourcegraph
• How to debug live code
• Ignoring editor config files in Git

Testing Sourcegraph & CI

• How to run tests
  • See also Testing Principles and Continuous Integration
• Configure a test instance of Phabricator and Gitolite
• How to test changes in dogfood
• How to receive a Slack notification if a specific CI step failed
• How to allow a CI step to fail without breaking the build and still receive a notification
• Run a local Sourcegraph instance behind ngrok
• How to update the CI glossary

Maintenance

• How to update pnpm to a newer version

Profiling

• How to do one-off profiling for dogfood and production using pprof

Executors

• How to deploy a new executor image
• How to debug Firecracker executors

Access Control

• Adding RBAC permissions

Repository Permissions

• Debugging Repository permissions

Wolfi

• How to add and update Wolfi packages
• How to add and update Wolfi base images

Cody Gateway

• How to set up Cody Gateway locally

Telemetry Gateway

• How to set up Telemetry Gateway locally

Windows support

Running Sourcegraph on Windows is not actively tested, but should be possible within the Windows Subsystem for Linux (WSL). Sourcegraph currently relies on Unix specifics in several places, which makes it currently not possible to run Sourcegraph directly inside Windows without WSL. We are happy to accept contributions here!