mirror of
https://github.com/sourcegraph/sourcegraph.git
synced 2026-02-06 12:51:55 +00:00
fix: update links for dev docs (#62758)
* fix: license checker info is in docs-legacy * fix: update remaining dev links
This commit is contained in:
Michael Bahr
GitHub
parent
5022b91a43
commit
e85028b8bd
2
.github/workflows/licenses-update.yml
vendored
2
.github/workflows/licenses-update.yml
vendored
@ -39,7 +39,7 @@ jobs:
|
||||
team-reviewers: 'team-dev-infra'
|
||||
body: |
|
||||
This is an automated pull request generated by [this run](https://github.com/sourcegraph/sourcegraph/actions/runs/${{ github.run_id }}).
|
||||
Learn more about our GitHub Actions for managing licenses [here](https://docs.sourcegraph.com/dev/background-information/ci#third-party-licenses).
|
||||
Learn more about our GitHub Actions for managing licenses [here](https://docs-legacy.sourcegraph.com/dev/background-information/ci#third-party-licenses).
|
||||
|
||||
You're safe to merge this pull request when the required checks are passing.
|
||||
|
||||
|
||||
@ -19,10 +19,10 @@ All interactions with the Sourcegraph open source project are governed by the
|
||||
|
||||
1. Select one of the issues labeled as [good first issue](https://github.com/orgs/sourcegraph/projects/210).
|
||||
2. Clone the repo: `git clone https://github.com/sourcegraph/sourcegraph`.
|
||||
3. [Set up your development environment](https://sourcegraph.com/docs/dev/setup/quickstart) to run the project locally.
|
||||
4. Before creating a pull request, ensure that [recommended checks](https://sourcegraph.com/docs/dev/contributing) pass locally. We're actively working on making our CI pipeline public to automate this step.
|
||||
3. [Set up your development environment](https://docs-legacy.sourcegraph.com/dev/setup/quickstart) to run the project locally.
|
||||
4. Before creating a pull request, ensure that [recommended checks](https://docs-legacy.sourcegraph.com/dev/contributing) pass locally. We're actively working on making our CI pipeline public to automate this step.
|
||||
5. **IMPORTANT:** Once you have a pull request ready to review, the 'verification/cla-signed' check will be flagged, and you will be prompted to sign the CLA with a link provided by our bot. Once you sign, add a comment tagging `@sourcegraph/contribution-reviewers`. After that your pull request will be ready for review.
|
||||
- For Sourcegraph team members, see [these notes](https://sourcegraph.com/docs/dev/contributing/accepting_contribution#cla-bot) for how to verify that the CLA has been signed.
|
||||
- For Sourcegraph team members, see [these notes](https://docs-legacy.sourcegraph.com/dev/contributing/accepting_contribution#cla-bot) for how to verify that the CLA has been signed.
|
||||
6. Once you've chosen an issue, **comment on it to announce that you will be working on it**, making it visible for others that this issue is being tackled. If you end up not creating a pull request for this issue, please delete your comment.
|
||||
7. If you have any questions, please [refer to the docs first](https://sourcegraph.com/docs/). If you don’t find any relevant information, mention the issue author.
|
||||
8. The issue author will try to provide guidance. Sourcegraph always works in async mode. We will try to answer as soon as possible, but please keep time zones differences in mind.
|
||||
@ -37,17 +37,17 @@ All open issues are not yet solved. If the task is interesting to you, take it a
|
||||
### Getting applications up and running
|
||||
|
||||
- [Getting Started Guide](https://sourcegraph.com/docs/getting-started)
|
||||
- [Troubleshooting section](https://sourcegraph.com/docs/dev/setup/troubleshooting)
|
||||
- [Troubleshooting section](https://docs-legacy.sourcegraph.com/dev/setup/troubleshooting)
|
||||
|
||||
### How to write tests
|
||||
|
||||
- [How to write tests](https://sourcegraph.com/docs/dev/how-to/testing)
|
||||
- [Testing principles](https://sourcegraph.com/docs/dev/background-information/testing_principles)
|
||||
- [Testing web code](https://sourcegraph.com/docs/dev/background-information/testing_web_code)
|
||||
- [How to write tests](https://docs-legacy.sourcegraph.com/dev/how-to/testing)
|
||||
- [Testing principles](https://docs-legacy.sourcegraph.com/dev/background-information/testing_principles)
|
||||
- [Testing web code](https://docs-legacy.sourcegraph.com/dev/background-information/testing_web_code)
|
||||
|
||||
### Pull Requests
|
||||
|
||||
- [How to structure](https://sourcegraph.com/docs/dev/background-information/pull_request_reviews#what-makes-an-effective-pull-request-pr)
|
||||
- [How to structure](https://docs-legacy.sourcegraph.com/dev/background-information/pull_request_reviews#what-makes-an-effective-pull-request-pr)
|
||||
- Git branch name convention: `[developer-initials]/short-feature-description`
|
||||
- [Examples on Github](https://github.com/sourcegraph/sourcegraph/pulls?q=is%3Apr+label%3Ateam%2Ffrontend-platform)
|
||||
- (For Sourcegraph team) [How to accept contributions](https://sourcegraph.com/docs/dev/contributing/accepting_contribution)
|
||||
- (For Sourcegraph team) [How to accept contributions](https://docs-legacy.sourcegraph.com/dev/contributing/accepting_contribution)
|
||||
|
||||
@ -135,7 +135,7 @@ The test suite in `end-to-end/github.test.ts` runs on the release branch `bext/r
|
||||
|
||||
The test suite in end-to-end/phabricator.test.ts tests the Phabricator native integration.
|
||||
It assumes an existing Sourcegraph and Phabricator instance that has the Phabricator extension installed.
|
||||
There are automated scripts to set up the Phabricator instance, see https://sourcegraph.com/docs/dev/phabricator_gitolite.
|
||||
There are automated scripts to set up the Phabricator instance, see https://docs-legacy.sourcegraph.com/dev/phabricator_gitolite.
|
||||
It currently does not run in CI and is intended to be run manually for release testing.
|
||||
|
||||
`end-to-end/bitbucket.test.ts` tests the browser extension on a Bitbucket Server instance.
|
||||
@ -243,7 +243,7 @@ This is an adjusted version of @lguychard's [comment here](https://github.com/so
|
||||
4. Navigated to `127.0.0.1` to access the Phabricator instance, and logged in with `admin` / `sourcegraph` (as printed by `./dev/phabricator/start.sh`)
|
||||
5. Navigated to `http://127.0.0.1/config/group/sourcegraph/` (Config -> Application Settings -> Sourcegraph)
|
||||
6. Edited `corsOrigin` in site config at `https://sourcegraph.test:3443/site-admin/configuration` to include `http://127.0.0.1` (might need to be added in `dev-private` repo).
|
||||
7. Added a repository by mirroring a public GitHub repository (we have some docs for this [here](https://sourcegraph.com/docs/dev/phabricator_gitolite), but they need improving):
|
||||
7. Added a repository by mirroring a public GitHub repository (we have some docs for this [here](https://docs-legacy.sourcegraph.com/dev/phabricator_gitolite), but they need improving):
|
||||
- Navigated to `http://127.0.0.1/diffusion/edit/?vcs=git`
|
||||
- Created a repository with name `JsonRPC2`, callsign `JRPC`, short name `jrpc`
|
||||
- Navigated to `http://127.0.0.1/source/jrpc/manage/uris/` (URIs)
|
||||
|
||||
@ -97,7 +97,7 @@ async function configureSourcegraphIntegration(driver: Driver): Promise<void> {
|
||||
await driver.page.waitForSelector('a[href="/config/group/sourcegraph/"]', { timeout: 2000 })
|
||||
} catch {
|
||||
throw new Error(
|
||||
`The Sourcegraph native integration is not installed on ${PHABRICATOR_BASE_URL}. Please see https://sourcegraph.com/docs/dev/how-to/configure_phabricator_gitolite#install-the-sourcegraph-phabricator-extension`
|
||||
`The Sourcegraph native integration is not installed on ${PHABRICATOR_BASE_URL}. Please see https://docs-legacy.sourcegraph.com/dev/how-to/configure_phabricator_gitolite#install-the-sourcegraph-phabricator-extension`
|
||||
)
|
||||
}
|
||||
|
||||
|
||||
@ -97,7 +97,7 @@ export interface PlatformContext {
|
||||
* Returns promise that resolves into Apollo Client instance after cache restoration.
|
||||
* Only `watchQuery` is available till https://github.com/sourcegraph/sourcegraph/issues/24953 is implemented.
|
||||
*
|
||||
* @deprecated Use [Apollo](https://sourcegraph.com/docs/dev/background-information/web/graphql#graphql-client) instead
|
||||
* @deprecated Use [Apollo](https://docs-legacy.sourcegraph.com/dev/background-information/web/graphql#graphql-client) instead
|
||||
*/
|
||||
getGraphQLClient: () => Promise<Pick<GraphQLClient, 'watchQuery'>>
|
||||
|
||||
@ -108,7 +108,7 @@ export interface PlatformContext {
|
||||
* could leak private information such as repository names.
|
||||
* @returns Observable that emits the result or an error if the HTTP request failed
|
||||
*
|
||||
* @deprecated Use [Apollo](https://sourcegraph.com/docs/dev/background-information/web/graphql#graphql-client) instead
|
||||
* @deprecated Use [Apollo](https://docs-legacy.sourcegraph.com/dev/background-information/web/graphql#graphql-client) instead
|
||||
*/
|
||||
requestGraphQL: <R, V extends { [key: string]: any } = object>(options: {
|
||||
/**
|
||||
@ -189,7 +189,7 @@ export interface PlatformContext {
|
||||
/**
|
||||
* Telemetry recorder for the new telemetry framework, superseding
|
||||
* 'telemetryService' and 'logEvent' variants. Learn more here:
|
||||
* https://sourcegraph.com/docs/dev/background-information/telemetry
|
||||
* https://docs-legacy.sourcegraph.com/dev/background-information/telemetry
|
||||
*
|
||||
* It is backed by a '@sourcegraph/telemetry' implementation.
|
||||
*/
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// NOTE(naman): Remember to add events to allow list: https://sourcegraph.com/docs/dev/background-information/data-usage-pipeline#allow-list
|
||||
// NOTE(naman): Remember to add events to allow list: https://docs-legacy.sourcegraph.com/dev/background-information/data-usage-pipeline#allow-list
|
||||
export const enum EventName {
|
||||
CODY_CHAT_PAGE_VIEWED = 'web:codyChat:pageViewed',
|
||||
CODY_CHAT_SUBMIT = 'web:codyChat:submit',
|
||||
|
||||
@ -29,14 +29,14 @@ export type BillingProduct = 'exampleBillingProduct'
|
||||
|
||||
/**
|
||||
* Props interface that can be extended by React components depending on the
|
||||
* new telemetry framework: https://sourcegraph.com/docs/dev/background-information/telemetry
|
||||
* new telemetry framework: https://docs-legacy.sourcegraph.com/dev/background-information/telemetry
|
||||
* These properties are part of {@link PlatformContext}.
|
||||
*/
|
||||
export interface TelemetryV2Props {
|
||||
/**
|
||||
* Telemetry recorder for the new telemetry framework, superseding
|
||||
* 'telemetryService' and 'logEvent' variants. Learn more here:
|
||||
* https://sourcegraph.com/docs/dev/background-information/telemetry
|
||||
* https://docs-legacy.sourcegraph.com/dev/background-information/telemetry
|
||||
*
|
||||
* It is backed by a '@sourcegraph/telemetry' implementation.
|
||||
*/
|
||||
|
||||
@ -25,7 +25,7 @@ const formatRuleViolations = (violations: Result[]): string[] =>
|
||||
({ id, help, helpUrl, nodes }) => `
|
||||
Rule: "${id}" (${help})
|
||||
Further information: ${helpUrl}
|
||||
How to manually audit: https://sourcegraph.com/docs/dev/background-information/web/accessibility/how-to-audit#auditing-a-user-journey
|
||||
How to manually audit: https://docs-legacy.sourcegraph.com/dev/background-information/web/accessibility/how-to-audit#auditing-a-user-journey
|
||||
Required changes: ${formatViolationProblems(nodes)}
|
||||
`
|
||||
)
|
||||
@ -45,7 +45,7 @@ export const ACCESSIBILITY_AUDIT_IGNORE_CLASS = '.a11y-ignore'
|
||||
*
|
||||
* Will error with a list of violations if any are found.
|
||||
*
|
||||
* See further documentation: https://sourcegraph.com/docs/dev/how-to/testing#accessibility-tests
|
||||
* See further documentation: https://docs-legacy.sourcegraph.com/dev/how-to/testing#accessibility-tests
|
||||
*/
|
||||
export async function accessibilityAudit(page: Page, config: AccessibilityAuditConfiguration = {}): Promise<void> {
|
||||
const { options, mode = 'fail' } = config
|
||||
|
||||
@ -2,4 +2,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://sourcegraph.com/docs/dev/how-to/testing#client-integration-tests).
|
||||
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).
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Storybook configuration
|
||||
|
||||
Check out the [Storybook section](https://sourcegraph.com/docs/dev/background-information/web/web_app#storybook) in the [Developing the Sourcegraph web app](https://docs.sourcegraph.com/dev/background-information/web/web_app) docs.
|
||||
Check out the [Storybook section](https://docs-legacy.sourcegraph.com/dev/background-information/web/web_app#storybook) in the [Developing the Sourcegraph web app](https://docs.sourcegraph.com/dev/background-information/web/web_app) docs.
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
## Local development
|
||||
|
||||
Use `sg` CLI tool to configure and start local development server. For more information check out [the `sg` documentation](https://sourcegraph.com/docs/dev/background-information/sg).
|
||||
Use `sg` CLI tool to configure and start local development server. For more information check out [the `sg` documentation](https://docs-legacy.sourcegraph.com/dev/background-information/sg).
|
||||
|
||||
Our local development server runs by starting both a [Caddy](https://caddyserver.com/) HTTPS server and a Node HTTP server. We then can reverse proxy requests to the Node server to serve client assets under HTTPS.
|
||||
|
||||
|
||||
@ -77,7 +77,7 @@ export interface BreadcrumbSetters {
|
||||
* pass an arbitrary element or a link config object for simpler breadcrumbs.
|
||||
* @returns Another breadcrumb setters object to pass down to child components to register child breadcrumbs,
|
||||
* with a method to remove the breadcrumb again. The object should be added to a [subscription
|
||||
* bag](https://sourcegraph.com/docs/dev/background-information/languages/typescript#subscription-bag).
|
||||
* bag](https://docs-legacy.sourcegraph.com/dev/background-information/languages/typescript#subscription-bag).
|
||||
*/
|
||||
setBreadcrumb: (breadcrumb: NullableBreadcrumb) => BreadcrumbSetters & Unsubscribable
|
||||
}
|
||||
|
||||
@ -6,7 +6,7 @@ import type { ExportTelemetryEventsResult } from '../graphql-operations'
|
||||
|
||||
/**
|
||||
* ApolloTelemetryExporter exports events via the new Sourcegraph telemetry
|
||||
* framework: https://sourcegraph.com/docs/dev/background-information/telemetry
|
||||
* framework: https://docs-legacy.sourcegraph.com/dev/background-information/telemetry
|
||||
*/
|
||||
export class ApolloTelemetryExporter implements TelemetryExporter {
|
||||
constructor(private client: ApolloClient<object>) {}
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
import type { AuthProvider } from '../jscontext'
|
||||
|
||||
// NOTE(naman): Remember to add events to allow list: https://sourcegraph.com/docs/dev/background-information/data-usage-pipeline#allow-list
|
||||
// NOTE(naman): Remember to add events to allow list: https://docs-legacy.sourcegraph.com/dev/background-information/data-usage-pipeline#allow-list
|
||||
export const enum EventName {
|
||||
CODY_CHAT_PAGE_VIEWED = 'web:codyChat:pageViewed',
|
||||
CODY_CHAT_SUBMIT = 'web:codyChat:submit',
|
||||
|
||||
@ -12,4 +12,4 @@ The Wildcard component library is a collection of design-approved reusable compo
|
||||
- `hooks/`
|
||||
Reusable React hooks. Typically utilities or headless components
|
||||
|
||||
See [Wildcard documentation](https://sourcegraph.com/docs/dev/background-information/web/wildcard) for more information.
|
||||
See [Wildcard documentation](https://docs-legacy.sourcegraph.com/dev/background-information/web/wildcard) for more information.
|
||||
|
||||
@ -267,7 +267,7 @@ export const CrossingStyles: StoryFn = () => (
|
||||
<Link
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
to="https://sourcegraph.com/docs/dev/background-information/web/accessibility/detailed-checklist#headings"
|
||||
to="https://docs-legacy.sourcegraph.com/dev/background-information/web/accessibility/detailed-checklist#headings"
|
||||
>
|
||||
accessible
|
||||
</Link>{' '}
|
||||
|
||||
@ -47,7 +47,7 @@ To use `p4-fusion` while developing Sourcegraph, there are a couple of options.
|
||||
|
||||
#### Docker
|
||||
|
||||
[Run `gitserver` in a Docker container](https://sourcegraph.com/docs/dev/background-information/sg#run-gitserver-in-a-docker-container). This is the option that gives an experience closest to a deployed Sourcegraph instance, and will work for any platform/OS on which you're developing (running `sg start`).
|
||||
[Run `gitserver` in a Docker container](https://docs-legacy.sourcegraph.com/dev/background-information/sg#run-gitserver-in-a-docker-container). This is the option that gives an experience closest to a deployed Sourcegraph instance, and will work for any platform/OS on which you're developing (running `sg start`).
|
||||
|
||||
#### Bazel
|
||||
|
||||
|
||||
@ -134,7 +134,7 @@ const (
|
||||
)
|
||||
|
||||
// gitGCMode describes which mode we should be running git gc.
|
||||
// See for a detailed description of the modes: https://sourcegraph.com/docs/dev/background-information/git_gc
|
||||
// See for a detailed description of the modes: https://docs-legacy.sourcegraph.com/dev/background-information/git_gc
|
||||
var gitGCMode = func() int {
|
||||
// EnableGCAuto is a temporary flag that allows us to control whether or not
|
||||
// `git gc --auto` is invoked during janitorial activities. This flag will
|
||||
|
||||
@ -2,4 +2,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://sourcegraph.com/docs/dev/how-to/telemetry_gateway) for more development guidance.
|
||||
Refer to [the Telemetry Gateway development documentation](https://docs-legacy.sourcegraph.com/dev/how-to/telemetry_gateway) for more development guidance.
|
||||
|
||||
@ -371,7 +371,7 @@ func newBitbucketProjectPermissionsWorker(ctx context.Context, observationCtx *o
|
||||
}
|
||||
|
||||
// newBitbucketProjectPermissionsResetter implements resetter for the explicit_permissions_bitbucket_projects_jobs table.
|
||||
// See resetter documentation for more details. https://sourcegraph.com/docs/dev/background-information/workers#dequeueing-and-resetting-jobs
|
||||
// See resetter documentation for more details. https://docs-legacy.sourcegraph.com/dev/background-information/workers#dequeueing-and-resetting-jobs
|
||||
func newBitbucketProjectPermissionsResetter(observationCtx *observation.Context, db database.DB, cfg *config, metrics bitbucketProjectPermissionsMetrics) *dbworker.Resetter[*types.BitbucketProjectPermissionJob] {
|
||||
observationCtx = observation.ContextWithLogger(observationCtx.Logger.Scoped("BitbucketProjectPermissionsResetter"), observationCtx)
|
||||
|
||||
|
||||
@ -312,9 +312,9 @@ func (c *Client) createMessageBlocks(info *BuildNotification, author string) []s
|
||||
&slack.TextBlockObject{
|
||||
Type: slack.MarkdownType,
|
||||
Text: `:books: *More information on flakes*
|
||||
• <https://sourcegraph.com/docs/dev/background-information/ci#flakes|How to disable flaky tests>
|
||||
• <https://docs-legacy.sourcegraph.com/dev/background-information/ci#flakes|How to disable flaky tests>
|
||||
• <https://github.com/sourcegraph/sourcegraph/issues/new/choose|Create a flaky test issue>
|
||||
• <https://sourcegraph.com/docs/dev/how-to/testing#assessing-flaky-client-steps|Recognizing flaky client steps and how to fix them>
|
||||
• <https://docs-legacy.sourcegraph.com/dev/how-to/testing#assessing-flaky-client-steps|Recognizing flaky client steps and how to fix them>
|
||||
|
||||
_Disable flakes on sight and save your fellow teammate some time!_`,
|
||||
},
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Buildkite Pipeline for sourcegraph/sourcegraph
|
||||
|
||||
We dynamically generate our CI pipeline for [Buildkite](https://buildkite.com/sourcegraph/sourcegraph) based on the output of [gen-pipeline.go](./gen-pipeline.go).
|
||||
To learn more, refer to the [continuous integration docs](https://sourcegraph.com/docs/dev/background-information/ci).
|
||||
To learn more, refer to the [continuous integration docs](https://docs-legacy.sourcegraph.com/dev/background-information/ci).
|
||||
|
||||
@ -56,7 +56,7 @@ if [[ $EXIT_CODE -ne 0 ]]; then
|
||||
sg bazel configure
|
||||
```
|
||||
|
||||
#### For more information please see the [Bazel FAQ](https://sourcegraph.com/docs/dev/background-information/bazel/faq)
|
||||
#### For more information please see the [Bazel FAQ](https://docs-legacy.sourcegraph.com/dev/background-information/bazel/faq)
|
||||
|
||||
END
|
||||
exit "$EXIT_CODE"
|
||||
@ -80,7 +80,7 @@ if [[ $EXIT_CODE -ne 0 ]]; then
|
||||
sg bazel configure godeps
|
||||
```
|
||||
|
||||
#### For more information please see the [Bazel FAQ](https://sourcegraph.com/docs/dev/background-information/bazel/faq)
|
||||
#### For more information please see the [Bazel FAQ](https://docs-legacy.sourcegraph.com/dev/background-information/bazel/faq)
|
||||
|
||||
END
|
||||
exit "$EXIT_CODE"
|
||||
|
||||
@ -31,5 +31,5 @@ ${runType}
|
||||
${diff}
|
||||
${messageFlags}
|
||||
<br/>
|
||||
Note that a Job has [**soft failed**](https://sourcegraph.com/docs/dev/background-information/ci#soft-failures) when you see this icon: ⚠️.
|
||||
Note that a Job has [**soft failed**](https://docs-legacy.sourcegraph.com/dev/background-information/ci#soft-failures) when you see this icon: ⚠️.
|
||||
EOF
|
||||
|
||||
@ -145,7 +145,7 @@ func renderPipelineDocs(logger log.Logger, w io.Writer) {
|
||||
fmt.Fprintln(w, "# Pipeline types reference")
|
||||
fmt.Fprintln(w, "\nThis is a reference outlining what CI pipelines we generate under different conditions.")
|
||||
fmt.Fprintln(w, "\nTo preview the pipeline for your branch, use `sg ci preview`.")
|
||||
fmt.Fprintln(w, "\nFor a higher-level overview, please refer to the [continuous integration docs](https://sourcegraph.com/docs/dev/background-information/ci).")
|
||||
fmt.Fprintln(w, "\nFor a higher-level overview, please refer to the [continuous integration docs](https://docs-legacy.sourcegraph.com/dev/background-information/ci).")
|
||||
|
||||
fmt.Fprintln(w, "\n## Run types")
|
||||
|
||||
|
||||
@ -48,7 +48,7 @@ Wolfi image configuration and apko lockfiles are not in sync. Fix by running:
|
||||
sg wolfi lock
|
||||
\`\`\`
|
||||
|
||||
Check the <a href="https://sourcegraph.com/docs/dev/how-to/wolfi/add_update_images#modify-an-existing-base-image">Wolfi documentation</a> for more information.
|
||||
Check the <a href="https://docs-legacy.sourcegraph.com/dev/how-to/wolfi/add_update_images#modify-an-existing-base-image">Wolfi documentation</a> for more information.
|
||||
EOF
|
||||
fi
|
||||
fi
|
||||
|
||||
@ -129,7 +129,7 @@ EOF
|
||||
# Add note if any packages were modified
|
||||
if [ ${#modified_packages[@]} -gt 0 ]; then
|
||||
cat <<-EOF >>"${REPO_DIR}/annotations/${file}"
|
||||
NOTE: Any modified package will <strong>not</strong> be present in the image once merged - <a href="https://sourcegraph.com/docs/dev/how-to/wolfi/add_update_packages#update-an-existing-packaged-dependency">check the docs</a> for more details.
|
||||
NOTE: Any modified package will <strong>not</strong> be present in the image once merged - <a href="https://docs-legacy.sourcegraph.com/dev/how-to/wolfi/add_update_packages#update-an-existing-packaged-dependency">check the docs</a> for more details.
|
||||
EOF
|
||||
fi
|
||||
fi
|
||||
|
||||
@ -2,4 +2,4 @@
|
||||
|
||||
The folder contains the scripts that our CI pipeline uses to run vulnerability scans with [Trivy](https://aquasecurity.github.io/trivy/).
|
||||
|
||||
See https://sourcegraph.com/docs/dev/background-information/ci for more information.
|
||||
See https://docs-legacy.sourcegraph.com/dev/background-information/ci for more information.
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -3,7 +3,7 @@
|
||||
# This script either generates a report of third-party dependencies, or runs a check that fails
|
||||
# if there are any unapproved dependencies ('action items').
|
||||
#
|
||||
# Please refer to the handbook entry for more details: https://sourcegraph.com/docs/dev/background-information/ci#third-party-licenses
|
||||
# Please refer to the handbook entry for more details: https://docs-legacy.sourcegraph.com/dev/background-information/ci#third-party-licenses
|
||||
|
||||
set -euf -o pipefail
|
||||
|
||||
@ -40,5 +40,5 @@ license_finder ignored_dependencies list
|
||||
license_finder dependencies list
|
||||
|
||||
# run license check
|
||||
echo "Running license_finder - if this fails, refer to our handbook: https://sourcegraph.com/docs/dev/background-information/ci#third-party-licenses"
|
||||
echo "Running license_finder - if this fails, refer to our handbook: https://docs-legacy.sourcegraph.com/dev/background-information/ci#third-party-licenses"
|
||||
license_finder "${COMMAND}" --columns=package_manager name version licenses homepage approved
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
# This files provides an easy way to start Redis and PostgreSQL servers for
|
||||
# development, via docker-compose.
|
||||
#
|
||||
# See https://sourcegraph.com/docs/dev/setup/quickstart#run-databases
|
||||
# See https://docs-legacy.sourcegraph.com/dev/setup/quickstart#run-databases
|
||||
#
|
||||
# You can also use `sg run redis-postgres`.
|
||||
services:
|
||||
|
||||
@ -26,4 +26,4 @@
|
||||
```
|
||||
|
||||
`sg` is the CLI tool that Sourcegraph developers can use to develop Sourcegraph.
|
||||
Learn more about it [here](https://sourcegraph.com/docs/dev/background-information/sg).
|
||||
Learn more about it [here](https://docs-legacy.sourcegraph.com/dev/background-information/sg).
|
||||
|
||||
@ -1,3 +1,3 @@
|
||||
# `sg` Vision
|
||||
|
||||
This page has moved to [`sg` vision](https://sourcegraph.com/docs/dev/background-information/sg/vision).
|
||||
This page has moved to [`sg` vision](https://docs-legacy.sourcegraph.com/dev/background-information/sg/vision).
|
||||
|
||||
@ -192,7 +192,7 @@ func SourcegraphDatabase(getConfig func() (*sgconf.Config, error)) CheckFunc {
|
||||
dsn := postgresdsn.New("", "", getEnv)
|
||||
|
||||
if err := pingPG(ctx, dsn); err != nil {
|
||||
return errors.Wrapf(err, "failed to connect to Sourcegraph Postgres database at %s. Please check the settings in sg.config.yml (see https://sourcegraph.com/docs/dev/background-information/sg#changing-database-configuration)", dsn)
|
||||
return errors.Wrapf(err, "failed to connect to Sourcegraph Postgres database at %s. Please check the settings in sg.config.yml (see https://docs-legacy.sourcegraph.com/dev/background-information/sg#changing-database-configuration)", dsn)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
@ -378,7 +378,7 @@ func DevPrivate(ctx context.Context) error {
|
||||
if !exists {
|
||||
std.Out.WriteLine(output.Styled(output.StyleWarning, "ERROR: dev-private repository not found!"))
|
||||
std.Out.WriteLine(output.Styledf(output.StyleWarning, "It's expected to exist at: %s", devPrivatePath))
|
||||
std.Out.WriteLine(output.Styled(output.StyleWarning, "See the documentation for how to get set up: https://sourcegraph.com/docs/dev/setup/quickstart#run-sg-setup"))
|
||||
std.Out.WriteLine(output.Styled(output.StyleWarning, "See the documentation for how to get set up: https://docs-legacy.sourcegraph.com/dev/setup/quickstart#run-sg-setup"))
|
||||
|
||||
std.Out.Write("")
|
||||
return exit.NewEmptyExitErr(1)
|
||||
|
||||
@ -68,7 +68,7 @@ func AddWithTemplate(database db.Database, migrationName, upMigrationFileTemplat
|
||||
block.Writef("Down query file: %s", rootRelative(files.DownFile))
|
||||
block.Writef("Metadata file: %s", rootRelative(files.MetadataFile))
|
||||
block.Close()
|
||||
line := output.Styled(output.StyleUnderline, "https://sourcegraph.com/docs/dev/background-information/sql/migrations")
|
||||
line := output.Styled(output.StyleUnderline, "https://docs-legacy.sourcegraph.com/dev/background-information/sql/migrations")
|
||||
line.Prefix = "Checkout the development docs for migrations: "
|
||||
std.Out.WriteLine(line)
|
||||
|
||||
|
||||
@ -76,7 +76,7 @@ func lintLoggingLibraries() *linter {
|
||||
return errors.Newf(`banned usage of '%s': use "github.com/sourcegraph/log" instead`,
|
||||
bannedImport)
|
||||
},
|
||||
HelpText: "Learn more about logging and why some libraries are banned: https://sourcegraph.com/docs/dev/how-to/add_logging",
|
||||
HelpText: "Learn more about logging and why some libraries are banned: https://docs-legacy.sourcegraph.com/dev/how-to/add_logging",
|
||||
})
|
||||
}
|
||||
|
||||
|
||||
@ -90,7 +90,7 @@ const sgBugReportTemplate = "https://github.com/sourcegraph/sourcegraph/issues/n
|
||||
// sg is the main sg CLI application.
|
||||
var sg = &cli.App{
|
||||
Usage: "The Sourcegraph developer tool!",
|
||||
Description: "Learn more: https://sourcegraph.com/docs/dev/background-information/sg",
|
||||
Description: "Learn more: https://docs-legacy.sourcegraph.com/dev/background-information/sg",
|
||||
Version: ReleaseName, // use friendly name as version
|
||||
Compiled: time.Now(),
|
||||
Flags: []cli.Flag{
|
||||
|
||||
@ -172,7 +172,7 @@ In order to be compliant with SOC2, you or someone from your team *must* documen
|
||||
2. Explain why no test plan was provided and why the PR wasn't reviewed before being merged.
|
||||
3. Close the issue.
|
||||
|
||||
Read more about [test plans](https://sourcegraph.com/docs/dev/background-information/testing_principles#test-plans) and [reviews](https://docs.sourcegraph.com/dev/background-information/pull_request_reviews).
|
||||
Read more about [test plans](https://docs-legacy.sourcegraph.com/dev/background-information/testing_principles#test-plans) and [reviews](https://docs.sourcegraph.com/dev/background-information/pull_request_reviews).
|
||||
{{""}}
|
||||
{{- range . }}
|
||||
- _{{ .CreatedAt }}_ @{{ .Author }}
|
||||
|
||||
@ -19,7 +19,7 @@ import (
|
||||
var monitoringCommand = &cli.Command{
|
||||
Name: "monitoring",
|
||||
Usage: "Sourcegraph's monitoring generator (dashboards, alerts, etc)",
|
||||
Description: `Learn more about the Sourcegraph monitoring generator here: https://sourcegraph.com/docs/dev/background-information/observability/monitoring-generator
|
||||
Description: `Learn more about the Sourcegraph monitoring generator here: https://docs-legacy.sourcegraph.com/dev/background-information/observability/monitoring-generator
|
||||
|
||||
Also refer to the generated reference documentation available for site admins:
|
||||
|
||||
|
||||
@ -23,7 +23,7 @@ It will be replaced with Telemetry V2 - code that is instrumented with the new
|
||||
Telemetry SDKs will automatically export safe telemetry in accordance with the
|
||||
Sourcegraph instance's allowed policies.
|
||||
|
||||
For more details, see https://sourcegraph.com/docs/dev/background-information/telemetry
|
||||
For more details, see https://docs-legacy.sourcegraph.com/dev/background-information/telemetry
|
||||
or reach out in #discuss-analytics.`
|
||||
|
||||
func renderTelemetryV1DeprecationWarning() {
|
||||
@ -50,7 +50,7 @@ var allowlistCommand = &cli.Command{
|
||||
Flags: []cli.Flag{},
|
||||
Description: `
|
||||
Utility that will generate SQL to add and remove events from the usage data allow list.
|
||||
https://sourcegraph.com/docs/dev/background-information/data-usage-pipeline#allow-list
|
||||
https://docs-legacy.sourcegraph.com/dev/background-information/data-usage-pipeline#allow-list
|
||||
|
||||
Events are keyed by event name and passed in as additional arguments to the add and remove subcommands.
|
||||
`,
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Sourcegraph cAdvisor
|
||||
|
||||
Learn more about the Sourcegraph cAdvisor distribution in the [cAdvisor documentation](https://sourcegraph.com/docs/dev/background-information/observability/cadvisor).
|
||||
Learn more about the Sourcegraph cAdvisor distribution in the [cAdvisor documentation](https://docs-legacy.sourcegraph.com/dev/background-information/observability/cadvisor).
|
||||
|
||||
## Updating the image
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
Vanilla Grafana image with provisioned Sourcegraph dashboards and config.
|
||||
|
||||
To learn more, refer to the [Sourcegraph observability developer guide](https://sourcegraph.com/docs/dev/background-information/observability) and [monitoring architecture](https://handbook.sourcegraph.com/engineering/observability/monitoring_architecture#sourcegraph-grafana).
|
||||
To learn more, refer to the [Sourcegraph observability developer guide](https://docs-legacy.sourcegraph.com/dev/background-information/observability) and [monitoring architecture](https://handbook.sourcegraph.com/engineering/observability/monitoring_architecture#sourcegraph-grafana).
|
||||
|
||||
## Image API
|
||||
|
||||
|
||||
@ -5,7 +5,7 @@ This distribution of the [OpenTelemetry collector](https://opentelemetry.io/docs
|
||||
- [selected integrations](#integrations) (receivers, exporters, and extensions) for the OpenTelemetry collector
|
||||
- [basic collector configuration](#configurations) that can be used out-of-the-box in `/etc/otel-collector/configs` with the `--config` flag for some common Sourcegraph deployment configurations.
|
||||
|
||||
This custom build undergoes Sourcegraph's [image vulnerability scanning](https://sourcegraph.com/docs/dev/background-information/ci#image-vulnerability-scanning) to audit the bundled dependencies.
|
||||
This custom build undergoes Sourcegraph's [image vulnerability scanning](https://docs-legacy.sourcegraph.com/dev/background-information/ci#image-vulnerability-scanning) to audit the bundled dependencies.
|
||||
|
||||
To get started:
|
||||
|
||||
|
||||
@ -5,7 +5,7 @@ The `sourcegraph/prometheus` image provides an all-in-one image through `prom-wr
|
||||
- Vanilla Prometheus with embedded Sourcegraph configuration
|
||||
- Bundled Alertmanager with a `siteConfigSubscriber` sidecar service to automatically apply relevant configuration changes to Alertmanager
|
||||
|
||||
To learn more, refer to the [Sourcegraph observability developer guide](https://sourcegraph.com/docs/dev/background-information/observability) and [monitoring architecture](https://handbook.sourcegraph.com/engineering/observability/monitoring_architecture#sourcegraph-prometheus).
|
||||
To learn more, refer to the [Sourcegraph observability developer guide](https://docs-legacy.sourcegraph.com/dev/background-information/observability) and [monitoring architecture](https://handbook.sourcegraph.com/engineering/observability/monitoring_architecture#sourcegraph-prometheus).
|
||||
|
||||
## Image API
|
||||
|
||||
|
||||
@ -1,3 +1,3 @@
|
||||
# prom-wrapper
|
||||
|
||||
Prom-wrapper is a service that ships with the [Sourcegraph Prometheus image](https://sourcegraph.com/docs/dev/background-information/observability/prometheus).
|
||||
Prom-wrapper is a service that ships with the [Sourcegraph Prometheus image](https://docs-legacy.sourcegraph.com/dev/background-information/observability/prometheus).
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
// Command prom-wrapper provides a wrapper command for Prometheus that
|
||||
// also handles Sourcegraph configuration changes and making changes to Prometheus.
|
||||
//
|
||||
// See https://sourcegraph.com/docs/dev/background-information/observability/prometheus
|
||||
// See https://docs-legacy.sourcegraph.com/dev/background-information/observability/prometheus
|
||||
package main
|
||||
|
||||
import (
|
||||
|
||||
2
go.mod
2
go.mod
@ -8,7 +8,7 @@ go 1.22.1
|
||||
// or intentional forks.
|
||||
replace (
|
||||
// We use a fork of Alertmanager to allow prom-wrapper to better manipulate Alertmanager configuration.
|
||||
// See https://sourcegraph.com/docs/dev/background-information/observability/prometheus
|
||||
// See https://docs-legacy.sourcegraph.com/dev/background-information/observability/prometheus
|
||||
github.com/prometheus/alertmanager => github.com/sourcegraph/alertmanager v0.21.1-0.20211110092431-863f5b1ee51b
|
||||
// We publish 'dev/ci/images' as a package for import in other tooling.
|
||||
// When developing Sourcegraph itself, this replace uses the local package instead of a pushed version.
|
||||
|
||||
@ -21,7 +21,7 @@ const (
|
||||
// record have a special meaning assigned to them by
|
||||
// the queries dbworker performs. You can read more
|
||||
// about the different fields and what they do here:
|
||||
// https://sourcegraph.com/docs/dev/background-information/workers#database-backed-stores
|
||||
// https://docs-legacy.sourcegraph.com/dev/background-information/workers#database-backed-stores
|
||||
type SyntacticIndexingJob struct {
|
||||
ID int `json:"id"`
|
||||
State recordState `json:"state"`
|
||||
|
||||
@ -236,7 +236,7 @@ func dbConn(logger log.Logger, t testing.TB, cfg *url.URL, schemas ...*schemas.S
|
||||
t.Fatalf(`failed to connect to database %q: %s
|
||||
PROTIP: Ensure the below is part of the go_test rule in BUILD.bazel
|
||||
tags = ["requires-network"]
|
||||
See https://sourcegraph.com/docs/dev/background-information/bazel/faq#tests-fail-with-connection-refused`, cfg, err)
|
||||
See https://docs-legacy.sourcegraph.com/dev/background-information/bazel/faq#tests-fail-with-connection-refused`, cfg, err)
|
||||
}
|
||||
t.Fatalf("failed to connect to database %q: %s", cfg, err)
|
||||
}
|
||||
|
||||
@ -51,13 +51,13 @@ type EventLogStore interface {
|
||||
// we never drop events once we attempt to store it.
|
||||
//
|
||||
// Deprecated: Use EventRecorder from internal/telemetryrecorder instead.
|
||||
// Learn more: https://sourcegraph.com/docs/dev/background-information/telemetry
|
||||
// Learn more: https://docs-legacy.sourcegraph.com/dev/background-information/telemetry
|
||||
BulkInsert(ctx context.Context, events []*Event) error
|
||||
|
||||
// Insert is a legacy mechanism for inserting a single event.
|
||||
//
|
||||
// Deprecated: Use EventRecorder from internal/telemetryrecorder instead.
|
||||
// Learn more: https://sourcegraph.com/docs/dev/background-information/telemetry
|
||||
// Learn more: https://docs-legacy.sourcegraph.com/dev/background-information/telemetry
|
||||
Insert(ctx context.Context, e *Event) error
|
||||
|
||||
// CodeIntelligenceCrossRepositoryWAUs returns the WAU (current week) with any (precise or search-based) cross-repository code intelligence event.
|
||||
|
||||
@ -13,7 +13,7 @@ var GracefulShutdownTimeout = env.MustGetDuration("SRC_GRACEFUL_SHUTDOWN_TIMEOUT
|
||||
// running process with a graceful shutdown mechanism.
|
||||
//
|
||||
// See
|
||||
// https://sourcegraph.com/docs/dev/background-information/backgroundroutine
|
||||
// https://docs-legacy.sourcegraph.com/dev/background-information/backgroundroutine
|
||||
// for more information and a step-by-step guide on how to implement a
|
||||
// BackgroundRoutine.
|
||||
type BackgroundRoutine = background.Routine
|
||||
|
||||
@ -24,7 +24,7 @@ type (
|
||||
// PeriodicGoroutine represents a goroutine whose main behavior is reinvoked periodically.
|
||||
//
|
||||
// See
|
||||
// https://sourcegraph.com/docs/dev/background-information/backgroundroutine
|
||||
// https://docs-legacy.sourcegraph.com/dev/background-information/backgroundroutine
|
||||
// for more information and a step-by-step guide on how to implement a
|
||||
// PeriodicBackgroundRoutine.
|
||||
type PeriodicGoroutine struct {
|
||||
|
||||
@ -292,7 +292,7 @@ func (c *Client) GraphQL(token, query string, variables map[string]any, target a
|
||||
req.Header.Set("Authorization", fmt.Sprintf("token %s", token))
|
||||
} else {
|
||||
// NOTE: This header is required to authenticate our session with a session cookie, see:
|
||||
// https://sourcegraph.com/docs/dev/security/csrf_security_model#authentication-in-api-endpoints
|
||||
// https://docs-legacy.sourcegraph.com/dev/security/csrf_security_model#authentication-in-api-endpoints
|
||||
req.Header.Set("X-Requested-With", "Sourcegraph")
|
||||
req.AddCookie(c.sessionCookie)
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ func (s *ComputeStreamClient) Compute(query string) ([]MatchContext, error) {
|
||||
return nil, err
|
||||
}
|
||||
// Note: Sending this header enables us to use session cookie auth without sending a trusted Origin header.
|
||||
// https://sourcegraph.com/docs/dev/security/csrf_security_model#authentication-in-api-endpoints
|
||||
// https://docs-legacy.sourcegraph.com/dev/security/csrf_security_model#authentication-in-api-endpoints
|
||||
req.Header.Set("X-Requested-With", "Sourcegraph")
|
||||
s.Client.addCookies(req)
|
||||
|
||||
|
||||
@ -701,7 +701,7 @@ func (s *SearchStreamClient) search(query string, dec streamhttp.FrontendStreamD
|
||||
return err
|
||||
}
|
||||
// Note: Sending this header enables us to use session cookie auth without sending a trusted Origin header.
|
||||
// https://sourcegraph.com/docs/dev/security/csrf_security_model#authentication-in-api-endpoints
|
||||
// https://docs-legacy.sourcegraph.com/dev/security/csrf_security_model#authentication-in-api-endpoints
|
||||
req.Header.Set("X-Requested-With", "Sourcegraph")
|
||||
s.Client.addCookies(req)
|
||||
|
||||
|
||||
@ -61,7 +61,7 @@ func condensedFormat(r *log15.Record) []byte {
|
||||
|
||||
// Options control the behavior of a tracer.
|
||||
//
|
||||
// Deprecated: All logging should use github.com/sourcegraph/log instead. See https://sourcegraph.com/docs/dev/how-to/add_logging
|
||||
// Deprecated: All logging should use github.com/sourcegraph/log instead. See https://docs-legacy.sourcegraph.com/dev/how-to/add_logging
|
||||
type Options struct {
|
||||
filters []func(*log15.Record) bool
|
||||
serviceName string
|
||||
@ -70,17 +70,17 @@ type Options struct {
|
||||
// If this idiom seems strange:
|
||||
// https://github.com/tmrts/go-patterns/blob/master/idiom/functional-options.md
|
||||
//
|
||||
// Deprecated: All logging should use github.com/sourcegraph/log instead. See https://sourcegraph.com/docs/dev/how-to/add_logging
|
||||
// Deprecated: All logging should use github.com/sourcegraph/log instead. See https://docs-legacy.sourcegraph.com/dev/how-to/add_logging
|
||||
type Option func(*Options)
|
||||
|
||||
// Deprecated: All logging should use github.com/sourcegraph/log instead. See https://sourcegraph.com/docs/dev/how-to/add_logging
|
||||
// Deprecated: All logging should use github.com/sourcegraph/log instead. See https://docs-legacy.sourcegraph.com/dev/how-to/add_logging
|
||||
func ServiceName(s string) Option {
|
||||
return func(o *Options) {
|
||||
o.serviceName = s
|
||||
}
|
||||
}
|
||||
|
||||
// Deprecated: All logging should use github.com/sourcegraph/log instead. See https://sourcegraph.com/docs/dev/how-to/add_logging
|
||||
// Deprecated: All logging should use github.com/sourcegraph/log instead. See https://docs-legacy.sourcegraph.com/dev/how-to/add_logging
|
||||
func Filter(f func(*log15.Record) bool) Option {
|
||||
return func(o *Options) {
|
||||
o.filters = append(o.filters, f)
|
||||
@ -94,7 +94,7 @@ func init() {
|
||||
|
||||
// For severity field, see https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry
|
||||
//
|
||||
// Deprecated: All logging should use github.com/sourcegraph/log instead. See https://sourcegraph.com/docs/dev/how-to/add_logging
|
||||
// Deprecated: All logging should use github.com/sourcegraph/log instead. See https://docs-legacy.sourcegraph.com/dev/how-to/add_logging
|
||||
func LogEntryLevelString(l log15.Lvl) string {
|
||||
switch l {
|
||||
case log15.LvlDebug:
|
||||
@ -115,7 +115,7 @@ func LogEntryLevelString(l log15.Lvl) string {
|
||||
// Init initializes log15's root logger based on Sourcegraph-wide logging configuration
|
||||
// variables. See https://sourcegraph.com/docs/admin/observability/logs
|
||||
//
|
||||
// Deprecated: All logging should use github.com/sourcegraph/log instead. See https://sourcegraph.com/docs/dev/how-to/add_logging
|
||||
// Deprecated: All logging should use github.com/sourcegraph/log instead. See https://docs-legacy.sourcegraph.com/dev/how-to/add_logging
|
||||
func Init(options ...Option) {
|
||||
opts := &Options{}
|
||||
for _, setter := range options {
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
// Package observation provides a unified way to wrap an operation with logging, tracing, and metrics.
|
||||
//
|
||||
// To learn more, refer to "How to add observability": https://sourcegraph.com/docs/dev/how-to/add_observability
|
||||
// To learn more, refer to "How to add observability": https://docs-legacy.sourcegraph.com/dev/how-to/add_observability
|
||||
package observation
|
||||
|
||||
import (
|
||||
|
||||
@ -86,19 +86,19 @@ var docsPatterns = []struct {
|
||||
PathPattern: regexp.MustCompile(`\.tsx?$`),
|
||||
ContentPattern: regexp.MustCompile(`eventLogger.log(?:ViewEvent)?`),
|
||||
Title: "Telemetry",
|
||||
URL: "https://sourcegraph.com/docs/dev/background-information/telemetry#sourcegraph-web-app",
|
||||
URL: "https://docs-legacy.sourcegraph.com/dev/background-information/telemetry#sourcegraph-web-app",
|
||||
},
|
||||
{
|
||||
Id: "css",
|
||||
PathPattern: regexp.MustCompile(`\.tsx?$`),
|
||||
ContentPattern: regexp.MustCompile(`import styles from.*\.module\.s?css'`),
|
||||
Title: "CSS in client/web",
|
||||
URL: "https://sourcegraph.com/docs/dev/background-information/web/styling",
|
||||
URL: "https://docs-legacy.sourcegraph.com/dev/background-information/web/styling",
|
||||
},
|
||||
{
|
||||
Id: "bazel",
|
||||
PathPattern: regexp.MustCompile(`(^|/)BUILD\.bazel$`),
|
||||
Title: "Bazel at Sourcegraph",
|
||||
URL: "https://sourcegraph.com/docs/dev/background-information/bazel",
|
||||
URL: "https://docs-legacy.sourcegraph.com/dev/background-information/bazel",
|
||||
},
|
||||
}
|
||||
|
||||
@ -139,7 +139,7 @@ func (l *LogJob) logEvent(ctx context.Context, clients job.RuntimeClients, durat
|
||||
}
|
||||
// Only log the time if we successfully resolved one search type.
|
||||
if len(types) == 1 {
|
||||
// New events that get exported: https://sourcegraph.com/docs/dev/background-information/telemetry
|
||||
// New events that get exported: https://docs-legacy.sourcegraph.com/dev/background-information/telemetry
|
||||
events := telemetryrecorder.NewBestEffort(clients.Logger, clients.DB)
|
||||
// For now, do not tee into event_logs in telemetryrecorder - retain the
|
||||
// custom instrumentation of V1 events instead (usagestats.LogBackendEvent)
|
||||
|
||||
@ -50,7 +50,7 @@ func (s *fakeEventLogStore) loggedEventNames() []string {
|
||||
func TestOwnSearchEventNames(t *testing.T) {
|
||||
type wantEvents struct {
|
||||
legacy []string // we retain manual instrumentation of existing events
|
||||
new []string // https://sourcegraph.com/docs/dev/background-information/telemetry
|
||||
new []string // https://docs-legacy.sourcegraph.com/dev/background-information/telemetry
|
||||
}
|
||||
for literal, wantEventNames := range map[string]wantEvents{
|
||||
"file:has.owner(one@example.com)": {
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
// Package srcprometheus defines an API to interact with Sourcegraph Prometheus, including
|
||||
// prom-wrapper. See https://sourcegraph.com/docs/dev/background-information/observability/prometheus
|
||||
// prom-wrapper. See https://docs-legacy.sourcegraph.com/dev/background-information/observability/prometheus
|
||||
package srcprometheus
|
||||
|
||||
import (
|
||||
@ -24,7 +24,7 @@ var ErrPrometheusUnavailable = errors.New("prometheus API is unavailable")
|
||||
var PrometheusURL = env.Get("PROMETHEUS_URL", "", "prometheus server URL")
|
||||
|
||||
// Client provides the interface for interacting with Sourcegraph Prometheus, including
|
||||
// prom-wrapper. See https://sourcegraph.com/docs/dev/background-information/observability/prometheus
|
||||
// prom-wrapper. See https://docs-legacy.sourcegraph.com/dev/background-information/observability/prometheus
|
||||
type Client interface {
|
||||
GetAlertsStatus(ctx context.Context) (*AlertsStatus, error)
|
||||
GetConfigStatus(ctx context.Context) (*ConfigStatus, error)
|
||||
@ -40,7 +40,7 @@ type client struct {
|
||||
// Users should check for the latter case by asserting against `ErrPrometheusUnavailable`
|
||||
// to avoid rendering an error.
|
||||
//
|
||||
// See https://sourcegraph.com/docs/dev/background-information/observability/prometheus
|
||||
// See https://docs-legacy.sourcegraph.com/dev/background-information/observability/prometheus
|
||||
func NewClient(prometheusURL string) (Client, error) {
|
||||
if prometheusURL == "" {
|
||||
return nil, ErrPrometheusUnavailable
|
||||
|
||||
@ -29,7 +29,7 @@ func TestGetBatchChangesUsageStatistics(t *testing.T) {
|
||||
esStore := db.ExternalServices()
|
||||
|
||||
// making use of a mock clock here to ensure all time operations are appropriately mocked
|
||||
// https://sourcegraph.com/docs/dev/background-information/languages/testing_go_code#testing-time
|
||||
// https://docs-legacy.sourcegraph.com/dev/background-information/languages/testing_go_code#testing-time
|
||||
clock := glock.NewMockClock()
|
||||
now := clock.Now()
|
||||
|
||||
|
||||
@ -68,7 +68,7 @@ type Event struct {
|
||||
// LogBackendEvent is a convenience function for logging backend events.
|
||||
//
|
||||
// Deprecated: Use EventRecorder from internal/telemetryrecorder instead.
|
||||
// Learn more: https://sourcegraph.com/docs/dev/background-information/telemetry
|
||||
// Learn more: https://docs-legacy.sourcegraph.com/dev/background-information/telemetry
|
||||
func LogBackendEvent(db database.DB, userID int32, deviceID, eventName string, argument, publicArgument json.RawMessage, evaluatedFlagSet featureflag.EvaluatedFlagSet, cohortID *string) error {
|
||||
insertID, _ := uuid.NewRandom()
|
||||
insertIDFinal := insertID.String()
|
||||
@ -106,7 +106,7 @@ func LogBackendEvent(db database.DB, userID int32, deviceID, eventName string, a
|
||||
// LogEvent logs an event.
|
||||
//
|
||||
// Deprecated: Use EventRecorder from internal/telemetryrecorder instead.
|
||||
// Learn more: https://sourcegraph.com/docs/dev/background-information/telemetry
|
||||
// Learn more: https://docs-legacy.sourcegraph.com/dev/background-information/telemetry
|
||||
func LogEvent(ctx context.Context, db database.DB, args Event) error {
|
||||
//lint:ignore SA1019 existing usage of deprecated functionality.
|
||||
return LogEvents(ctx, db, []Event{args})
|
||||
@ -115,7 +115,7 @@ func LogEvent(ctx context.Context, db database.DB, args Event) error {
|
||||
// LogEvents logs a batch of events.
|
||||
//
|
||||
// Deprecated: Use EventRecorder from internal/telemetryrecorder instead.
|
||||
// Learn more: https://sourcegraph.com/docs/dev/background-information/telemetry
|
||||
// Learn more: https://docs-legacy.sourcegraph.com/dev/background-information/telemetry
|
||||
func LogEvents(ctx context.Context, db database.DB, events []Event) error {
|
||||
if !conf.EventLoggingEnabled() {
|
||||
return nil
|
||||
|
||||
@ -18,7 +18,7 @@ Up migrations will happen automatically in development on service startup. In pr
|
||||
|
||||
## Adding a migration
|
||||
|
||||
**IMPORTANT:** All migrations must be backwards-compatible, meaning that _existing_ code must be able to operate successfully against the _new_ (post-migration) database schema. Consult [_Writing database migrations_](https://sourcegraph.com/docs/dev/background-information/sql/migrations) in our developer documentation for additional context.
|
||||
**IMPORTANT:** All migrations must be backwards-compatible, meaning that _existing_ code must be able to operate successfully against the _new_ (post-migration) database schema. Consult [_Writing database migrations_](https://docs-legacy.sourcegraph.com/dev/background-information/sql/migrations) in our developer documentation for additional context.
|
||||
|
||||
To create a new migration file, run the following command.
|
||||
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
# Sourcegraph monitoring generator
|
||||
|
||||
This page documents usage (running the generator) and development (of the generator itself).
|
||||
For background and feature documentation, see [the generator overview](https://sourcegraph.com/docs/dev/background-information/observability/monitoring-generator).
|
||||
To learn about how to find, add, and use monitoring, see the [Sourcegraph observability developer guide](https://sourcegraph.com/docs/dev/background-information/observability).
|
||||
For background and feature documentation, see [the generator overview](https://docs-legacy.sourcegraph.com/dev/background-information/observability/monitoring-generator).
|
||||
To learn about how to find, add, and use monitoring, see the [Sourcegraph observability developer guide](https://docs-legacy.sourcegraph.com/dev/background-information/observability).
|
||||
|
||||
## Usage
|
||||
|
||||
@ -22,8 +22,8 @@ The Sourcegraph monitoring generator consists of three components:
|
||||
- The [main program](./main.go) - this is the primary entrypoint to the generator.
|
||||
- _Definitions_, defined in the top-level [`monitoring/definitions` package](./definitions/).
|
||||
This is where the all service monitoring definitions lives.
|
||||
If you are editing monitoring, this is probably where you want to look - see the [Sourcegraph observability developer guide](https://sourcegraph.com/docs/dev/background-information/observability).
|
||||
If you are editing monitoring, this is probably where you want to look - see the [Sourcegraph observability developer guide](https://docs-legacy.sourcegraph.com/dev/background-information/observability).
|
||||
- _Generator_, defined in the nested [`monitoring/monitoring` package](./monitoring/README.md) package.
|
||||
This is where the API for service monitoring definitions is defined, as well as the generator code that provides [its features](https://sourcegraph.com/docs/dev/background-information/observability/monitoring-generator#features).
|
||||
This is where the API for service monitoring definitions is defined, as well as the generator code that provides [its features](https://docs-legacy.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://handbook.sourcegraph.com/engineering/observability/monitoring_pillars).
|
||||
|
||||
@ -18,7 +18,7 @@ func Telemetry() *monitoring.Dashboard {
|
||||
Title: "Telemetry",
|
||||
Description: "Monitoring telemetry services in Sourcegraph.",
|
||||
Groups: []monitoring.Group{
|
||||
// The new stuff - https://sourcegraph.com/docs/dev/background-information/telemetry
|
||||
// The new stuff - https://docs-legacy.sourcegraph.com/dev/background-information/telemetry
|
||||
{
|
||||
Title: "Telemetry Gateway Exporter: Export and queue metrics",
|
||||
Rows: []monitoring.Row{
|
||||
|
||||
@ -7,6 +7,6 @@ import "github.com/sourcegraph/sourcegraph/monitoring/monitoring"
|
||||
Package monitoring declares the API for Sourcegraph's monitoring definitions as well as the monitoring generator implementation itself.
|
||||
For more details about this package, refer to the [API documentation](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/docs/monitoring/monitoring).
|
||||
|
||||
To learn more about developing monitoring for Sourcegraph, refer to [the observability developer's guide](https://sourcegraph.com/docs/dev/background-information/observability).
|
||||
To learn more about developing monitoring for Sourcegraph, refer to [the observability developer's guide](https://docs-legacy.sourcegraph.com/dev/background-information/observability).
|
||||
|
||||
To learn more about the Sourcegraph monitoring generator, refer to [the monitoring generator overview](https://sourcegraph.com/docs/dev/background-information/observability/monitoring-generator).
|
||||
To learn more about the Sourcegraph monitoring generator, refer to [the monitoring generator overview](https://docs-legacy.sourcegraph.com/dev/background-information/observability/monitoring-generator).
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
/*
|
||||
Package monitoring declares the API for Sourcegraph's monitoring definitions as well as the monitoring generator implementation itself.
|
||||
|
||||
To learn more about developing monitoring for Sourcegraph, refer to https://sourcegraph.com/docs/dev/background-information/observability.
|
||||
To learn more about developing monitoring for Sourcegraph, refer to https://docs-legacy.sourcegraph.com/dev/background-information/observability.
|
||||
|
||||
To learn more about the Sourcegraph monitoring generator, refer to https://sourcegraph.com/docs/dev/background-information/observability/monitoring-generator.
|
||||
To learn more about the Sourcegraph monitoring generator, refer to https://docs-legacy.sourcegraph.com/dev/background-information/observability/monitoring-generator.
|
||||
*/
|
||||
package monitoring
|
||||
|
||||
@ -185,7 +185,7 @@ func (c *Dashboard) renderDashboard(injectLabelMatchers []*labels.Matcher, folde
|
||||
description.TextPanel.Content = fmt.Sprintf(`
|
||||
<div style="text-align: left;">
|
||||
<img src="https://sourcegraphstatic.com/sourcegraph-logo-light.png" style="height:30px; margin:0.5rem"></img>
|
||||
<div style="margin-left: 1rem; margin-top: 0.5rem; font-size: 20px;"><b>%s:</b> %s <a style="font-size: 15px" target="_blank" href="https://sourcegraph.com/docs/dev/background-information/architecture">(⧉ architecture diagram)</a></span>
|
||||
<div style="margin-left: 1rem; margin-top: 0.5rem; font-size: 20px;"><b>%s:</b> %s <a style="font-size: 15px" target="_blank" href="https://docs-legacy.sourcegraph.com/dev/background-information/architecture">(⧉ architecture diagram)</a></span>
|
||||
</div>
|
||||
`, c.Name, c.Description)
|
||||
board.Panels = append(board.Panels, description)
|
||||
|
||||
@ -2783,7 +2783,7 @@ type SiteConfiguration struct {
|
||||
CodyEnabled *bool `json:"cody.enabled,omitempty"`
|
||||
// CodyPermissions description: Whether to enable Cody role-based access controls. Only respected if cody.restrictUsersFeatureFlag is not set. See https://sourcegraph.com/docs/admin/access_control
|
||||
CodyPermissions *bool `json:"cody.permissions,omitempty"`
|
||||
// CodyRestrictUsersFeatureFlag description: DEPRECATED; see cody.permissions instead. PRIOR DESCRIPTION: Cody to only be enabled for users that have a feature flag labeled "cody" set to true. You must create a feature flag with this ID after enabling this setting: https://sourcegraph.com/docs/dev/how-to/use_feature_flags#create-a-feature-flag. This setting only has an effect if cody.enabled is true.
|
||||
// CodyRestrictUsersFeatureFlag description: DEPRECATED; see cody.permissions instead. PRIOR DESCRIPTION: Cody to only be enabled for users that have a feature flag labeled "cody" set to true. You must create a feature flag with this ID after enabling this setting: https://docs-legacy.sourcegraph.com/dev/how-to/use_feature_flags#create-a-feature-flag. This setting only has an effect if cody.enabled is true.
|
||||
CodyRestrictUsersFeatureFlag *bool `json:"cody.restrictUsersFeatureFlag,omitempty"`
|
||||
// Completions description: Configuration for the completions service.
|
||||
Completions *Completions `json:"completions,omitempty"`
|
||||
|
||||
@ -2650,7 +2650,7 @@
|
||||
"group": "Cody"
|
||||
},
|
||||
"cody.restrictUsersFeatureFlag": {
|
||||
"description": "DEPRECATED; see cody.permissions instead. PRIOR DESCRIPTION: Cody to only be enabled for users that have a feature flag labeled \"cody\" set to true. You must create a feature flag with this ID after enabling this setting: https://sourcegraph.com/docs/dev/how-to/use_feature_flags#create-a-feature-flag. This setting only has an effect if cody.enabled is true.",
|
||||
"description": "DEPRECATED; see cody.permissions instead. PRIOR DESCRIPTION: Cody to only be enabled for users that have a feature flag labeled \"cody\" set to true. You must create a feature flag with this ID after enabling this setting: https://docs-legacy.sourcegraph.com/dev/how-to/use_feature_flags#create-a-feature-flag. This setting only has an effect if cody.enabled is true.",
|
||||
"type": "boolean",
|
||||
"default": false,
|
||||
"!go": {
|
||||
|
||||
@ -300,7 +300,7 @@ commands:
|
||||
checkBinary: .bin/cody-gateway
|
||||
env:
|
||||
CODY_GATEWAY_ANTHROPIC_ACCESS_TOKEN: foobar
|
||||
# Set in override if you want to test local Cody Gateway: https://sourcegraph.com/docs/dev/how-to/cody_gateway
|
||||
# Set in override if you want to test local Cody Gateway: https://docs-legacy.sourcegraph.com/dev/how-to/cody_gateway
|
||||
CODY_GATEWAY_DOTCOM_ACCESS_TOKEN: ''
|
||||
CODY_GATEWAY_DOTCOM_API_URL: https://sourcegraph.test:3443/.api/graphql
|
||||
CODY_GATEWAY_ALLOW_ANONYMOUS: true
|
||||
@ -991,7 +991,7 @@ bazelCommands:
|
||||
target: //cmd/cody-gateway
|
||||
env:
|
||||
CODY_GATEWAY_ANTHROPIC_ACCESS_TOKEN: foobar
|
||||
# Set in override if you want to test local Cody Gateway: https://sourcegraph.com/docs/dev/how-to/cody_gateway
|
||||
# Set in override if you want to test local Cody Gateway: https://docs-legacy.sourcegraph.com/dev/how-to/cody_gateway
|
||||
CODY_GATEWAY_DOTCOM_ACCESS_TOKEN: ''
|
||||
CODY_GATEWAY_DOTCOM_API_URL: https://sourcegraph.test:3443/.api/graphql
|
||||
CODY_GATEWAY_ALLOW_ANONYMOUS: true
|
||||
@ -1832,7 +1832,7 @@ tests:
|
||||
A Sourcegraph isntance must be already running for these tests to work, most
|
||||
commonly with: `sg start enterprise-e2e`
|
||||
|
||||
See more details: https://sourcegraph.com/docs/dev/how-to/testing#running-end-to-end-tests
|
||||
See more details: https://docs-legacy.sourcegraph.com/dev/how-to/testing#running-end-to-end-tests
|
||||
cmd: pnpm test-e2e
|
||||
env:
|
||||
TEST_USER_EMAIL: test@sourcegraph.com
|
||||
@ -1849,7 +1849,7 @@ tests:
|
||||
A Sourcegraph instance must be already running for these tests to work, most
|
||||
commonly with: `sg start enterprise-e2e`
|
||||
|
||||
See more details: https://sourcegraph.com/docs/dev/how-to/testing#running-regression-tests
|
||||
See more details: https://docs-legacy.sourcegraph.com/dev/how-to/testing#running-regression-tests
|
||||
|
||||
cmd: pnpm test-regression
|
||||
env:
|
||||
@ -1863,7 +1863,7 @@ tests:
|
||||
A web application should be built for these tests to work, most
|
||||
commonly with: `sg run web-integration-build` or `sg run web-integration-build-prod` for production build.
|
||||
|
||||
See more details: https://sourcegraph.com/docs/dev/how-to/testing#running-integration-tests
|
||||
See more details: https://docs-legacy.sourcegraph.com/dev/how-to/testing#running-integration-tests
|
||||
|
||||
cmd: pnpm test-integration
|
||||
|
||||
@ -1872,6 +1872,6 @@ tests:
|
||||
A Sourcegraph instance must be already running for these tests to work, most
|
||||
commonly with: `sg start web-standalone`
|
||||
|
||||
See more details: https://sourcegraph.com/docs/dev/how-to/testing#running-integration-tests
|
||||
See more details: https://docs-legacy.sourcegraph.com/dev/how-to/testing#running-integration-tests
|
||||
|
||||
cmd: pnpm test-integration:debug
|
||||
|
||||
@ -13,7 +13,7 @@ The structure of this directory is:
|
||||
|
||||
## Getting started
|
||||
|
||||
See the [Add and Update Wolfi Base Images](https://sourcegraph.com/docs/dev/how-to/wolfi/add_update_images) docs for guides to add new images and updating existing images. For more background, see the [Wolfi](https://sourcegraph.com/docs/dev/background-information/wolfi#wolfi) docs.
|
||||
See the [Add and Update Wolfi Base Images](https://docs-legacy.sourcegraph.com/dev/how-to/wolfi/add_update_images) docs for guides to add new images and updating existing images. For more background, see the [Wolfi](https://docs-legacy.sourcegraph.com/dev/background-information/wolfi#wolfi) docs.
|
||||
|
||||
### Quickstart
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user