Skip to content
Open
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 @@ -65,3 +65,4 @@ The `doc` directory has additional documentation for developing and understandin
This repository contains primarily non-OSS-licensed files. See [LICENSE](LICENSE).

Copyright (c) 2018-present Sourcegraph Inc.
Hello World
1 change: 1 addition & 0 deletions client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,4 @@
5. **shared** contains utility functions, types, polyfills, etc which is not a part of the Wildcard component library. These modules should be moved into **utils** package and other new packages: e.g. **api** for GraphQL client and type generators, etc.

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.
Hello World
1 change: 1 addition & 0 deletions client/branded/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ This folder contains client code that is **branded**, i.e. it implements the vis
Code here can use global classes and must not adapt styles of the code host (for more details, see [Styling UI in the handbook](../../doc/dev/background-information/web/styling.md)).

Any code that is code host agnostic should go into [`../shared`](../shared) instead.
Hello World
1 change: 1 addition & 0 deletions client/branded/src/search-ui/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Search UI

This contains search UI components with branded styling that are shared between clients. For example, the `<SearchBox>` component that is used in both the web application and VS Code extension.
Hello World
1 change: 1 addition & 0 deletions client/branded/src/search-ui/input/codemirror/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
This folder contains various extensions used for the CodeMirror based search
query input.
Hello World
1 change: 1 addition & 0 deletions client/branded/src/search-ui/input/experimental/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ input.
IT SHOULD NOT BE USED!

If you have questions about it reach out the search product team.
Hello World
1 change: 1 addition & 0 deletions client/browser/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,3 +260,4 @@ This is an adjusted version of @lguychard's [comment here](https://github.com/so
9. Navigated to `http://127.0.0.1/source/jrpc/browse/master/async.go`

Whenever you make changes to the native extension code, you need to run `pnpm build` inside the `client/browser` directory before seeing the changes in effect on the Phabricator instance.
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/build-config/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Build config

Shared build configuration.
Hello World
1 change: 1 addition & 0 deletions client/client-api/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Client API

Sourcegraph Client API
Hello World
1 change: 1 addition & 0 deletions client/codeintellify/src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,4 @@ You need to provide your own UI component (referred to as the HoverOverlay) that
| Hover overlay | Also called tooltip |
| hoverify | To attach all the listeners needed to a code view so that it will display overlay on hovers and clicks. |
| unhoverify | To unsubscribe from the Subscription returned by `hoverifier.hoverify()`. Removes all event listeners from the code view again and hides the hover overlay if it was triggered by the unhoverified code view. |
Hello World
1 change: 1 addition & 0 deletions client/cody-context-filters-test-dataset/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
This package includes a copy of the dataset used for testing the Cody context filtering logic on the backend.
The dataset is exported so that Cody clients can ensure consistency in how Cody context filters are handled across
both the server and clients.
Hello World
1 change: 1 addition & 0 deletions client/common/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@

Generic utilities without any specific domain.
This package should not depend on any other Sourcegraph monorepo package.
Hello World
1 change: 1 addition & 0 deletions client/eslint-plugin-wildcard/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ Update your `.eslintrc` file to add the following configuration:
```

This will enable the plugin in your project and enforce our recommended rules.
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 @@ -2,3 +2,4 @@

Extensions should use the `sourcegraph` package, not this package. This package is only for client applications
that embed Sourcegraph extensions and need to communicate with them.
Hello World
1 change: 1 addition & 0 deletions client/extension-api/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Sourcegraph extension API

This package contains only the types for the DEPRECATED [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)).
Hello World
1 change: 1 addition & 0 deletions client/http-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
Generic logic for sending and handling HTTP requests from our client applications.

Use the `getGraphQLClient` client utility to create an app-specific instance of the Apollo Client, which is the recommended way to interact with Sourcegraph API from web applications.
Hello World
1 change: 1 addition & 0 deletions client/jetbrains/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,4 @@ Run the following commands to preview the components in a standalone HTML file.
```sh
pnpm standalone && open http://localhost:3000/
```
Hello World
1 change: 1 addition & 0 deletions client/observability-client/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Observability client

Shared browser observability tools based on `@opentelemetry` packages.
Hello World
1 change: 1 addition & 0 deletions client/observability-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ Shared client infrastructure observability tools.
- observability event schemas,
- environment variable validators,
- unit tests.
Hello World
1 change: 1 addition & 0 deletions client/shared/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ In particular, components cannot make use of global CSS classes but must accept
For more details, see [Styling UI in the handbook](../../doc/dev/background-information/web/styling.md).

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/react-shortcuts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ was a fork of @shopify/quilt at commit 51d2e87343f4f6dfac2a5f63b536a04399ba47c9
plus some additional changes.

We moved this code in-house to make it easier to to make adjustments.
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-legacy.sourcegraph.com/dev/how-to/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 @@ -19,3 +19,4 @@ pnpm storybook:build
# Load only a subset of stories to boost build performance.
STORIES_GLOB='client/web/src/**/*.story.tsx' pnpm start
```
Hello World
1 change: 1 addition & 0 deletions client/template-parser/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
# Template Parser
Hello World
1 change: 1 addition & 0 deletions client/testing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@

Package-agnostic utilities for unit and integration tests.
App or package-specific utilities should live in `client/{packageName}/src/testing`.
Hello World
1 change: 1 addition & 0 deletions client/vscode/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,3 +149,4 @@ The Sourcegraph extension uses major.EVEN_NUMBER.patch (eg. 2.0.1) for release v

Please see the [CONTRIBUTING](./CONTRIBUTING.md) document if you are interested in contributing directly to our code
base.
Hello World
1 change: 1 addition & 0 deletions client/vscode/src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,4 @@ As detailed in our CONTRIBUTING.md file, this extension runs code in the followi
## List of Files and Folders

See the File Structure section in our CONTRIBUTING.md file to learn more about the folders and files in this directory.
Hello World
1 change: 1 addition & 0 deletions client/vscode/src/webview/search-panel/alias/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ by changes in the way that base code interacts with forked code.
- Create a React context to wrap around `StreamingSearchResultsList` (shared) to pass
VS Code extension APIs to forked search result components.
- Change links to buttons, call VS Code file handlers from context on click.
Hello World
1 change: 1 addition & 0 deletions client/web-sveltekit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,3 +150,4 @@ pnpm run build

Currently SvelteKit is configured to create a client-side single page
application.
Hello World
1 change: 1 addition & 0 deletions client/web-sveltekit/assets/icons/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ The icons in this folder can be accessed via `ISg<icon-name>` in code. For examp
```js
ISgCody
```
Hello World
1 change: 1 addition & 0 deletions client/web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,4 @@ Note: If you are unable to use the above commands (e.g. you can't install Caddy)
### API proxy

In both environments, server proxies API requests to `SOURCEGRAPH_API_URL` provided as the `.env` variable.
Hello World
1 change: 1 addition & 0 deletions client/web/src/cody/management/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,4 @@ leading to additional HTTP requests being made unintentionally!
const call = useMemo(() => Client.createStripeCheckoutSession(req), [req.customerEmail, req.showPromoCodeField])
const { loading, error, data } = useApiCaller(call)
```
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/enterprise/embed/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@
- Start (or restart) your local dev environment
- Navigate to a 3rd party site (e.g., codepen.io), create a new page, and embed an iframe using the ngrok URL
- Example iframe tag: `<iframe src="https://your-dev-env.ngrok.io/embed/notebooks/123" frameborder="0" sandbox="allow-scripts allow-same-origin allow-popups"></iframe>`
Hello World
1 change: 1 addition & 0 deletions client/web/src/repo/blob/codemirror/codeintel/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,3 +92,4 @@ loosing focus and interrupting token navigation. Additional measures are taken
to ensure that the focus stays within the editor.

[1]: https://codemirror.net/docs/guide/#facets
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-legacy.sourcegraph.com/dev/background-information/web/wildcard) for more information.
Hello World
1 change: 1 addition & 0 deletions client/wildcard/src/components/Charts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,3 +134,4 @@ related issues. If you see something missing, feel free to file an issue with th

If you need any help around this package chart or data-visualization in general, feel free to reach out to [code-insights FE team](https://github.com/orgs/sourcegraph/teams/code-insights-frontend)
(@code-insights-fe mention in slack).
Hello World
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,4 @@ algorithm doesn't work well in all cases. Sometimes when you're using bright col
To solve this problem, if you need to use bright colors on the chart, and you want to get control
over active/non-active colors, you can specify colors for the bar non-active state manually with `getDatumFadeColor` prop.
If you set this prop, this turns off the generic color algorithm for non-active bars and takes the color provided by you.
Hello World
1 change: 1 addition & 0 deletions client/wildcard/src/components/Combobox/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,4 @@ Where
- `<ComboboxOption />` is a suggestions text component (it implements text highlighting logic by default)

[See Combobox storybook stories for more examples](https://storybook.sgdev.org/?path=/story/wildcard-combobox--combobox-demo).
Hello World
1 change: 1 addition & 0 deletions client/wildcard/src/components/Popover/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,3 +226,4 @@ enum Strategy {
```

- **_targetPadding_** (optional) - Adds space/padding between target and popover elements
Hello World
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ The modifications are:

- Apply fix from https://github.com/dgreene1/react-accessible-treeview/pull/81
- Remove PropTypes API
Hello World
1 change: 1 addition & 0 deletions client/wildcard/src/testing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ cannot import ES modules using ES6 import statements. For example, there's no wa
`@apollo/client` as we do today because Typescript will complain:

> "The current file is a CommonJS module whose imports will produce 'require' calls; however, the referenced file is an ECMAScript module and cannot be imported with 'require'. Consider writing a dynamic 'import(\"{0}\")' call instead. To convert this file to an ECMAScript module, change its file extension to '.mts', or add the field `"type": "module"` to '/package.json'"
Hello World
1 change: 1 addition & 0 deletions cmd/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
This directory contains Sourcegraph services and binaries.

When a services is added, removed, or when a service's dependencies change, update [our architecture diagram](../doc/dev/background-information/architecture/index.md).
Hello World
1 change: 1 addition & 0 deletions cmd/appliance/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Appliance runs as a standard Kubernetes Deployment and utilizes Kubernetes [cont
## Own

For more information or for help, see the [Release Team](https://handbook.sourcegraph.com/departments/engineering/teams/release/).
Hello World
1 change: 1 addition & 0 deletions cmd/batcheshelper/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,3 +78,4 @@ When running the following `sg` commands, `batcheshelper` will automatically be

- `batcheshelper-builder`
- `batches`
Hello World
1 change: 1 addition & 0 deletions cmd/blobstore/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ Implements a very simple S3-compatible API subset which can:
- List a bucket's objects

It provides the blob storage that Sourcegraph uses by default out-of-the-box (i.e. if not configured to use an external S3 or GCS bucket.)
Hello World
1 change: 1 addition & 0 deletions cmd/bundled-executor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,4 @@ create a new instance when it exits.
- Java 11 (OpenJDK)
- Maven 3.6.3
- `yq`
Hello World
1 change: 1 addition & 0 deletions cmd/cody-gateway-config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,4 @@ go test ./internal/modelconfig
# as expected.
sg lint --fix format
```
Hello World
1 change: 1 addition & 0 deletions cmd/cody-gateway/qa/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@ bazel test --runs_per_test=2 --test_output=all //cmd/cody-gateway/qa:qa_test --t
```

The `--runs_per_test=2` flag in snippet above ensures we don't hit a Bazel cache, and runs the test twice for good meausre.
Hello World
1 change: 1 addition & 0 deletions cmd/enterprise-portal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ To customize the PostgreSQL and Redis connection strings, customize the followin
- `PGDSN`: PostgreSQL connection string
- `REDIS_HOST`: Redis host
- `REDIS_PORT`: Redis port
Hello World
1 change: 1 addition & 0 deletions cmd/executor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,4 @@ As with the VM image, we're producing an AMI for both AWS and GCP, there are two
- `bazel run //cmd/executor/docker-mirror:ami.push` takes the AMIs from above and publish them (adjust perms, naming).

While `gcloud` is provided by Bazel, AWS cli is expected to be available on the host running Bazel.
Hello World
1 change: 1 addition & 0 deletions cmd/executor/kubernetes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,3 +98,4 @@ Run the following command to delete the executor.
```bash
kubectl delete -f .
```
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/frontend/graphqlbackend/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# README

See [Developing the Sourcegraph GraphQL API](../../../doc/dev/background-information/graphql_api.md) and [How to add a GraphQL query](../../../doc/dev/how-to/add_graphql_query.md).
Hello World
1 change: 1 addition & 0 deletions 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 cmd/gitserver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,4 @@ To use `p4-fusion` while developing Sourcegraph, there are a couple of options.
#### Bazel

Native binaries are provided through Bazel, built via Nix in [our fork of p4-fusion](https://github.com/sourcegraph/p4-fusion/actions/workflows/nix-build-and-upload.yaml). It can be invoked either through `./dev/p4-fusion-dev` or directly with `bazel run //dev/tools:p4-fusion`.
Hello World
1 change: 1 addition & 0 deletions cmd/gitserver/internal/cacert/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ This package exists to expose the internal code in the stdlib x509 package relat
To update run `update.bash`. It will copy the relevant code from your go installation and then patch it.

Note: This does mean this won't work on darwin. So for example our code which depends on this package will not have system certificates to use in our development environments.
Hello World
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ This file was generated by running the following git command against [sgtest/jav
```bash
git diff-tree -r --root --format=format: --no-prefix --name-status --no-renames -z 03efbe9558acc532e88f5288b4e6cfa155c6f2dc ec74ce53c5b8cf6e46e1658c2e816ad567a7acd9 > output.hex
```
Hello World
1 change: 1 addition & 0 deletions cmd/migrator/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Migrator

The migrator service is deployed ahead of a Sourcegraph version upgrade to synchronously run database migrations required by the next version. Successful exit of the migrator denotes that the new version can be deployed. Database migrations are written to be backwards-compatible so that running the migrator for the next upgrade does not cause issues with a working instance.
Hello World
1 change: 1 addition & 0 deletions cmd/migrator/airgappedgen/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,3 +130,4 @@ Yes, as long as the content didn't change in the GCS bucket and nobody re-tagged

The `genrule` that creates the tarball has the `stamp = 1` attribute, so Bazel will inspect the stable status variables and will
rebuild this if it changes. And the `VERSION` is a stable attribute, so it will get rebuilt every time it changes, .i.e. on each release.
Hello World
1 change: 1 addition & 0 deletions cmd/msp-example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ This service is an example service testing and demonstrating how to build Manage
```sh
bazel run //cmd/msp-example:candidate_push --stamp -- --tag insiders --repository us.gcr.io/sourcegraph-dev/msp-example
```
Hello World
1 change: 1 addition & 0 deletions cmd/pings/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,4 @@ A "200 OK" status code is expected.
This would send an entry to the GCP Pub/Sub topic `server-update-checks-test`, and once processed, should be available in the BigQuery table [`sourcegraph_analytics.update_checks_test`](https://console.cloud.google.com/bigquery?project=telligentsourcegraph&ws=!1m5!1m4!4m3!1stelligentsourcegraph!2ssourcegraph_analytics!3supdate_checks_test). You need to make the [Entitle request](https://app.entitle.io/request?targetType=resource&duration=10800&justification=Test%20pings%20service&integrationId=52e29e01-d551-4186-88a3-65ff4f28b8c3&resourceId=53946931-0002-469c-9b5f-c5af70bd1ffe&roleId=ea1606fd-2302-487d-83eb-d1f140478416&grantMethodId=ea1606fd-2302-487d-83eb-d1f140478416) to access this page.

When there is an error processing the Pub/Sub message, the entry would be instead sent to another BigQuery table [`sourcegraph_analytics.update_checks_test_error_records`](https://console.cloud.google.com/bigquery?project=telligentsourcegraph&ws=!1m5!1m4!4m3!1stelligentsourcegraph!2ssourcegraph_analytics!3supdate_checks_test_error_records).
Hello World
1 change: 1 addition & 0 deletions 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 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/server/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 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 prefix queries (`^foo`) and exact match queries (`^foo$`) optimized to perform index lookups. The symbols sidebar and search-based code intel benefit from these optimizations.
Hello World
1 change: 1 addition & 0 deletions cmd/symbols/squirrel/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Squirrel

Squirrel is an HTTP server for fast and precise local code intelligence using tree-sitter.
Hello World
1 change: 1 addition & 0 deletions cmd/syntactic-code-intel-worker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ Stateless service that handles generating SCIP data for codebases
using Tree-sitter for powering syntax-based code navigation.

[Design docs](https://docs.google.com/document/d/14MHauv52o4zTFiV6gC6NOJZxcJpglK-ElWa64gqeKDo/edit) (Sourcegraph internal)
Hello World
1 change: 1 addition & 0 deletions cmd/telemetry-gateway/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
Telemetry Gateway is a managed service that ingests events exported from Sourcegraph instances, manipulates them as needed, and exports them to designated Pub/Sub topics or other destinations for processing.

Refer to [the Telemetry Gateway development documentation](https://docs-legacy.sourcegraph.com/dev/how-to/telemetry_gateway) for more development guidance.
Hello World
Loading