{"id":13512900,"url":"https://github.com/sourcegraph/handbook","last_synced_at":"2025-03-31T00:30:49.926Z","repository":{"id":36953959,"uuid":"410976980","full_name":"sourcegraph/handbook","owner":"sourcegraph","description":"📘 The Sourcegraph handbook","archived":true,"fork":false,"pushed_at":"2024-07-02T05:35:32.000Z","size":36140,"stargazers_count":160,"open_issues_count":66,"forks_count":113,"subscribers_count":51,"default_branch":"main","last_synced_at":"2025-03-28T02:48:19.572Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://handbook.sourcegraph.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sourcegraph.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2021-09-27T17:18:33.000Z","updated_at":"2025-03-24T05:55:58.000Z","dependencies_parsed_at":"2023-09-21T20:35:27.141Z","dependency_job_id":"a4d2fdaa-3f0d-44c4-9a4a-b3dceee1026a","html_url":"https://github.com/sourcegraph/handbook","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sourcegraph%2Fhandbook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sourcegraph%2Fhandbook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sourcegraph%2Fhandbook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sourcegraph%2Fhandbook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sourcegraph","download_url":"https://codeload.github.com/sourcegraph/handbook/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246399816,"owners_count":20770907,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T04:00:33.956Z","updated_at":"2025-03-31T00:30:44.894Z","avatar_url":"https://github.com/sourcegraph.png","language":"TypeScript","readme":"# 📘 Sourcegraph handbook \u003ca href=\"https://app.netlify.com/sites/sourcegraph-handbook/deploys\"\u003e\u003cimg alt=\"Netlify Status\" src=\"https://api.netlify.com/api/v1/badges/4c81a998-33b5-4357-a593-479e21bb10f3/deploy-status\" align=\"right\"\u003e\u003c/a\u003e\n\nThe Sourcegraph handbook describes how we (Sourcegraph teammates) work. It’s publicly visible because we are an [open company](https://handbook.sourcegraph.com/company#open-company).\n\nThe 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.\n\nAll content is in [Markdown](https://www.markdownguide.org/getting-started/#what-is-markdown) files under the [📁 content](./content) folder.\n\n## :warning: Migration to Notion.so\n\nThe handbook is hosted on Notion, and https://handbook.sourcegraph.com will redirect to the corresponding Notion.site.\nRedirections listed in `data/notion_migration.yaml` are now handled through Cloudflare.\n\nPlease reach-out to [#wg-notion](https://sourcegraph.slack.com/archives/C06T68DBMSA) to add a new one if:\n\n- It's a very important page that was relevant to customers.\n- It's a very important page for the hiring process and emails are in-flight with those URLs.\n\nPlease reach-out to [#discuss-dev-infra](https://sourcegraph.slack.com/archives/C04MYFW01NV) directly if:\n\n- You need to scrub content from the handbook (incorrect content has been added before the repo was archived).\n- You absolutely need to push some change, with a very valid reason for it.\n\n### Need help editing?\n\nAsk in the [#handbook channel](https://app.slack.com/client/T02FSM7DL/CQ44Y7F4G) (for Sourcegraph team members), and/or [post an issue](https://github.com/sourcegraph/handbook/issues).\n\n## Run or develop locally\n\n### Setup\n\n1. Install [asdf](https://asdf-vm.com/)\n1. Run `asdf plugin add nodejs \u0026\u0026 asdf plugin add pnpm \u0026\u0026 asdf install`\n\n### Running the website locally\n\nRun:\n\n```sh\npnpm install\npnpm dev\n```\n\nThen open [http://localhost:3000](http://localhost:3000) in your web browser.\n\n## Development notes\n\n### Autogenerated content\n\nThere are special tokens within some markdown pages (`{{generator:*}}`) that are filled at build time from the YAML files in the [data](./data) folder. The code which does this the filling is in [src/lib/generatedMarkdown.ts], and these are called as part of the markdown pipeline in `src/lib/markdownToHtml.ts`.\n\n### Check links locally\n\nWe use [markdown-link-check](https://github.com/tcort/markdown-link-check) for link checking at build time in [the `link-check` GitHub action](.github/workflows/link-check.yml). If you want to run it locally, from the root of the repository you can run this command:\n\n```shell\npnpm check-links\n```\n\nThis 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:\n\n```shell\npnpm markdown-link-check \u003cpath_to_file\u003e\n```\n\nNote 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.\n\n### Build\n\nDuring deployment, the `netlify-build` script gets executed. To simulate the build process, you can run it locally:\n\n```shell\npnpm netlify-build\n```\n\nThe output will be in the `out` directory.\n\n### Deployment to production\n\nThe repository is configured to automatically deploy the `main` branch to production on Netlify.\n","funding_links":[],"categories":["Uncategorized","TypeScript"],"sub_categories":["Uncategorized"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsourcegraph%2Fhandbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsourcegraph%2Fhandbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsourcegraph%2Fhandbook/lists"}