Skip to content
This repository was archived by the owner on Sep 30, 2024. It is now read-only.

Commit e85028b

Browse files
authored
fix: update links for dev docs (#62758)
* fix: license checker info is in docs-legacy * fix: update remaining dev links
1 parent 5022b91 commit e85028b

File tree

73 files changed

+113
-113
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+113
-113
lines changed

.github/workflows/licenses-update.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ jobs:
3939
team-reviewers: 'team-dev-infra'
4040
body: |
4141
This is an automated pull request generated by [this run](https://github.com/sourcegraph/sourcegraph/actions/runs/${{ github.run_id }}).
42-
Learn more about our GitHub Actions for managing licenses [here](https://docs.sourcegraph.com/dev/background-information/ci#third-party-licenses).
42+
Learn more about our GitHub Actions for managing licenses [here](https://docs-legacy.sourcegraph.com/dev/background-information/ci#third-party-licenses).
4343
4444
You're safe to merge this pull request when the required checks are passing.
4545

CONTRIBUTING.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ All interactions with the Sourcegraph open source project are governed by the
1919

2020
1. Select one of the issues labeled as [good first issue](https://github.com/orgs/sourcegraph/projects/210).
2121
2. Clone the repo: `git clone https://github.com/sourcegraph/sourcegraph`.
22-
3. [Set up your development environment](https://sourcegraph.com/docs/dev/setup/quickstart) to run the project locally.
23-
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.
22+
3. [Set up your development environment](https://docs-legacy.sourcegraph.com/dev/setup/quickstart) to run the project locally.
23+
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.
2424
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.
25-
- 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.
25+
- 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.
2626
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.
2727
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.
2828
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
3737
### Getting applications up and running
3838

3939
- [Getting Started Guide](https://sourcegraph.com/docs/getting-started)
40-
- [Troubleshooting section](https://sourcegraph.com/docs/dev/setup/troubleshooting)
40+
- [Troubleshooting section](https://docs-legacy.sourcegraph.com/dev/setup/troubleshooting)
4141

4242
### How to write tests
4343

44-
- [How to write tests](https://sourcegraph.com/docs/dev/how-to/testing)
45-
- [Testing principles](https://sourcegraph.com/docs/dev/background-information/testing_principles)
46-
- [Testing web code](https://sourcegraph.com/docs/dev/background-information/testing_web_code)
44+
- [How to write tests](https://docs-legacy.sourcegraph.com/dev/how-to/testing)
45+
- [Testing principles](https://docs-legacy.sourcegraph.com/dev/background-information/testing_principles)
46+
- [Testing web code](https://docs-legacy.sourcegraph.com/dev/background-information/testing_web_code)
4747

4848
### Pull Requests
4949

50-
- [How to structure](https://sourcegraph.com/docs/dev/background-information/pull_request_reviews#what-makes-an-effective-pull-request-pr)
50+
- [How to structure](https://docs-legacy.sourcegraph.com/dev/background-information/pull_request_reviews#what-makes-an-effective-pull-request-pr)
5151
- Git branch name convention: `[developer-initials]/short-feature-description`
5252
- [Examples on Github](https://github.com/sourcegraph/sourcegraph/pulls?q=is%3Apr+label%3Ateam%2Ffrontend-platform)
53-
- (For Sourcegraph team) [How to accept contributions](https://sourcegraph.com/docs/dev/contributing/accepting_contribution)
53+
- (For Sourcegraph team) [How to accept contributions](https://docs-legacy.sourcegraph.com/dev/contributing/accepting_contribution)

client/browser/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ The test suite in `end-to-end/github.test.ts` runs on the release branch `bext/r
135135

136136
The test suite in end-to-end/phabricator.test.ts tests the Phabricator native integration.
137137
It assumes an existing Sourcegraph and Phabricator instance that has the Phabricator extension installed.
138-
There are automated scripts to set up the Phabricator instance, see https://sourcegraph.com/docs/dev/phabricator_gitolite.
138+
There are automated scripts to set up the Phabricator instance, see https://docs-legacy.sourcegraph.com/dev/phabricator_gitolite.
139139
It currently does not run in CI and is intended to be run manually for release testing.
140140

141141
`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
243243
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`)
244244
5. Navigated to `http://127.0.0.1/config/group/sourcegraph/` (Config -> Application Settings -> Sourcegraph)
245245
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).
246-
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):
246+
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):
247247
- Navigated to `http://127.0.0.1/diffusion/edit/?vcs=git`
248248
- Created a repository with name `JsonRPC2`, callsign `JRPC`, short name `jrpc`
249249
- Navigated to `http://127.0.0.1/source/jrpc/manage/uris/` (URIs)

client/browser/src/end-to-end/phabricator.test.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ async function configureSourcegraphIntegration(driver: Driver): Promise<void> {
9797
await driver.page.waitForSelector('a[href="/config/group/sourcegraph/"]', { timeout: 2000 })
9898
} catch {
9999
throw new Error(
100-
`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`
100+
`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`
101101
)
102102
}
103103

client/shared/src/platform/context.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ export interface PlatformContext {
9797
* Returns promise that resolves into Apollo Client instance after cache restoration.
9898
* Only `watchQuery` is available till https://github.com/sourcegraph/sourcegraph/issues/24953 is implemented.
9999
*
100-
* @deprecated Use [Apollo](https://sourcegraph.com/docs/dev/background-information/web/graphql#graphql-client) instead
100+
* @deprecated Use [Apollo](https://docs-legacy.sourcegraph.com/dev/background-information/web/graphql#graphql-client) instead
101101
*/
102102
getGraphQLClient: () => Promise<Pick<GraphQLClient, 'watchQuery'>>
103103

@@ -108,7 +108,7 @@ export interface PlatformContext {
108108
* could leak private information such as repository names.
109109
* @returns Observable that emits the result or an error if the HTTP request failed
110110
*
111-
* @deprecated Use [Apollo](https://sourcegraph.com/docs/dev/background-information/web/graphql#graphql-client) instead
111+
* @deprecated Use [Apollo](https://docs-legacy.sourcegraph.com/dev/background-information/web/graphql#graphql-client) instead
112112
*/
113113
requestGraphQL: <R, V extends { [key: string]: any } = object>(options: {
114114
/**
@@ -189,7 +189,7 @@ export interface PlatformContext {
189189
/**
190190
* Telemetry recorder for the new telemetry framework, superseding
191191
* 'telemetryService' and 'logEvent' variants. Learn more here:
192-
* https://sourcegraph.com/docs/dev/background-information/telemetry
192+
* https://docs-legacy.sourcegraph.com/dev/background-information/telemetry
193193
*
194194
* It is backed by a '@sourcegraph/telemetry' implementation.
195195
*/

client/shared/src/telemetry/event-names.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// NOTE(naman): Remember to add events to allow list: https://sourcegraph.com/docs/dev/background-information/data-usage-pipeline#allow-list
1+
// NOTE(naman): Remember to add events to allow list: https://docs-legacy.sourcegraph.com/dev/background-information/data-usage-pipeline#allow-list
22
export const enum EventName {
33
CODY_CHAT_PAGE_VIEWED = 'web:codyChat:pageViewed',
44
CODY_CHAT_SUBMIT = 'web:codyChat:submit',

client/shared/src/telemetry/index.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,14 @@ export type BillingProduct = 'exampleBillingProduct'
2929

3030
/**
3131
* Props interface that can be extended by React components depending on the
32-
* new telemetry framework: https://sourcegraph.com/docs/dev/background-information/telemetry
32+
* new telemetry framework: https://docs-legacy.sourcegraph.com/dev/background-information/telemetry
3333
* These properties are part of {@link PlatformContext}.
3434
*/
3535
export interface TelemetryV2Props {
3636
/**
3737
* Telemetry recorder for the new telemetry framework, superseding
3838
* 'telemetryService' and 'logEvent' variants. Learn more here:
39-
* https://sourcegraph.com/docs/dev/background-information/telemetry
39+
* https://docs-legacy.sourcegraph.com/dev/background-information/telemetry
4040
*
4141
* It is backed by a '@sourcegraph/telemetry' implementation.
4242
*/

client/shared/src/testing/accessibility.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ const formatRuleViolations = (violations: Result[]): string[] =>
2525
({ id, help, helpUrl, nodes }) => `
2626
Rule: "${id}" (${help})
2727
Further information: ${helpUrl}
28-
How to manually audit: https://sourcegraph.com/docs/dev/background-information/web/accessibility/how-to-audit#auditing-a-user-journey
28+
How to manually audit: https://docs-legacy.sourcegraph.com/dev/background-information/web/accessibility/how-to-audit#auditing-a-user-journey
2929
Required changes: ${formatViolationProblems(nodes)}
3030
`
3131
)
@@ -45,7 +45,7 @@ export const ACCESSIBILITY_AUDIT_IGNORE_CLASS = '.a11y-ignore'
4545
*
4646
* Will error with a list of violations if any are found.
4747
*
48-
* See further documentation: https://sourcegraph.com/docs/dev/how-to/testing#accessibility-tests
48+
* See further documentation: https://docs-legacy.sourcegraph.com/dev/how-to/testing#accessibility-tests
4949
*/
5050
export async function accessibilityAudit(page: Page, config: AccessibilityAuditConfiguration = {}): Promise<void> {
5151
const { options, mode = 'fail' } = config

client/shared/src/testing/integration/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
This folder contains shared testing helpers for the Sourcegraph webapp and browser extensions.
44

5-
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).
5+
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).

client/storybook/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Storybook configuration
22

3-
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.
3+
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.
44

55
## Usage
66

client/web/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Local development
44

5-
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).
5+
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).
66

77
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.
88

client/web/src/components/Breadcrumbs.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ export interface BreadcrumbSetters {
7777
* pass an arbitrary element or a link config object for simpler breadcrumbs.
7878
* @returns Another breadcrumb setters object to pass down to child components to register child breadcrumbs,
7979
* with a method to remove the breadcrumb again. The object should be added to a [subscription
80-
* bag](https://sourcegraph.com/docs/dev/background-information/languages/typescript#subscription-bag).
80+
* bag](https://docs-legacy.sourcegraph.com/dev/background-information/languages/typescript#subscription-bag).
8181
*/
8282
setBreadcrumb: (breadcrumb: NullableBreadcrumb) => BreadcrumbSetters & Unsubscribable
8383
}

client/web/src/telemetry/apolloTelemetryExporter.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import type { ExportTelemetryEventsResult } from '../graphql-operations'
66

77
/**
88
* ApolloTelemetryExporter exports events via the new Sourcegraph telemetry
9-
* framework: https://sourcegraph.com/docs/dev/background-information/telemetry
9+
* framework: https://docs-legacy.sourcegraph.com/dev/background-information/telemetry
1010
*/
1111
export class ApolloTelemetryExporter implements TelemetryExporter {
1212
constructor(private client: ApolloClient<object>) {}

client/web/src/util/constants.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import type { AuthProvider } from '../jscontext'
22

3-
// NOTE(naman): Remember to add events to allow list: https://sourcegraph.com/docs/dev/background-information/data-usage-pipeline#allow-list
3+
// NOTE(naman): Remember to add events to allow list: https://docs-legacy.sourcegraph.com/dev/background-information/data-usage-pipeline#allow-list
44
export const enum EventName {
55
CODY_CHAT_PAGE_VIEWED = 'web:codyChat:pageViewed',
66
CODY_CHAT_SUBMIT = 'web:codyChat:submit',

client/wildcard/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ The Wildcard component library is a collection of design-approved reusable compo
1212
- `hooks/`
1313
Reusable React hooks. Typically utilities or headless components
1414

15-
See [Wildcard documentation](https://sourcegraph.com/docs/dev/background-information/web/wildcard) for more information.
15+
See [Wildcard documentation](https://docs-legacy.sourcegraph.com/dev/background-information/web/wildcard) for more information.

client/wildcard/src/components/Typography/Typography.story.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ export const CrossingStyles: StoryFn = () => (
267267
<Link
268268
target="_blank"
269269
rel="noopener noreferrer"
270-
to="https://sourcegraph.com/docs/dev/background-information/web/accessibility/detailed-checklist#headings"
270+
to="https://docs-legacy.sourcegraph.com/dev/background-information/web/accessibility/detailed-checklist#headings"
271271
>
272272
accessible
273273
</Link>{' '}

cmd/gitserver/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ To use `p4-fusion` while developing Sourcegraph, there are a couple of options.
4747

4848
#### Docker
4949

50-
[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`).
50+
[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`).
5151

5252
#### Bazel
5353

cmd/gitserver/internal/cleanup.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ const (
134134
)
135135

136136
// gitGCMode describes which mode we should be running git gc.
137-
// See for a detailed description of the modes: https://sourcegraph.com/docs/dev/background-information/git_gc
137+
// See for a detailed description of the modes: https://docs-legacy.sourcegraph.com/dev/background-information/git_gc
138138
var gitGCMode = func() int {
139139
// EnableGCAuto is a temporary flag that allows us to control whether or not
140140
// `git gc --auto` is invoked during janitorial activities. This flag will

cmd/telemetry-gateway/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
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.
44

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

cmd/worker/internal/permissions/bitbucket_projects.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,7 @@ func newBitbucketProjectPermissionsWorker(ctx context.Context, observationCtx *o
371371
}
372372

373373
// newBitbucketProjectPermissionsResetter implements resetter for the explicit_permissions_bitbucket_projects_jobs table.
374-
// See resetter documentation for more details. https://sourcegraph.com/docs/dev/background-information/workers#dequeueing-and-resetting-jobs
374+
// See resetter documentation for more details. https://docs-legacy.sourcegraph.com/dev/background-information/workers#dequeueing-and-resetting-jobs
375375
func newBitbucketProjectPermissionsResetter(observationCtx *observation.Context, db database.DB, cfg *config, metrics bitbucketProjectPermissionsMetrics) *dbworker.Resetter[*types.BitbucketProjectPermissionJob] {
376376
observationCtx = observation.ContextWithLogger(observationCtx.Logger.Scoped("BitbucketProjectPermissionsResetter"), observationCtx)
377377

dev/build-tracker/notify/slack.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -312,9 +312,9 @@ func (c *Client) createMessageBlocks(info *BuildNotification, author string) []s
312312
&slack.TextBlockObject{
313313
Type: slack.MarkdownType,
314314
Text: `:books: *More information on flakes*
315-
• <https://sourcegraph.com/docs/dev/background-information/ci#flakes|How to disable flaky tests>
315+
• <https://docs-legacy.sourcegraph.com/dev/background-information/ci#flakes|How to disable flaky tests>
316316
• <https://github.com/sourcegraph/sourcegraph/issues/new/choose|Create a flaky test issue>
317-
• <https://sourcegraph.com/docs/dev/how-to/testing#assessing-flaky-client-steps|Recognizing flaky client steps and how to fix them>
317+
• <https://docs-legacy.sourcegraph.com/dev/how-to/testing#assessing-flaky-client-steps|Recognizing flaky client steps and how to fix them>
318318
319319
_Disable flakes on sight and save your fellow teammate some time!_`,
320320
},

dev/ci/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Buildkite Pipeline for sourcegraph/sourcegraph
22

33
We dynamically generate our CI pipeline for [Buildkite](https://buildkite.com/sourcegraph/sourcegraph) based on the output of [gen-pipeline.go](./gen-pipeline.go).
4-
To learn more, refer to the [continuous integration docs](https://sourcegraph.com/docs/dev/background-information/ci).
4+
To learn more, refer to the [continuous integration docs](https://docs-legacy.sourcegraph.com/dev/background-information/ci).

dev/ci/bazel-prechecks.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ if [[ $EXIT_CODE -ne 0 ]]; then
5656
sg bazel configure
5757
```
5858
59-
#### For more information please see the [Bazel FAQ](https://sourcegraph.com/docs/dev/background-information/bazel/faq)
59+
#### For more information please see the [Bazel FAQ](https://docs-legacy.sourcegraph.com/dev/background-information/bazel/faq)
6060
6161
END
6262
exit "$EXIT_CODE"
@@ -80,7 +80,7 @@ if [[ $EXIT_CODE -ne 0 ]]; then
8080
sg bazel configure godeps
8181
```
8282
83-
#### For more information please see the [Bazel FAQ](https://sourcegraph.com/docs/dev/background-information/bazel/faq)
83+
#### For more information please see the [Bazel FAQ](https://docs-legacy.sourcegraph.com/dev/background-information/bazel/faq)
8484
8585
END
8686
exit "$EXIT_CODE"

0 commit comments

Comments
 (0)