📘 Sourcegraph handbook 
The Sourcegraph handbook describes how we (Sourcegraph teammates) work. It’s publicly visible because we are an open company.
The handbook is a living document and we expect every teammate to propose improvements, changes, additions, and fixes to keep it continuously up-to-date and accurate.
All content is in Markdown files under the
Run locally
You need NodeJS and Yarn installed.
Install dependencies:
yarn
Then start the handbook:
yarn dev
Autogenerated pages
There are autogenerated pages in content/product/ that are created at build time from the YAML files in the data folder. The script which does this is in src/scripts/generated-pages.mjs.
Check links locally
We use markdown-link-check for link checking at build time in the link-check GitHub action. If you want to run it locally, from the root of the repository you can run this command:
yarn check-links
This can be slow, so you can also check a single file by running this command, replacing path_to_file with the file you want to validate:
yarn markdown-link-check <path_to_file>
Note that this will also check external links, which the GitHub action ignores. If you wish to ignore those, add -c .github/workflows/link-check-internal.json to the command.
Build
During deployment, the netlify-build script gets executed. To simulate the build process, you can run it locally:
yarn netlify-build
The output will be in the out directory.
Deployment to production
The repository is configured to automatically deploy the main branch to production on Netlify.