Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,4 @@ The `doc` directory has additional documentation for developing and understandin
Sourcegraph OSS is available freely under the [Apache 2 license](LICENSE.apache). Sourcegraph OSS comprises all files in this repository except those in the `enterprise/` and `client/web/src/enterprise` directories.

All files in the `enterprise/` and `client/web/src/enterprise/` directories are subject to the [Sourcegraph Enterprise license](LICENSE.enterprise).
Hello World
1 change: 1 addition & 0 deletions client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,4 @@
6. Packages should use package name (e.g. `@sourcegraph/wildcard`) for imports instead of the relative paths (e.g. `../../../../wildcard/src/components/Markdown`) to avoid long relative-paths and make dependency graph between packages clear. (Typescript will warn if packages have circular dependencies). It's easy to refactor such isolated packages, extract functionality into new ones, or even into new repositories.

7. **build** or **config** package should be added later to encapsulate all the configurations reused between packages which will allow removing `jest.config`, `babel.config` from the root of the repo.
Hello World
1 change: 1 addition & 0 deletions client/branded/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ This folder contains client code that is **branded**, i.e. it implements the vis
Code in here can use Bootstrap and must not adapt styles of the code host (for more details, see [Styling UI in the handbook](https://about.sourcegraph.com/handbook/engineering/web/styling)).

Any code that is code host agnostic should go into [`../shared`](../shared) instead.
Hello World
1 change: 1 addition & 0 deletions client/browser/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,3 +227,4 @@ Use this process to create a source code zip to attach to a Firefox add-on submi
cd client/browser
yarn run create-source-zip
```
Hello World
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Browser APIs

This directory contains a set of helper functions that wrap the [APIs](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API) exposed by the browser to browser extensions. This originally came about while implementing support for Safari. Rather than write an entirely new extension, we wrapped the APIs and implemented pseudo support for these APIs in Safari. At this time, we no longer support Safari, however we have kept these because there are still differences in the APIs between Chrome and Firefox. This abstraction also allowed us to have a more type safe interaction with the APIs in actual application code.
Hello World
1 change: 1 addition & 0 deletions client/eslint-plugin-sourcegraph/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,4 @@ Unit tests can be run with:
```sh
yarn test
```
Hello World
1 change: 1 addition & 0 deletions client/extension-api-types/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ Extensions should use the `sourcegraph` package, not this package. This package
that embed Sourcegraph extensions and need to communicate with them.

See [Sourcegraph extensions documentation](https://docs.sourcegraph.com/extensions) for more information.
Hello World
1 change: 1 addition & 0 deletions client/extension-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@
This package contains only the types for the [Sourcegraph extension API](https://unpkg.com/sourcegraph/dist/docs/index.html) ([`sourcegraph.d.ts`](https://github.com/sourcegraph/sourcegraph/blob/main/packages/extension-api/src/sourcegraph.d.ts)).

See [Sourcegraph extensions documentation](https://docs.sourcegraph.com/extensions) for more information.
Hello World
1 change: 1 addition & 0 deletions client/shared/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ In particular, components cannot make use of Bootstrap classes, but must accept
For more details, see [Styling UI in the handbook](https://about.sourcegraph.com/handbook/engineering/web/styling).

Code that is only used in branded contexts (web app, options menu of the browser extension, ...) should go into [`../branded`](../branded) instead.
Hello World
1 change: 1 addition & 0 deletions client/shared/src/testing/integration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
This folder contains shared testing helpers for the Sourcegraph webapp and browser extensions.

For more information about integration tests and how to run them, read the [Client integration tests documentation](https://docs.sourcegraph.com/dev/testing#client-integration-tests).
Hello World
1 change: 1 addition & 0 deletions client/storybook/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,4 @@ The [DLL Plugin](https://webpack.js.org/plugins/dll-plugin/) is used to move mos
7. Storybook development server starts 🎉.

If DLL bundle and Webpack stats are in place, all intermediate steps are skipped straight to the start of Storybook development server.
Hello World
1 change: 1 addition & 0 deletions client/web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,4 @@ Build artifacts will be served from `<rootRepoPath>/ui/assets`.
In both environments, server proxies API requests to `SOURCEGRAPH_API_URL` provided as the `.env` variable.
To avoid the `CSRF token is invalid` error CSRF token is retrieved from the `SOURCEGRAPH_API_URL` before the server starts.
Then this value is used for every subsequent request to the API.
Hello World
1 change: 1 addition & 0 deletions client/web/src/components/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Components that are shared through the app
Hello World
1 change: 1 addition & 0 deletions client/web/src/regression/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,3 +105,4 @@ Test best practices:
test users easy to clean up manually if necessary.
- **Ask for help**: Regression tests are intended to be relatively easy and straightforward to write. If you find
yourself spending a lot of time implementing simple behavior, file an issue and tag @beyang.
Hello World
1 change: 1 addition & 0 deletions client/web/src/search/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Components for search UI in the app.
Hello World
1 change: 1 addition & 0 deletions client/web/src/search/results/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Components for the search results page
Hello World
1 change: 1 addition & 0 deletions client/wildcard/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@ The Wildcard component library is a collection of design-approved reusable compo
Reusable React hooks. Typically utilities or headless components

See [Wildcard documentation](https://docs.sourcegraph.com/dev/background-information/web/wildcard) for more information.
Hello World
1 change: 1 addition & 0 deletions cmd/frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ Typically there are multiple replicas running in production to scale with load.
Application data is stored in our PostgreSQL database.

Session data is stored in the Redis store, and non-persistent data is stored in the Redis cache.
Hello World
1 change: 1 addition & 0 deletions cmd/github-proxy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
Proxies all requests to github.com to keep track of rate limits and prevent triggering abuse mechanisms.

There is only one replica running in production.
Hello World
1 change: 1 addition & 0 deletions cmd/gitserver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,4 @@ gitserver's memory usage consists of short lived git subprocesses.
This is an IO and compute heavy service since most Sourcegraph requests will trigger 1 or more git commands. As such we shard requests for a repo to a specific replica. This allows us to horizontally scale out the service.

The service is stateful (maintaining git clones). However, it only contains data mirrored from upstream code hosts.
Hello World
1 change: 1 addition & 0 deletions cmd/query-runner/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# query-runner

Periodically runs saved searches, determines the difference in results, and sends notification emails. It is a singleton service by design so there must only be one replica.
Hello World
1 change: 1 addition & 0 deletions cmd/repo-updater/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# repo-updater

Repo-updater tracks the state of repos, and is responsible for automatically scheduling updates ("git fetch" runs) using gitserver. Other apps which desire updates or fetches should be telling repo-updater, rather than using gitserver directly, so repo-updater can take their changes into account. It is a singleton service by design, so there must only be one replica.
Hello World
1 change: 1 addition & 0 deletions cmd/searcher/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ Provides on-demand unindexed search for repositories. It scans through a git arc
This service should be scaled up the more on-demand searches that need to be done at once. For a search the frontend will scatter the search for each repo@commit across the replicas. The frontend will then gather the results. Like gitserver this is an IO and compute bound service. However, its state is just a disk cache which can be lost at anytime without being detrimental.

[Life of a search query](../../doc/dev/background-information/architecture/life-of-a-search-query.md)
Hello World
1 change: 1 addition & 0 deletions cmd/symbols/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ The ctags output is stored in SQLite files on disk (one per repository@commit).
It is used by [basic-code-intel](https://github.com/sourcegraph/sourcegraph-basic-code-intel) to provide the jump-to-definition feature.

It supports regex queries, with queries of the form `^foo$` optimized to perform an index lookup (basic-code-intel takes advantage of this).
Hello World
1 change: 1 addition & 0 deletions cmd/worker/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Worker

The worker service is a collection of the background jobs performed by a Sourcegraph instance. Jobs registered to the worker will run periodically or in response to some event read from the database.
Hello World
1 change: 1 addition & 0 deletions dev/auth-provider/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,4 @@ If you need to edit client or user information and want to persist your changes:
1. Run `RESET=1 scripts/configure-keycloak.sh` to clobber the existing configuration with the `config/*.json` files' configuration.

Not sure how to edit the JSON to achieve your desired outcome? Use the Keycloak admin interface at http://localhost:3220/auth (login as `root`/`q`) to change configuration, and then export to JSON.
Hello World
1 change: 1 addition & 0 deletions dev/ci/test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,4 @@ All commands should be wrapped into a bach script, which is run as part of the `
cd /sourcegraph
./dev/ci/test/new-vagrant-test/test.sh
```
Hello World
1 change: 1 addition & 0 deletions dev/depgraph/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,4 @@ This command ensures the following lint passes. Violations of the lint rules wil
- **NoLooseCommands**: Report main packages outside of known command roots
- **NoReachingIntoCommands**: Report packages that import code from an unrelated command
- **NoUnusedSharedCommandCode**: Report packages that could be moved into an internal package
Hello World
1 change: 1 addition & 0 deletions dev/gqltest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,3 +83,4 @@ Adding new tests to this test suite is as easy as adding a Go test, here are som
- Delete external services created during the test.
- Although, sometimes you would not want to delete an entity so you could login and inspect the failure state.
- Prefix your branch name with `backend-dry-run/` will run integration tests in CI on your pull request.
Hello World
1 change: 1 addition & 0 deletions dev/prometheus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ This directory contains configuration for the [Prometheus](https://prometheus.io
This directory is mounted into the `prometheus` container. After making your changes to this directory,
simply `docker restart prometheus` for your changes to take effect (depending on your change, Prometheus
may respond to it as soon as you save the file).
Hello World
1 change: 1 addition & 0 deletions dev/release/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ yarn run release help # add 'all' to see test commands as well

Before using this tool, please verify that the [release configuration](./release-config.jsonc)
is set up correctly.
Hello World
1 change: 1 addition & 0 deletions dev/sg/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -360,3 +360,4 @@ sg tail-log http
# Tail all logs
sg tail-log all
```
Hello World
1 change: 1 addition & 0 deletions dev/sg/root/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
TODO: Move me into some shared area. This code is also used in dev/depgraph
Hello World
1 change: 1 addition & 0 deletions dev/tilt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,4 @@ Tilt will start an initial build of the frontend and deploy it. Whenever you are
Similar to the `frontend` you can add other `custom_build` statements to your `Tiltfile` to build and watch the other servers.

There are many `Tiltfile` modifications that can help accelerate the edit/build/deploy cycle: https://docs.tilt.dev/example_go.html
Hello World
1 change: 1 addition & 0 deletions dev/zoekt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ This directory contains utilities that are useful for Zoekt development.

- [update](./update) Updates the version of zoekt in `go.mod`.
- [wrapper](./wrapper) Is used by our dev Procfile to control behaviour.
Hello World
1 change: 1 addition & 0 deletions docker-images/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,4 @@ Note: `$MY_VERSION` above should reflect the underlying Alpine version. If chang
1. Create a `build.sh` and add your publishing script to it - the script should end with `docker tag ... "$IMAGE"`. See the scripts in this directory for examples.
2. Ensure your new script is executable with `chmod +x build.sh` (you can try it via e.g. `IMAGE=fake-repo/cadvisor:latest docker-images/$SERVICE/build.sh`, or by [building a test image](https://about.sourcegraph.com/handbook/engineering/deployments#building-docker-images-for-a-specific-branch))
3. Add an image to the automated builds pipeline by adding it to [`SourcegraphDockerImages`](https://sourcegraph.com/search?q=repo:%5Egithub%5C.com/sourcegraph/sourcegraph%24+file:%5Eenterprise/dev/ci/images/images%5C.go+SourcegraphDockerImages&patternType=literal).
Hello World
1 change: 1 addition & 0 deletions docker-images/cadvisor/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Sourcegraph cAdvisor

Learn more about the Sourcegraph cAdvisor distribution in the [cAdvisor documentation](https://docs.sourcegraph.com/dev/background-information/observability/cadvisor).
Hello World
1 change: 1 addition & 0 deletions docker-images/grafana/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ will be detected automatically while Grafana is running.

More behavior can be controlled with
[environmental variables](https://grafana.com/docs/installation/configuration/).
Hello World
1 change: 1 addition & 0 deletions docker-images/ignite-ubuntu/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
We produce a version of Ubuntu 20.04 (Focal Fossa) based on [weaveworks/ignite-ubuntu:20.04-amd64](https://github.com/weaveworks/ignite/blob/46bdd5d48425c4245fbe895e7da3621f491c3660/images/ubuntu/Dockerfile) that also contains the Docker distribution.

This image serves as the base image for [Firecracker](https://github.com/firecracker-microvm/firecracker) virtual machines in which we run user configured containers and code.
Hello World
1 change: 1 addition & 0 deletions docker-images/prometheus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,4 @@ You can specify additional flags to pass to Prometheus by setting the environmen
`prom-wrapper` also accepts a few configuration options through environment variables - see [`cmd/prom-wrapper/main.go`](./cmd/prom-wrapper/main.go) for more details.

Alertmanager components can be disabled entirely with `DISABLE_ALERTMANAGER=true`.
Hello World
1 change: 1 addition & 0 deletions docker-images/prometheus/cmd/prom-wrapper/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# prom-wrapper

Prom-wrapper is a service that ships with the [Sourcegraph Prometheus image](https://docs.sourcegraph.com/dev/background-information/observability/prometheus).
Hello World
1 change: 1 addition & 0 deletions enterprise/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ This directory contains Sourcegraph Enterprise code.
## Dev

See [Local development: For Sourcegraph employees](https://docs.sourcegraph.com/dev/local_development#for-sourcegraph-employees) for how to work on this code.
Hello World
1 change: 1 addition & 0 deletions enterprise/cmd/executor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
The executor service polls the public frontend API for work to perform. The executor will pull a job from a particular queue (configured via the envvar `EXECUTOR_QUEUE_NAME`), then performs the job by running a sequence of docker and src-cli commands. This service is horizontally scalable.

See the [executor queue](../frontend/internal/executorqueue/README.md) for a complete list of queues.
Hello World
1 change: 1 addition & 0 deletions enterprise/cmd/frontend/internal/executorqueue/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ The executor-queue maintains the executor work queues. Executor instances poll f

- The `codeintel` queue contains unprocessed lsif_index records
- The `batches` queue contains unprocessed batch_spec_execution records
Hello World
1 change: 1 addition & 0 deletions enterprise/cmd/precise-code-intel-worker/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Precise code intel worker

The precise-code-intel-worker service converts LSIF upload file into Postgres data. This service is horizontally scalable.
Hello World
1 change: 1 addition & 0 deletions enterprise/cmd/server/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Sourcegraph Server

This directory contains the code which makes up the `sourcegraph/server` Docker image which runs Sourcegraph on a single node.
Hello World
1 change: 1 addition & 0 deletions enterprise/cmd/worker/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Enterprise worker

The enterprise worker supplements the OSS worker with additional enterprise-relevant background jobs.
Hello World
1 change: 1 addition & 0 deletions enterprise/dev/ci/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@ go run ./enterprise/dev/ci/gen-pipeline.go | buildkite-agent pipeline upload
## Testing

To test this you can run `env BUILDKITE_BRANCH=TESTBRANCH go run ./enterprise/dev/ci/gen-pipeline.go` and inspect the YAML output. To change the behaviour set the relevant `BUILDKITE_` environment variables.
Hello World
1 change: 1 addition & 0 deletions internal/cmd/ghe-feeder/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# GHE feeder tool

Please see [Handbook entry](https://about.sourcegraph.com/handbook/engineering/distribution/tools/ghe_feeder).
Hello World
1 change: 1 addition & 0 deletions internal/cmd/init-sg/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,4 @@ The format for the external service json file is as follows, multiple github ext
}
]
```
Hello World
1 change: 1 addition & 0 deletions internal/cmd/precise-code-intel-tester/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,4 @@ rm -rf testdata/indexes/
```

Then rerun the testing steps described above (starting at `clone-and-index.sh`)
Hello World
1 change: 1 addition & 0 deletions internal/cmd/progress-bot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ Usage of ./progress-bot:
The `progress-bot` is deployed with [this GitHub action](../../../.github/workflows/progress.yml).

In order to deploy a new version, first run `docker build -t sourcegraph/progress-bot .` and then `docker push sourcegraph/progress-bot`.
Hello World
1 change: 1 addition & 0 deletions internal/cmd/resources-report/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,4 @@ This bot can be [configured in Slack](https://api.slack.com/apps/A013EETK25V) wi

- GCP: Declare resource types to query in [`gcp.go`](./gcp.go)'s `gcpResources` variable.
- AWS: Declare queries for resources as functions in [`aws.go`](./aws.go)'s `awsResources` variable.
Hello World
1 change: 1 addition & 0 deletions internal/cmd/search-blitz/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,4 @@ Logs are rotated every 10 mb.
search-blitz calls the GraphQL API with a token of a dedicated user.

Credentials: 1password.
Hello World
1 change: 1 addition & 0 deletions internal/cmd/tracking-issue/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,4 @@ In order to deploy a new version, first run `docker build -t sourcegraph/trackin
Run the tests with `go test`, update fixtures (i.e. GitHub issues and PRs data) with `go test -update.fixture` and update the generated tracking issue golden file with `go test -update`.

You can also run the tool manually in `-dry` mode with `-verbose` output to visualize the resulting tracking issues without updating them on GitHub.
Hello World
1 change: 1 addition & 0 deletions internal/encryption/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,4 @@ The `encryption.Key` interface was built to be simple, and intended to be extend
- AWS KMS
- Mounted Key
- No Op
Hello World
1 change: 1 addition & 0 deletions internal/goreman/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ This is a fork of github.com/mattn/goreman at commit d0ee41b21be92ce6fd3e55ad11c
This fork turns the command into a library.

github.com/mattn/goreman is licensed as MIT.
Hello World
1 change: 1 addition & 0 deletions lib/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
This directory is the root of a separate go module from the primary module rooted at sourcegraph/sourcegraph. This module exists to hold code that we want to reuse outside of the sourcegraph/sourcegraph repo.

Code in this module should _not_ import from sourcegraph/sourcegraph or from other Sourcegraph repositories to avoid complicated dependency relationships. Instead consider moving code from elsewhere into this module.
Hello World
1 change: 1 addition & 0 deletions lib/codeintel/lsif/protocol/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# LSIF protocol utilities for Go

This repository contains LSIF protocol struct definitions.
Hello World
1 change: 1 addition & 0 deletions lib/codeintel/tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,3 +135,4 @@ This command validates the output of an LSIF indexer. The following properties a
## lsif-visualize

Documentation coming soon.
Hello World
1 change: 1 addition & 0 deletions migrations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,3 +145,4 @@ If the schema for database `<db_name>` with the schema version table `<schema_ve
- Run the necessary SQL commands to make the schema consistent with version `$VERSION` of the schema.
- Run `update <schema_version_table_name> set version=$VERSION, dirty=false;`.
- Restart frontend pods.
Hello World
1 change: 1 addition & 0 deletions monitoring/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,4 @@ The Sourcegraph monitoring generator consists of three components:
This is where the API for service monitoring definitions is defined, as well as the generator code that provides [its features](https://docs.sourcegraph.com/dev/background-information/observability/monitoring-generator#features).

All features and capabilities for developed for the generator should align with the [Sourcegraph monitoring pillars](https://about.sourcegraph.com/handbook/engineering/observability/monitoring_pillars).
Hello World
1 change: 1 addition & 0 deletions monitoring/monitoring/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ For more details about this package, refer to the [API documentation](https://so
To learn more about developing monitoring for Sourcegraph, refer to [the observability developer's guide](https://docs.sourcegraph.com/dev/background-information/observability).

To learn more about the Sourcegraph monitoring generator, refer to [the monitoring generator overview](https://docs.sourcegraph.com/dev/background-information/observability/monitoring-generator).
Hello World
1 change: 1 addition & 0 deletions schema/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@ Sourcegraph uses the following JSON Schemas:
## Known issues

- The JSON Schema IDs (URIs) are of the form `https://sourcegraph.com/v1/*.schema.json#`, but these are not actually valid URLs. This means you generally need to supply them to JSON Schema validation libraries manually instead of having the validator fetch the schema from the web.
Hello World