diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 673c3422189..303a0eef8ba 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,12 +19,12 @@ 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://docs.sourcegraph.com/dev/setup/quickstart) to run the project locally. -4. Before creating a pull request, ensure that [recommended checks](https://docs.sourcegraph.com/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://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. 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://docs.sourcegraph.com/dev/contributing/accepting_contribution#cla-bot) for how to verify that the CLA has been signed. + - 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. 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://docs.sourcegraph.com/). If you don’t find any relevant information, mention the issue author. +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. 9. Join the [Sourcegraph Community Space](https://srcgr.ph/join-community-space) on Discord where the Sourcegraph team can help you! @@ -36,18 +36,18 @@ 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://docs.sourcegraph.com/getting-started) -- [Troubleshooting section](https://docs.sourcegraph.com/dev/setup/troubleshooting) +- [Getting Started Guide](https://sourcegraph.com/docs/getting-started) +- [Troubleshooting section](https://sourcegraph.com/docs/dev/setup/troubleshooting) ### How to write tests -- [How to write tests](https://docs.sourcegraph.com/dev/how-to/testing) -- [Testing principles](https://docs.sourcegraph.com/dev/background-information/testing_principles) -- [Testing web code](https://docs.sourcegraph.com/dev/background-information/testing_web_code) +- [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) ### Pull Requests -- [How to structure](https://docs.sourcegraph.com/dev/background-information/pull_request_reviews#what-makes-an-effective-pull-request-pr) +- [How to structure](https://sourcegraph.com/docs/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://docs.sourcegraph.com/dev/contributing/accepting_contribution) +- (For Sourcegraph team) [How to accept contributions](https://sourcegraph.com/docs/dev/contributing/accepting_contribution) diff --git a/README.md b/README.md index a60186da3f4..980a1bbe92b 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@

- Docs • + Docs • Contributing • Twitter • Discord @@ -38,7 +38,7 @@ ## Getting started -- [Use Sourcegraph on the cloud or self-hosted](https://docs.sourcegraph.com/) +- [Use Sourcegraph on the cloud or self-hosted](https://sourcegraph.com/docs/) - [Sourcegraph.com public code search](https://sourcegraph.com/search)

@@ -47,7 +47,7 @@ ## Development -Refer to the [Developing Sourcegraph guide](https://docs.sourcegraph.com/dev) to get started. +Refer to the [Developing Sourcegraph guide](https://sourcegraph.com/docs/dev) to get started. ### Documentation diff --git a/client/branded/src/search-ui/results/NoResultsPage.tsx b/client/branded/src/search-ui/results/NoResultsPage.tsx index ab1b1e10d90..b122b1eee26 100644 --- a/client/branded/src/search-ui/results/NoResultsPage.tsx +++ b/client/branded/src/search-ui/results/NoResultsPage.tsx @@ -108,7 +108,7 @@ export const NoResultsPage: React.FunctionComponent telemetryService.log('NoResultsMore', { link: 'Docs' })} target="blank" - to="https://docs.sourcegraph.com/" + to="https://sourcegraph.com/docs/" > Sourcegraph Docs diff --git a/client/branded/src/search-ui/results/sidebar/SearchReference.tsx b/client/branded/src/search-ui/results/sidebar/SearchReference.tsx index 5b9a71f7779..35ec4d8edf5 100644 --- a/client/branded/src/search-ui/results/sidebar/SearchReference.tsx +++ b/client/branded/src/search-ui/results/sidebar/SearchReference.tsx @@ -248,7 +248,7 @@ To use this filter, the search query must contain \`type:diff\` or \`type:commit field: FilterType.rev, commonRank: 20, description: - 'Search a revision instead of the default branch. `rev:` can only be used in conjunction with `repo:` and may not be used more than once. See our [revision syntax documentation](https://docs.sourcegraph.com/code_search/reference/queries#repository-revisions) to learn more.', + 'Search a revision instead of the default branch. `rev:` can only be used in conjunction with `repo:` and may not be used more than once. See our [revision syntax documentation](https://sourcegraph.com/docs/code_search/reference/queries#repository-revisions) to learn more.', }, { ...createQueryExampleFromString('{result-types}'), @@ -265,7 +265,7 @@ To use this filter, the search query must contain \`type:diff\` or \`type:commit - \`select:content\` - \`select:symbol.symboltype\` -See [language definition](https://docs.sourcegraph.com/code_search/reference/language#select) for more information on possible values.`, +See [language definition](https://sourcegraph.com/docs/code_search/reference/language#select) for more information on possible values.`, examples: ['fmt.Errorf select:repo', 'select:commit.diff.added //TODO', 'select:file.directory'], }, { diff --git a/client/browser/README.md b/client/browser/README.md index e99cfac4a24..0dfec2d32bb 100644 --- a/client/browser/README.md +++ b/client/browser/README.md @@ -18,7 +18,7 @@ The tooltips include features like: #### 🚀 Install: [**Sourcegraph for Chrome**](https://chrome.google.com/webstore/detail/sourcegraph/dgjhfomjieaadpoljlnidmbgkdffpack) -#### 🚀 Install: [**Sourcegraph for Firefox**](https://docs.sourcegraph.com/integration/browser_extension) +#### 🚀 Install: [**Sourcegraph for Firefox**](https://sourcegraph.com/docs/integration/browser_extension) #### 🚀 Install: [**Sourcegraph for Safari**](https://apps.apple.com/us/app/sourcegraph-for-safari/id1543262193) @@ -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://docs.sourcegraph.com/dev/phabricator_gitolite. +There are automated scripts to set up the Phabricator instance, see https://sourcegraph.com/docs/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://docs.sourcegraph.com/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://sourcegraph.com/docs/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) diff --git a/client/browser/detailed_description.txt b/client/browser/detailed_description.txt index 04a9f5d8fdd..54298cc38d1 100644 --- a/client/browser/detailed_description.txt +++ b/client/browser/detailed_description.txt @@ -33,6 +33,6 @@ After you install it, try it out on any of these public repositories: * C#: https://github.com/paiden/Nett/pull/76/files#diff-e969e1315b2cb01bab80b2860be0d87eR52 * Python: https://github.com/ageitgey/face_recognition/blob/b8fed6/examples/facerec_on_raspberry_pi.py -Usage with private code on GitHub.com, GitHub Enterprise, GitLab, Bitbucket Server, or Phabricator: https://docs.sourcegraph.com/integration/browser_extension +Usage with private code on GitHub.com, GitHub Enterprise, GitLab, Bitbucket Server, or Phabricator: https://sourcegraph.com/docs/integration/browser_extension This extension is open source: https://github.com/sourcegraph/sourcegraph/tree/main/client/browser diff --git a/client/browser/src/browser-extension/after-install-page/AfterInstallPageContent.tsx b/client/browser/src/browser-extension/after-install-page/AfterInstallPageContent.tsx index e2f1db02813..61921b60eda 100644 --- a/client/browser/src/browser-extension/after-install-page/AfterInstallPageContent.tsx +++ b/client/browser/src/browser-extension/after-install-page/AfterInstallPageContent.tsx @@ -58,7 +58,7 @@ export const AfterInstallPageContent: React.FC = p - + Browser extension docs @@ -183,7 +183,7 @@ export const AfterInstallPageContent: React.FC = p

  • Install Sourcegraph ( @@ -223,7 +223,7 @@ export const AfterInstallPageContent: React.FC = p Read the{' '} diff --git a/client/browser/src/browser-extension/options-menu/OptionsPage.tsx b/client/browser/src/browser-extension/options-menu/OptionsPage.tsx index 6bb016c26cc..4d91b095f8d 100644 --- a/client/browser/src/browser-extension/options-menu/OptionsPage.tsx +++ b/client/browser/src/browser-extension/options-menu/OptionsPage.tsx @@ -153,7 +153,7 @@ export const OptionsPage: React.FunctionComponent @@ -189,7 +189,7 @@ export const OptionsPage: React.FunctionComponent
    - + Documentation @@ -247,7 +247,7 @@ const RepoSyncErrorAlert: React.FunctionComponent< You need to setup a{' '} { 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://docs.sourcegraph.com/dev/phabricator_gitolite#install-the-sourcegraph-phabricator-extension` + `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` ) } diff --git a/client/browser/src/shared/code-hosts/gitlab/scrape.ts b/client/browser/src/shared/code-hosts/gitlab/scrape.ts index e808bebd000..5e48a79e728 100644 --- a/client/browser/src/shared/code-hosts/gitlab/scrape.ts +++ b/client/browser/src/shared/code-hosts/gitlab/scrape.ts @@ -78,7 +78,7 @@ const parseGitLabRepoURL = (): { hostname: string; projectFullName: string; owne /** * Subject to store repo name on the Sourcegraph instance (e.g. 'gitlab.com/SourcegraphCody/jsonrpc2'). * It may be different from the repo name on the code host because of the name transformations applied - * (see {@link https://docs.sourcegraph.com/admin/external_service/gitlab#nameTransformations}). + * (see {@link https://sourcegraph.com/docs/admin/external_service/gitlab#nameTransformations}). * Set in `gitlabCodeHost.prepareCodeHost` method. */ export const repoNameOnSourcegraph = new BehaviorSubject('') diff --git a/client/browser/src/shared/code-hosts/shared/ViewOnSourcegraphButton.tsx b/client/browser/src/shared/code-hosts/shared/ViewOnSourcegraphButton.tsx index 4d4d367e9e5..752504530f6 100644 --- a/client/browser/src/shared/code-hosts/shared/ViewOnSourcegraphButton.tsx +++ b/client/browser/src/shared/code-hosts/shared/ViewOnSourcegraphButton.tsx @@ -85,7 +85,7 @@ export const ViewOnSourcegraphButton: React.FunctionComponent< ...commonProps, // If we are not running in the browser extension where we can open the options menu, // open the documentation for how to configure the code host we are on. - href: new URL(snakeCase(codeHostType), 'https://docs.sourcegraph.com/integration/').href, + href: new URL(snakeCase(codeHostType), 'https://sourcegraph.com/docs/integration/').href, // onClick can call preventDefault() to prevent that and take a different action (opening the options menu). onClick: onConfigureSourcegraphClick, } @@ -149,7 +149,7 @@ export const ConfigureSourcegraphButton: React.FunctionComponent< > = ({ onConfigureSourcegraphClick, codeHostType, ...commonProps }) => ( = { export const FIXTURE_SEMANTIC_BADGE: AggregableBadge = { text: 'semantic', - linkURL: 'https://docs.sourcegraph.com/code_navigation/explanations/precise_code_navigation', + linkURL: 'https://sourcegraph.com/docs/code_navigation/explanations/precise_code_navigation', hoverMessage: 'Sample hover message', } diff --git a/client/shared/src/platform/context.ts b/client/shared/src/platform/context.ts index 71cbd5cfcb5..4d88ec3f2f3 100644 --- a/client/shared/src/platform/context.ts +++ b/client/shared/src/platform/context.ts @@ -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](docs.sourcegraph.com/dev/background-information/web/graphql#graphql-client) instead + * @deprecated Use [Apollo](https://sourcegraph.com/docs/dev/background-information/web/graphql#graphql-client) instead */ getGraphQLClient: () => Promise> @@ -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](docs.sourcegraph.com/dev/background-information/web/graphql#graphql-client) instead + * @deprecated Use [Apollo](https://sourcegraph.com/docs/dev/background-information/web/graphql#graphql-client) instead */ requestGraphQL: (options: { /** @@ -189,7 +189,7 @@ export interface PlatformContext { /** * Telemetry recorder for the new telemetry framework, superseding * 'telemetryService' and 'logEvent' variants. Learn more here: - * https://docs.sourcegraph.com/dev/background-information/telemetry + * https://sourcegraph.com/docs/dev/background-information/telemetry * * It is backed by a '@sourcegraph/telemetry' implementation. */ diff --git a/client/shared/src/search/query/decoratedToken.ts b/client/shared/src/search/query/decoratedToken.ts index 29c0a7ceaae..2ede1094ca7 100644 --- a/client/shared/src/search/query/decoratedToken.ts +++ b/client/shared/src/search/query/decoratedToken.ts @@ -114,7 +114,7 @@ interface MetaFilterSeparator extends BaseMetaToken { /** * A token that is labeled and interpreted as repository revision syntax in Sourcegraph. Note: there * are syntactic differences from pure Git ref syntax. - * See https://docs.sourcegraph.com/code_search/reference/queries#repository-revisions. + * See https://sourcegraph.com/docs/code_search/reference/queries#repository-revisions. */ export interface MetaRevision extends BaseMetaToken { type: 'metaRevision' diff --git a/client/shared/src/search/query/hover.ts b/client/shared/src/search/query/hover.ts index e594c72cedf..6a4ced50b9f 100644 --- a/client/shared/src/search/query/hover.ts +++ b/client/shared/src/search/query/hover.ts @@ -129,7 +129,7 @@ const toRegexpHover = (token: MetaRegexp): string => { const toStructuralHover = (token: MetaStructural): string => { switch (token.kind) { case MetaStructuralKind.Hole: { - return '**Structural hole**. Matches code structures contextually. See the [syntax reference](https://docs.sourcegraph.com/code_search/reference/structural#syntax-reference) for a complete description.' + return '**Structural hole**. Matches code structures contextually. See the [syntax reference](https://sourcegraph.com/docs/code-search/queries#structural-search) for a complete description.' } case MetaStructuralKind.RegexpHole: { return '**Regular expression hole**. Match the regular expression defined inside this hole.' diff --git a/client/shared/src/telemetry/index.ts b/client/shared/src/telemetry/index.ts index 93db0a7cb0a..2c67abc6092 100644 --- a/client/shared/src/telemetry/index.ts +++ b/client/shared/src/telemetry/index.ts @@ -29,14 +29,14 @@ export type BillingProduct = 'exampleBillingProduct' /** * Props interface that can be extended by React components depending on the - * new telemetry framework: https://docs.sourcegraph.com/dev/background-information/telemetry + * new telemetry framework: https://sourcegraph.com/docs/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://docs.sourcegraph.com/dev/background-information/telemetry + * https://sourcegraph.com/docs/dev/background-information/telemetry * * It is backed by a '@sourcegraph/telemetry' implementation. */ diff --git a/client/shared/src/testing/accessibility.ts b/client/shared/src/testing/accessibility.ts index edcf2a09274..fcda5835a36 100644 --- a/client/shared/src/testing/accessibility.ts +++ b/client/shared/src/testing/accessibility.ts @@ -25,7 +25,7 @@ const formatRuleViolations = (violations: Result[]): string[] => ({ id, help, helpUrl, nodes }) => ` Rule: "${id}" (${help}) Further information: ${helpUrl} -How to manually audit: https://docs.sourcegraph.com/dev/background-information/web/accessibility/how-to-audit#auditing-a-user-journey +How to manually audit: https://sourcegraph.com/docs/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://docs.sourcegraph.com/dev/how-to/testing#accessibility-tests + * See further documentation: https://sourcegraph.com/docs/dev/how-to/testing#accessibility-tests */ export async function accessibilityAudit(page: Page, config: AccessibilityAuditConfiguration = {}): Promise { const { options, mode = 'fail' } = config diff --git a/client/shared/src/testing/integration/README.md b/client/shared/src/testing/integration/README.md index cf5cf38229e..337fe4b474b 100644 --- a/client/shared/src/testing/integration/README.md +++ b/client/shared/src/testing/integration/README.md @@ -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://docs.sourcegraph.com/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://sourcegraph.com/docs/dev/how-to/testing#client-integration-tests). diff --git a/client/storybook/README.md b/client/storybook/README.md index 64b1a560de1..7853c98320b 100644 --- a/client/storybook/README.md +++ b/client/storybook/README.md @@ -1,6 +1,6 @@ # Storybook configuration -Check out the [Storybook section](https://docs.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. +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. ## Usage diff --git a/client/web/README.md b/client/web/README.md index dba2daefdc3..abb930c3386 100644 --- a/client/web/README.md +++ b/client/web/README.md @@ -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://docs.sourcegraph.com/dev/background-information/sg). +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). 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. diff --git a/client/web/src/components/Breadcrumbs.tsx b/client/web/src/components/Breadcrumbs.tsx index aba1c8da896..fc5aff2cc40 100644 --- a/client/web/src/components/Breadcrumbs.tsx +++ b/client/web/src/components/Breadcrumbs.tsx @@ -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://docs.sourcegraph.com/dev/background-information/languages/typescript#subscription-bag). + * bag](https://sourcegraph.com/docs/dev/background-information/languages/typescript#subscription-bag). */ setBreadcrumb: (breadcrumb: NullableBreadcrumb) => BreadcrumbSetters & Unsubscribable } diff --git a/client/web/src/components/externalServices/externalServices.tsx b/client/web/src/components/externalServices/externalServices.tsx index 9b80e9258a9..4f211824548 100644 --- a/client/web/src/components/externalServices/externalServices.tsx +++ b/client/web/src/components/externalServices/externalServices.tsx @@ -125,10 +125,10 @@ function editWithComment(config: string, path: JSONPath, value: any, comment: st const editorActionComments = { enablePermissions: - '// Prerequisite: you must configure GitHub as an OAuth auth provider in the site config (https://docs.sourcegraph.com/admin/auth#github). Otherwise, access to all repositories will be disallowed.', + '// Prerequisite: you must configure GitHub as an OAuth auth provider in the site config (https://sourcegraph.com/docs/admin/auth#github). Otherwise, access to all repositories will be disallowed.', enforcePermissionsOAuth: `// Prerequisite: you must first update the site configuration to // include GitLab OAuth as an auth provider. - // See https://docs.sourcegraph.com/admin/auth#gitlab for instructions.`, + // See https://sourcegraph.com/docs/admin/auth#gitlab for instructions.`, enforcePermissionsSSO: `// Prerequisite: You need a sudo-level access token. If you can configure // GitLab as an OAuth identity provider for Sourcegraph, we recommend that // option instead. @@ -136,9 +136,9 @@ const editorActionComments = { // 1. Ensure the personal access token in this config has admin privileges // (https://docs.gitlab.com/ee/api/#sudo). // 2. Update the site configuration to include the SSO auth provider for GitLab - // (https://docs.sourcegraph.com/admin/auth). + // (https://sourcegraph.com/docs/admin/auth). // 3. Update the fields below to match the properties of this auth provider - // (https://docs.sourcegraph.com/admin/repo/permissions#sudo-access-token).`, + // (https://sourcegraph.com/docs/admin/permissions).`, } const Field: React.FunctionComponent<{ children: React.ReactNode | string | string[] }> = props => ( @@ -1146,7 +1146,7 @@ const PHABRICATOR_SERVICE: AddExternalServiceOptions = { defaultConfig: `{ // Use Ctrl+Space for completion, and hover over JSON properties for documentation. // Configuration options are documented here: - // https://docs.sourcegraph.com/admin/external_service/phabricator#configuration + // https://sourcegraph.com/docs/admin/external_service/phabricator#configuration "url": "https://phabricator.example.com", "token": "", diff --git a/client/web/src/enterprise/batches/batch-spec/edit/library/many-comby.batch.yaml b/client/web/src/enterprise/batches/batch-spec/edit/library/many-comby.batch.yaml index bab244b45a2..f60ab4a52c8 100644 --- a/client/web/src/enterprise/batches/batch-spec/edit/library/many-comby.batch.yaml +++ b/client/web/src/enterprise/batches/batch-spec/edit/library/many-comby.batch.yaml @@ -11,7 +11,7 @@ steps: comby -in-place -config /tmp/patterns.toml -exclude-dir .,vendor; container: comby/comby # files to mount on the container can be directly included in the spec file - # for other options, see https://docs.sourcegraph.com/batch_changes/references/batch_spec_yaml_reference#steps-mount + # for other options, see https://sourcegraph.com/docs/batch_changes/references/batch_spec_yaml_reference#stepsmount files: /tmp/patterns.toml: | [my-first-pattern] diff --git a/client/web/src/enterprise/batches/batch-spec/edit/library/monorepo-dynamic.batch.yaml b/client/web/src/enterprise/batches/batch-spec/edit/library/monorepo-dynamic.batch.yaml index 94cdc4e5448..aa9ccc21790 100644 --- a/client/web/src/enterprise/batches/batch-spec/edit/library/monorepo-dynamic.batch.yaml +++ b/client/web/src/enterprise/batches/batch-spec/edit/library/monorepo-dynamic.batch.yaml @@ -26,7 +26,7 @@ changesetTemplate: body: | Run in each workspace of a monorepo # Each branch needs to be unique, so we're using templating to define them -# https://docs.sourcegraph.com/batch_changes/references/batch_spec_templating +# https://sourcegraph.com/docs/batch_changes/references/batch_spec_templating branch: batch-changes/monorepo/${{ replace steps.path "/" "-" }} commit: message: opening several changesets in a monorepo diff --git a/client/web/src/enterprise/batches/batch-spec/edit/library/sed.batch.yaml b/client/web/src/enterprise/batches/batch-spec/edit/library/sed.batch.yaml index 2bacbfa7fc6..d0296e304a3 100644 --- a/client/web/src/enterprise/batches/batch-spec/edit/library/sed.batch.yaml +++ b/client/web/src/enterprise/batches/batch-spec/edit/library/sed.batch.yaml @@ -6,7 +6,7 @@ on: steps: # In each repo, iterate over search results files using templating - # https://docs.sourcegraph.com/batch_changes/references/batch_spec_templating + # https://sourcegraph.com/docs/batch_changes/references/batch_spec_templating - run: | while read -r file do diff --git a/client/web/src/onboarding/OnboardingChecklist.content.ts b/client/web/src/onboarding/OnboardingChecklist.content.ts index 9cd7f9b8fd1..40d786c09ae 100644 --- a/client/web/src/onboarding/OnboardingChecklist.content.ts +++ b/client/web/src/onboarding/OnboardingChecklist.content.ts @@ -18,7 +18,7 @@ export const content = [ isComplete: false, title: 'Set up SMTP', description: 'Must be set in order for Sourcegraph to send emails.', - link: 'https://docs.sourcegraph.com/admin/config/email', + link: 'https://sourcegraph.com/docs/admin/config/email', }, { id: 'externalServices', @@ -32,6 +32,6 @@ export const content = [ isComplete: false, title: 'Set up user authentication', description: 'We recommend that enterprise instances use SSO or SAML to authenticate users.', - link: 'https://docs.sourcegraph.com/admin/config/authorization_and_authentication', + link: 'https://sourcegraph.com/docs/admin/config/authorization_and_authentication', }, ] diff --git a/client/web/src/open-in-editor/build-url.test.ts b/client/web/src/open-in-editor/build-url.test.ts index c391b0d3e6c..212e37a152f 100644 --- a/client/web/src/open-in-editor/build-url.test.ts +++ b/client/web/src/open-in-editor/build-url.test.ts @@ -310,7 +310,7 @@ describe('buildEditorUrl tests', () => { it('builds the right "Learn more" URL', () => { expect(() => { buildEditorUrl(defaultPath, defaultPosition, { editorIds: ['vscode'] }, baseUrl) - }).toThrow(/https:\/\/docs\.sourcegraph\.com\/integration\/open_in_editor/) + }).toThrow(/https:\/\/sourcegraph\.com\/docs\/integration\/open_in_editor/) }) }) }) diff --git a/client/web/src/open-in-editor/build-url.ts b/client/web/src/open-in-editor/build-url.ts index 646ff628af5..2acae7c7a72 100644 --- a/client/web/src/open-in-editor/build-url.ts +++ b/client/web/src/open-in-editor/build-url.ts @@ -62,7 +62,7 @@ export function getEditorSettingsErrorMessage( editorSettings: EditorSettings | undefined, sourcegraphBaseUrl: string ): string | undefined { - const learnMoreURL = 'https://docs.sourcegraph.com/integration/open_in_editor' + const learnMoreURL = 'https://sourcegraph.com/docs/integration/open_in_editor' if (!editorSettings) { return `Add \`openInEditor\` to your user settings to open files in the editor. [Learn more](${learnMoreURL})` diff --git a/client/web/src/search/results/StreamingSearchResults.story.tsx b/client/web/src/search/results/StreamingSearchResults.story.tsx index b84344a06e6..b6ec1a3ed5d 100644 --- a/client/web/src/search/results/StreamingSearchResults.story.tsx +++ b/client/web/src/search/results/StreamingSearchResults.story.tsx @@ -306,7 +306,7 @@ export const ServerSideAlertUnownedResults: StoryFn = () => { kind: 'unowned-results', title: 'Some results have no owners', description: - 'For some results, no ownership data was found, or no rule applied to the result. [Learn more about configuring code ownership](https://docs.sourcegraph.com/own).', + 'For some results, no ownership data was found, or no rule applied to the result. [Learn more about configuring code ownership](https://sourcegraph.com/docs/own).', }, } diff --git a/client/web/src/site-admin/SiteAdminConfigurationPage.tsx b/client/web/src/site-admin/SiteAdminConfigurationPage.tsx index 27160f231dd..f12a1622738 100644 --- a/client/web/src/site-admin/SiteAdminConfigurationPage.tsx +++ b/client/web/src/site-admin/SiteAdminConfigurationPage.tsx @@ -97,7 +97,7 @@ const quickConfigureActions: { clientSecret: '', }, { - COMMENT: '// See https://docs.sourcegraph.com/admin/auth#gitlab for instructions', + COMMENT: '// See https://sourcegraph.com/docs/admin/auth#gitlab for instructions', } ), ] @@ -121,7 +121,7 @@ const quickConfigureActions: { clientID: '', clientSecret: '', }, - { COMMENT: '// See https://docs.sourcegraph.com/admin/auth#github for instructions' } + { COMMENT: '// See https://sourcegraph.com/docs/admin/auth#github for instructions' } ), ] return { edits, selectText: '' } @@ -143,7 +143,7 @@ const quickConfigureActions: { identityProviderMetadataURL: '', }, { - COMMENT: '// See https://docs.sourcegraph.com/admin/auth/saml/one_login for instructions', + COMMENT: '// See https://sourcegraph.com/docs/admin/auth/saml/one_login for instructions', } ), ] @@ -162,7 +162,7 @@ const quickConfigureActions: { } const edits = [ editWithComments(config, ['auth.providers', -1], value, { - COMMENT: '// See https://docs.sourcegraph.com/admin/auth/saml/okta for instructions', + COMMENT: '// See https://sourcegraph.com/docs/admin/auth/saml/okta for instructions', }), ] return { edits, selectText: '' } @@ -182,7 +182,7 @@ const quickConfigureActions: { displayName: 'SAML', identityProviderMetadataURL: '', }, - { COMMENT: '// See https://docs.sourcegraph.com/admin/auth/saml for instructions' } + { COMMENT: '// See https://sourcegraph.com/docs/admin/auth/saml for instructions' } ), ] return { edits, selectText: '' } @@ -204,7 +204,7 @@ const quickConfigureActions: { clientID: '', clientSecret: '', }, - { COMMENT: '// See https://docs.sourcegraph.com/admin/auth#openid-connect for instructions' } + { COMMENT: '// See https://sourcegraph.com/docs/admin/auth#openid-connect for instructions' } ), ] return { edits, selectText: '' } diff --git a/client/web/src/storm/pages/SearchPage/SearchPageFooter.tsx b/client/web/src/storm/pages/SearchPage/SearchPageFooter.tsx index 8d747f4f6ab..8054fa0adfb 100644 --- a/client/web/src/storm/pages/SearchPage/SearchPageFooter.tsx +++ b/client/web/src/storm/pages/SearchPage/SearchPageFooter.tsx @@ -21,7 +21,7 @@ export const SearchPageFooter: FC = () => { ? [ { name: 'Docs', - href: 'https://docs.sourcegraph.com/', + href: 'https://sourcegraph.com/docs', }, { name: 'About', href: 'https://sourcegraph.com' }, { diff --git a/client/web/src/telemetry/apolloTelemetryExporter.ts b/client/web/src/telemetry/apolloTelemetryExporter.ts index d028f28872f..0670d324d28 100644 --- a/client/web/src/telemetry/apolloTelemetryExporter.ts +++ b/client/web/src/telemetry/apolloTelemetryExporter.ts @@ -6,7 +6,7 @@ import type { ExportTelemetryEventsResult } from '../graphql-operations' /** * ApolloTelemetryExporter exports events via the new Sourcegraph telemetry - * framework: https://docs.sourcegraph.com/dev/background-information/telemetry + * framework: https://sourcegraph.com/docs/dev/background-information/telemetry */ export class ApolloTelemetryExporter implements TelemetryExporter { constructor(private client: ApolloClient) {} diff --git a/client/web/src/tour/data/index.tsx b/client/web/src/tour/data/index.tsx index 6cf3a7bd904..90f4f1d39d1 100644 --- a/client/web/src/tour/data/index.tsx +++ b/client/web/src/tour/data/index.tsx @@ -156,7 +156,7 @@ export const authenticatedTasks: TourTaskType[] = [ label: 'Install the browser extension and leverage Sourcegraph code intelligence in reviews', action: { type: 'new-tab-link', - value: 'https://docs.sourcegraph.com/integration/browser_extension', + value: 'https://sourcegraph.com/docs/integration/browser_extension', }, }, ], diff --git a/client/web/src/util/constants.ts b/client/web/src/util/constants.ts index 50b463ec7c2..d7f31494823 100644 --- a/client/web/src/util/constants.ts +++ b/client/web/src/util/constants.ts @@ -1,6 +1,6 @@ import type { AuthProvider } from '../jscontext' -// NOTE(naman): Remember to add events to allow list: https://docs.sourcegraph.com/dev/background-information/data-usage-pipeline#allow-list +// NOTE(naman): Remember to add events to allow list: https://sourcegraph.com/docs/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', diff --git a/client/wildcard/README.md b/client/wildcard/README.md index fa29fda42b6..4dc634caff2 100644 --- a/client/wildcard/README.md +++ b/client/wildcard/README.md @@ -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://docs.sourcegraph.com/dev/background-information/web/wildcard) for more information. +See [Wildcard documentation](https://sourcegraph.com/docs/dev/background-information/web/wildcard) for more information. diff --git a/client/wildcard/src/components/Badge/ProductStatusBadge.tsx b/client/wildcard/src/components/Badge/ProductStatusBadge.tsx index 82c09bc96a2..b6a3bb6af74 100644 --- a/client/wildcard/src/components/Badge/ProductStatusBadge.tsx +++ b/client/wildcard/src/components/Badge/ProductStatusBadge.tsx @@ -30,9 +30,9 @@ export type ProductStatusLinked = Extends = { - experimental: 'https://docs.sourcegraph.com/admin/beta_and_experimental_features#experimental-features', - beta: 'https://docs.sourcegraph.com/admin/beta_and_experimental_features#beta-features', - 'private-beta': 'https://docs.sourcegraph.com/admin/beta_and_experimental_features#beta-features', + experimental: 'https://sourcegraph.com/docs/admin/beta_and_experimental_features#experimental-features', + beta: 'https://sourcegraph.com/docs/admin/beta_and_experimental_features#beta-features', + 'private-beta': 'https://sourcegraph.com/docs/admin/beta_and_experimental_features#beta-features', } as const /** diff --git a/client/wildcard/src/components/Form/Input/Input.story.tsx b/client/wildcard/src/components/Form/Input/Input.story.tsx index dbdb50927ae..af85df8ae80 100644 --- a/client/wildcard/src/components/Form/Input/Input.story.tsx +++ b/client/wildcard/src/components/Form/Input/Input.story.tsx @@ -58,7 +58,7 @@ export const Simple = () => { value={selected} label="Input error" onChange={handleChange} - error="An error message that can contain `code` or other **Markdown** _formatting_. [Learn more](https://docs.sourcegraph.com)" + error="An error message that can contain `code` or other **Markdown** _formatting_. [Learn more](https://sourcegraph.com/docs)" status="error" placeholder="error status input" /> diff --git a/client/wildcard/src/components/NavMenu/NavMenu.story.tsx b/client/wildcard/src/components/NavMenu/NavMenu.story.tsx index 96353b471b8..deaa67a6685 100644 --- a/client/wildcard/src/components/NavMenu/NavMenu.story.tsx +++ b/client/wildcard/src/components/NavMenu/NavMenu.story.tsx @@ -135,7 +135,7 @@ const navItems: NavMenuSectionProps[] = [ { content: 'Browser Extension', suffixIcon: OpenInNewIcon, - to: 'https://docs.sourcegraph.com/integration/browser_extension', + to: 'https://sourcegraph.com/docs/integration/browser_extension', key: 'Extension', }, ], diff --git a/client/wildcard/src/components/NavMenu/NavMenu.test.tsx b/client/wildcard/src/components/NavMenu/NavMenu.test.tsx index 5e423e24bc5..cbfa24e2c38 100644 --- a/client/wildcard/src/components/NavMenu/NavMenu.test.tsx +++ b/client/wildcard/src/components/NavMenu/NavMenu.test.tsx @@ -73,7 +73,7 @@ describe('', () => { { content: 'Browser Extension', itemAs: AnchorLink, - to: 'https://docs.sourcegraph.com/integration/browser_extension', + to: 'https://sourcegraph.com/docs/integration/browser_extension', key: 7, }, ], diff --git a/client/wildcard/src/components/NavMenu/__snapshots__/NavMenu.test.tsx.snap b/client/wildcard/src/components/NavMenu/__snapshots__/NavMenu.test.tsx.snap index 904b3c63a84..20f16326fbf 100644 --- a/client/wildcard/src/components/NavMenu/__snapshots__/NavMenu.test.tsx.snap +++ b/client/wildcard/src/components/NavMenu/__snapshots__/NavMenu.test.tsx.snap @@ -149,7 +149,7 @@ exports[` > Should render Menu Items Correctly 1`] = ` data-reach-menu-item="" data-reach-menu-link="" data-valuetext="Browser Extension" - href="https://docs.sourcegraph.com/integration/browser_extension" + href="https://sourcegraph.com/docs/integration/browser_extension" id="option-8--menu-test-id" role="menuitem" tabindex="-1" diff --git a/client/wildcard/src/components/Typography/Typography.story.tsx b/client/wildcard/src/components/Typography/Typography.story.tsx index 03d7eed1862..867c36a7bad 100644 --- a/client/wildcard/src/components/Typography/Typography.story.tsx +++ b/client/wildcard/src/components/Typography/Typography.story.tsx @@ -267,7 +267,7 @@ export const CrossingStyles: StoryFn = () => ( accessible {' '} diff --git a/cmd/executor/main.go b/cmd/executor/main.go index 65aec84506a..57912d861b7 100644 --- a/cmd/executor/main.go +++ b/cmd/executor/main.go @@ -46,7 +46,7 @@ func main() { app := &cli.App{ Version: version.Version(), // TODO: More info, link to docs, some inline documentation etc. - Description: "The Sourcegraph untrusted jobs runner. See https://docs.sourcegraph.com/admin/executors to learn more about setup, how it works and how to configure features that depend on it.", + Description: "The Sourcegraph untrusted jobs runner. See https://sourcegraph.com/docs/admin/executors to learn more about setup, how it works and how to configure features that depend on it.", Name: "executor", Usage: "The Sourcegraph untrusted jobs runner.", DefaultCommand: "run", diff --git a/cmd/frontend/envvar/envvar.go b/cmd/frontend/envvar/envvar.go index 863b80f11e3..02cb3441ba2 100644 --- a/cmd/frontend/envvar/envvar.go +++ b/cmd/frontend/envvar/envvar.go @@ -20,7 +20,7 @@ var HTTPAddrInternal = env.Get( var sourcegraphDotComMode, _ = strconv.ParseBool(env.Get("SOURCEGRAPHDOTCOM_MODE", "false", "run as Sourcegraph.com, with add'l marketing and redirects")) var openGraphPreviewServiceURL = env.Get("OPENGRAPH_PREVIEW_SERVICE_URL", "", "The URL of the OpenGraph preview image generating service") -var extsvcConfigFile = env.Get("EXTSVC_CONFIG_FILE", "", "EXTSVC_CONFIG_FILE can contain configurations for multiple code host connections. See https://docs.sourcegraph.com/admin/config/advanced_config_file for details.") +var extsvcConfigFile = env.Get("EXTSVC_CONFIG_FILE", "", "EXTSVC_CONFIG_FILE can contain configurations for multiple code host connections. See https://sourcegraph.com/docs/admin/config/advanced_config_file for details.") var extsvcConfigAllowEdits, _ = strconv.ParseBool(env.Get("EXTSVC_CONFIG_ALLOW_EDITS", "false", "When EXTSVC_CONFIG_FILE is in use, allow edits in the application to be made which will be overwritten on next process restart")) // SourcegraphDotComMode is true if this server is running Sourcegraph.com diff --git a/cmd/frontend/graphqlbackend/schema.graphql b/cmd/frontend/graphqlbackend/schema.graphql index 7985c9c7990..f42560d000c 100755 --- a/cmd/frontend/graphqlbackend/schema.graphql +++ b/cmd/frontend/graphqlbackend/schema.graphql @@ -3347,7 +3347,7 @@ type ExternalService implements Node { Only site admins may access this field. - DEPRECATED: Webhook logs linked directly to an external service will be removed. See https://docs.sourcegraph.com/admin/config/webhooks/incoming#deprecation-notice + DEPRECATED: Webhook logs linked directly to an external service will be removed. See https://sourcegraph.com/docs/admin/config/webhooks/incoming#deprecation-notice """ webhookLogs( """ @@ -3376,7 +3376,7 @@ type ExternalService implements Node { until: DateTime ): WebhookLogConnection! @deprecated( - reason: "Webhook logs linked directly to an external service will be removed. See https://docs.sourcegraph.com/admin/config/webhooks/incoming#deprecation-notice" + reason: "Webhook logs linked directly to an external service will be removed. See https://sourcegraph.com/docs/admin/config/webhooks/incoming#deprecation-notice" ) """ @@ -7437,8 +7437,8 @@ type Site implements SettingsSubject { Note: This is primarily used for displaying recently-fired alerts in the web app. If your intent is to monitor Sourcegraph, it is better to configure alerting or query Prometheus directly in order to ensure that if the frontend goes down you still receive alerts: - Configure alerting: https://docs.sourcegraph.com/admin/observability/alerting - Query Prometheus directly: https://docs.sourcegraph.com/admin/observability/alerting_custom_consumption + Configure alerting: https://sourcegraph.com/docs/admin/observability/alerting + Query Prometheus directly: https://sourcegraph.com/docs/admin/observability/alerting_custom_consumption """ monitoringStatistics( """ @@ -8596,7 +8596,7 @@ type MonitoringStatistics { } """ -A high-level monitoring alert, for details see https://docs.sourcegraph.com/admin/observability/metrics#high-level-alerting-metrics +A high-level monitoring alert, for details see https://sourcegraph.com/docs/admin/observability/metrics#high-level-alerting-metrics """ type MonitoringAlert { """ diff --git a/cmd/frontend/graphqlbackend/site_config_change_connection_test.go b/cmd/frontend/graphqlbackend/site_config_change_connection_test.go index 09238b29dbb..bd1754b52bb 100644 --- a/cmd/frontend/graphqlbackend/site_config_change_connection_test.go +++ b/cmd/frontend/graphqlbackend/site_config_change_connection_test.go @@ -157,7 +157,7 @@ func setupSiteConfigStubs(t *testing.T) *siteConfigStubs { - // The builtin auth provider with signup disallowed (shown below) means that - // after the initial site admin signs in, all other users must be invited. - // -- // Other providers are documented at https://docs.sourcegraph.com/admin/auth. +- // Other providers are documented at https://sourcegraph.com/docs/admin/auth. - "auth.providers": [ - { - "type": "builtin" @@ -181,7 +181,7 @@ func setupSiteConfigStubs(t *testing.T) *siteConfigStubs { + // The builtin auth provider with signup disallowed (shown below) means that + // after the initial site admin signs in, all other users must be invited. + // -+ // Other providers are documented at https://docs.sourcegraph.com/admin/auth. ++ // Other providers are documented at https://sourcegraph.com/docs/admin/auth. + "auth.providers": [ + { + "type": "builtin" diff --git a/cmd/frontend/internal/auth/githuboauth/session.go b/cmd/frontend/internal/auth/githuboauth/session.go index aa5d10e5670..6d04b81c784 100644 --- a/cmd/frontend/internal/auth/githuboauth/session.go +++ b/cmd/frontend/internal/auth/githuboauth/session.go @@ -65,7 +65,7 @@ func (s *sessionIssuerHelper) GetOrCreateUser(ctx context.Context, token *oauth2 login, err := auth.NormalizeUsername(deref(ghUser.Login)) if err != nil { - return false, nil, fmt.Sprintf("Error normalizing the username %q. See https://docs.sourcegraph.com/admin/auth/#username-normalization.", login), err + return false, nil, fmt.Sprintf("Error normalizing the username %q. See https://sourcegraph.com/docs/admin/auth/#username-normalization.", login), err } ghClient := s.newClient(token.AccessToken) diff --git a/cmd/frontend/internal/auth/gitlaboauth/session.go b/cmd/frontend/internal/auth/gitlaboauth/session.go index 87f2eeca770..495d4a70ad7 100644 --- a/cmd/frontend/internal/auth/gitlaboauth/session.go +++ b/cmd/frontend/internal/auth/gitlaboauth/session.go @@ -66,7 +66,7 @@ func (s *sessionIssuerHelper) GetOrCreateUser(ctx context.Context, token *oauth2 login, err := auth.NormalizeUsername(gUser.Username) if err != nil { - return false, nil, fmt.Sprintf("Error normalizing the username %q. See https://docs.sourcegraph.com/admin/auth/#username-normalization.", login), err + return false, nil, fmt.Sprintf("Error normalizing the username %q. See https://sourcegraph.com/docs/admin/auth/#username-normalization.", login), err } provider := gitlab.NewClientProvider(extsvc.URNGitLabOAuth, s.BaseURL, nil) diff --git a/cmd/frontend/internal/auth/openidconnect/user.go b/cmd/frontend/internal/auth/openidconnect/user.go index e72d8737749..34c134811e2 100644 --- a/cmd/frontend/internal/auth/openidconnect/user.go +++ b/cmd/frontend/internal/auth/openidconnect/user.go @@ -62,7 +62,7 @@ func getOrCreateUser(ctx context.Context, db database.DB, p *Provider, token *oa login, err = auth.NormalizeUsername(login) if err != nil { return false, nil, - fmt.Sprintf("Error normalizing the username %q. See https://docs.sourcegraph.com/admin/auth/#username-normalization.", login), + fmt.Sprintf("Error normalizing the username %q. See https://sourcegraph.com/docs/admin/auth/#username-normalization.", login), errors.Wrap(err, "normalize username") } diff --git a/cmd/frontend/internal/auth/saml/user.go b/cmd/frontend/internal/auth/saml/user.go index aa16c4068be..4fb1eaf1bd0 100644 --- a/cmd/frontend/internal/auth/saml/user.go +++ b/cmd/frontend/internal/auth/saml/user.go @@ -101,7 +101,7 @@ func getOrCreateUser(ctx context.Context, db database.DB, allowSignup bool, info username, err := auth.NormalizeUsername(info.unnormalizedUsername) if err != nil { - return false, nil, fmt.Sprintf("Error normalizing the username %q. See https://docs.sourcegraph.com/admin/auth/#username-normalization.", info.unnormalizedUsername), err + return false, nil, fmt.Sprintf("Error normalizing the username %q. See https://sourcegraph.com/docs/admin/auth/#username-normalization.", info.unnormalizedUsername), err } newUserCreated, userID, safeErrMsg, err := auth.GetAndSaveUser(ctx, db, auth.GetAndSaveUserOp{ diff --git a/cmd/gitserver/README.md b/cmd/gitserver/README.md index 61df457dbda..5e03801d90a 100644 --- a/cmd/gitserver/README.md +++ b/cmd/gitserver/README.md @@ -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://docs.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`). +[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`). #### Bazel @@ -57,7 +57,7 @@ Native binaries are provided through Bazel, built via Nix in [our fork of p4-fus The `p4-fusion` native binary has been built on Linux and macOS, but is untested on Windows. -Read the [comprehensive instructions](https://docs.sourcegraph.com/dev/background-information/build_p4_fusion). +Read the [comprehensive instructions](https://sourcegraph.com/docs/dev/background-information/build_p4_fusion). If you do go the native binary route, you may also want to enable using the wrapper shell script that detects when the process has been killed and outputs an error so that the calling process can handle it. diff --git a/cmd/gitserver/internal/cleanup.go b/cmd/gitserver/internal/cleanup.go index 16491c6d31e..b26b4825479 100644 --- a/cmd/gitserver/internal/cleanup.go +++ b/cmd/gitserver/internal/cleanup.go @@ -129,7 +129,7 @@ const ( ) // gitGCMode describes which mode we should be running git gc. -// See for a detailed description of the modes: https://docs.sourcegraph.com/dev/background-information/git_gc +// See for a detailed description of the modes: https://sourcegraph.com/docs/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 diff --git a/cmd/pings/service/server.go b/cmd/pings/service/server.go index f48579b8246..599af8a610d 100644 --- a/cmd/pings/service/server.go +++ b/cmd/pings/service/server.go @@ -18,7 +18,7 @@ var meter = otel.GetMeterProvider().Meter("pings/shared") func registerServerHandlers(logger log.Logger, r *mux.Router, pubsubClient pubsub.TopicPublisher) error { r.Path("/").Methods(http.MethodGet).HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - http.Redirect(w, r, "https://docs.sourcegraph.com/admin/pings", http.StatusFound) + http.Redirect(w, r, "https://sourcegraph.com/docs/admin/pings", http.StatusFound) }) requestCounter, err := meter.Int64Counter( diff --git a/cmd/server/shared/assets/nginx.conf b/cmd/server/shared/assets/nginx.conf index 0d8118da503..da20c48e542 100644 --- a/cmd/server/shared/assets/nginx.conf +++ b/cmd/server/shared/assets/nginx.conf @@ -1,6 +1,6 @@ # This config was generated by Sourcegraph. # You can adjust the configuration to add additional TLS or HTTP features. -# Read more at https://docs.sourcegraph.com/admin/nginx +# Read more at https://sourcegraph.com/docs/admin/nginx error_log stderr; pid /var/run/nginx.pid; diff --git a/cmd/server/shared/shared.go b/cmd/server/shared/shared.go index 59979d39e99..2751d4f2735 100644 --- a/cmd/server/shared/shared.go +++ b/cmd/server/shared/shared.go @@ -323,7 +323,7 @@ func runPostgresReindex() { fmt.Printf("Upgrading to Sourcegraph 5.1 or later from an earlier release requires a database reindex.\n\n") fmt.Printf("This process may take several hours, depending on the size of your database.\n\n") fmt.Printf("If you do not wish to perform the reindex process now, you should switch back to a release before Sourcegraph 5.1.\n\n") - fmt.Printf("To perform the reindexing process now, please review the instructions at https://docs.sourcegraph.com/admin/migration/5_1 and restart the container with the environment variable `SOURCEGRAPH_5_1_DB_MIGRATION=true` set.\n") + fmt.Printf("To perform the reindexing process now, please review the instructions at https://sourcegraph.com/docs/admin/migration/5_1 and restart the container with the environment variable `SOURCEGRAPH_5_1_DB_MIGRATION=true` set.\n") fmt.Printf("\n**************** MIGRATION REQUIRED **************\n\n") os.Exit(101) diff --git a/cmd/symbols/internal/api/search_sqlite.go b/cmd/symbols/internal/api/search_sqlite.go index d0b7f86dc3f..dc7adadcc70 100644 --- a/cmd/symbols/internal/api/search_sqlite.go +++ b/cmd/symbols/internal/api/search_sqlite.go @@ -62,16 +62,16 @@ func MakeSqliteSearchFunc(observationCtx *observation.Context, cachedDatabaseWri defer cancel() info, err2 := db.GitserverRepos().GetByName(ctx, args.Repo) if err2 != nil { - err = errors.New("Processing symbols using the SQLite backend is taking a while. If this repository is ~1GB+, enable [Rockskip](https://docs.sourcegraph.com/code_navigation/explanations/rockskip).") + err = errors.New("Processing symbols using the SQLite backend is taking a while. If this repository is ~1GB+, enable [Rockskip](https://sourcegraph.com/docs/code_navigation/explanations/rockskip).") return } size := info.RepoSizeBytes help := "" if size > 1_000_000_000 { - help = "Enable [Rockskip](https://docs.sourcegraph.com/code_navigation/explanations/rockskip)." + help = "Enable [Rockskip](https://sourcegraph.com/docs/code_navigation/explanations/rockskip)." } else if size > 100_000_000 { - help = "If this persists, enable [Rockskip](https://docs.sourcegraph.com/code_navigation/explanations/rockskip)." + help = "If this persists, enable [Rockskip](https://sourcegraph.com/docs/code_navigation/explanations/rockskip)." } else { help = "If this persists, make sure the symbols service has an SSD, a few GHz of CPU, and a few GB of RAM." } diff --git a/cmd/telemetry-gateway/README.md b/cmd/telemetry-gateway/README.md index eebd1e6ae89..4936e4b7346 100644 --- a/cmd/telemetry-gateway/README.md +++ b/cmd/telemetry-gateway/README.md @@ -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://docs.sourcegraph.com/dev/how-to/telemetry_gateway) for more development guidance. +Refer to [the Telemetry Gateway development documentation](https://sourcegraph.com/docs/dev/how-to/telemetry_gateway) for more development guidance. diff --git a/cmd/worker/internal/authz/integration_test.go b/cmd/worker/internal/authz/integration_test.go index 804d1033640..c8b47f07141 100644 --- a/cmd/worker/internal/authz/integration_test.go +++ b/cmd/worker/internal/authz/integration_test.go @@ -104,7 +104,7 @@ func assertGitHubRepoPermissions(t *testing.T, ctx context.Context, repoID api.R // for GITHUB_TOKEN, which can be found in 1Password. // // We also recommend setting up a new token for "sourcegraph-vcr" using the auth scope -// guidelines https://docs.sourcegraph.com/admin/external_service/github#github-api-token-and-access +// guidelines https://sourcegraph.com/docs/admin/external_service/github#github-api-access // to ensure everything works, in case of new scopes being required. func TestIntegration_GitHubPermissions(t *testing.T) { if testing.Short() { diff --git a/cmd/worker/internal/permissions/bitbucket_projects.go b/cmd/worker/internal/permissions/bitbucket_projects.go index fde222ec287..0e555058700 100644 --- a/cmd/worker/internal/permissions/bitbucket_projects.go +++ b/cmd/worker/internal/permissions/bitbucket_projects.go @@ -372,7 +372,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://docs.sourcegraph.com/dev/background-information/workers#dequeueing-and-resetting-jobs +// See resetter documentation for more details. https://sourcegraph.com/docs/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) diff --git a/dev/build-tracker/notify/slack.go b/dev/build-tracker/notify/slack.go index fdc30660cdc..92f89423fcb 100644 --- a/dev/build-tracker/notify/slack.go +++ b/dev/build-tracker/notify/slack.go @@ -299,9 +299,9 @@ func (c *Client) createMessageBlocks(info *BuildNotification, author string) []s &slack.TextBlockObject{ Type: slack.MarkdownType, Text: `:books: *More information on flakes* -• +• • -• +• _Disable flakes on sight and save your fellow teammate some time!_`, }, diff --git a/dev/ci/README.md b/dev/ci/README.md index 618009e483c..147fe2f8ae6 100644 --- a/dev/ci/README.md +++ b/dev/ci/README.md @@ -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://docs.sourcegraph.com/dev/background-information/ci). +To learn more, refer to the [continuous integration docs](https://sourcegraph.com/docs/dev/background-information/ci). diff --git a/dev/ci/bazel-prechecks.sh b/dev/ci/bazel-prechecks.sh index 3b30f2a07fd..8d17a202532 100755 --- a/dev/ci/bazel-prechecks.sh +++ b/dev/ci/bazel-prechecks.sh @@ -51,7 +51,7 @@ if [[ $EXIT_CODE -ne 0 ]]; then sg bazel configure ``` - #### For more information please see the [Bazel FAQ](https://docs.sourcegraph.com/dev/background-information/bazel/faq) + #### For more information please see the [Bazel FAQ](https://sourcegraph.com/docs/dev/background-information/bazel/faq) END exit "$EXIT_CODE" @@ -75,7 +75,7 @@ if [[ $EXIT_CODE -ne 0 ]]; then sg bazel configure godeps ``` - #### For more information please see the [Bazel FAQ](https://docs.sourcegraph.com/dev/background-information/bazel/faq) + #### For more information please see the [Bazel FAQ](https://sourcegraph.com/docs/dev/background-information/bazel/faq) END exit "$EXIT_CODE" diff --git a/dev/ci/gen-metadata-annotation.sh b/dev/ci/gen-metadata-annotation.sh index 2d446f4c5b3..a0d6e484912 100755 --- a/dev/ci/gen-metadata-annotation.sh +++ b/dev/ci/gen-metadata-annotation.sh @@ -31,5 +31,5 @@ ${runType} ${diff} ${messageFlags}
    -Note that a Job has [**soft failed**](https://docs.sourcegraph.com/dev/background-information/ci#soft-failures) when you see this icon: ⚠️. +Note that a Job has [**soft failed**](https://sourcegraph.com/docs/dev/background-information/ci#soft-failures) when you see this icon: ⚠️. EOF diff --git a/dev/ci/gen-pipeline.go b/dev/ci/gen-pipeline.go index c16cd97cd35..83bacc7a651 100644 --- a/dev/ci/gen-pipeline.go +++ b/dev/ci/gen-pipeline.go @@ -123,7 +123,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://docs.sourcegraph.com/dev/background-information/ci).") + 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, "\n## Run types") diff --git a/dev/ci/trivy/README.md b/dev/ci/trivy/README.md index 475c04ecd00..65ca4099d91 100644 --- a/dev/ci/trivy/README.md +++ b/dev/ci/trivy/README.md @@ -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://docs.sourcegraph.com/dev/background-information/ci for more information. +See https://sourcegraph.com/docs/dev/background-information/ci for more information. diff --git a/dev/deployment-notifier/testdata/TestDeploymentNotifier/OK_single_commit.yaml b/dev/deployment-notifier/testdata/TestDeploymentNotifier/OK_single_commit.yaml index 9e43874073e..60d3a80a75c 100644 --- a/dev/deployment-notifier/testdata/TestDeploymentNotifier/OK_single_commit.yaml +++ b/dev/deployment-notifier/testdata/TestDeploymentNotifier/OK_single_commit.yaml @@ -392,7 +392,7 @@ interactions: part of SOC2/GN-104 and SOC2/GN-105 requirements, all pull requests are REQUIRED to\r\n provide a \"test plan\". A test plan is a loose explanation of what you have done or\r\n implemented to test this, or why this change does not - need testing, as outlined in our\r\n Testing principles and guidelines:\r\n https://docs.sourcegraph.com/dev/background-information/testing_principles\r\n Write + need testing, as outlined in our\r\n Testing principles and guidelines:\r\n https://sourcegraph.com/docs/dev/background-information/testing_principles\r\n Write your test plan here after the \"## Test plan\" header.\r\n-->\r\n\r\nGreen builds, this is just a linter update. \r\n","created_at":"2022-03-24T08:51:22Z","updated_at":"2022-03-24T08:57:19Z","closed_at":"2022-03-24T08:57:19Z","merged_at":"2022-03-24T08:57:19Z","merge_commit_sha":"e1aea6f8d82283695ae4a3b2b5a7a8f36b1b934b","assignee":null,"assignees":[],"requested_reviewers":[{"login":"camdencheek","id":12631702,"node_id":"MDQ6VXNlcjEyNjMxNzAy","avatar_url":"https://avatars.githubusercontent.com/u/12631702?v=4","gravatar_id":"","url":"https://api.github.com/users/camdencheek","html_url":"https://github.com/camdencheek","followers_url":"https://api.github.com/users/camdencheek/followers","following_url":"https://api.github.com/users/camdencheek/following{/other_user}","gists_url":"https://api.github.com/users/camdencheek/gists{/gist_id}","starred_url":"https://api.github.com/users/camdencheek/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/camdencheek/subscriptions","organizations_url":"https://api.github.com/users/camdencheek/orgs","repos_url":"https://api.github.com/users/camdencheek/repos","events_url":"https://api.github.com/users/camdencheek/events{/privacy}","received_events_url":"https://api.github.com/users/camdencheek/received_events","type":"User","site_admin":false}],"requested_teams":[],"labels":[{"id":3425773745,"node_id":"LA_kwDOAnYEBM7MMSix","url":"https://api.github.com/repos/sourcegraph/sourcegraph/labels/cla-signed","name":"cla-signed","color":"ededed","default":false,"description":null}],"milestone":null,"draft":false,"commits_url":"https://api.github.com/repos/sourcegraph/sourcegraph/pulls/32996/commits","review_comments_url":"https://api.github.com/repos/sourcegraph/sourcegraph/pulls/32996/comments","review_comment_url":"https://api.github.com/repos/sourcegraph/sourcegraph/pulls/comments{/number}","comments_url":"https://api.github.com/repos/sourcegraph/sourcegraph/issues/32996/comments","statuses_url":"https://api.github.com/repos/sourcegraph/sourcegraph/statuses/42e2822e244566101e31ebc461da0a9cdf4eca85","head":{"label":"sourcegraph:devx/bump-golang-ci","ref":"devx/bump-golang-ci","sha":"42e2822e244566101e31ebc461da0a9cdf4eca85","user":{"login":"sourcegraph","id":3979584,"node_id":"MDEyOk9yZ2FuaXphdGlvbjM5Nzk1ODQ=","avatar_url":"https://avatars.githubusercontent.com/u/3979584?v=4","gravatar_id":"","url":"https://api.github.com/users/sourcegraph","html_url":"https://github.com/sourcegraph","followers_url":"https://api.github.com/users/sourcegraph/followers","following_url":"https://api.github.com/users/sourcegraph/following{/other_user}","gists_url":"https://api.github.com/users/sourcegraph/gists{/gist_id}","starred_url":"https://api.github.com/users/sourcegraph/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sourcegraph/subscriptions","organizations_url":"https://api.github.com/users/sourcegraph/orgs","repos_url":"https://api.github.com/users/sourcegraph/repos","events_url":"https://api.github.com/users/sourcegraph/events{/privacy}","received_events_url":"https://api.github.com/users/sourcegraph/received_events","type":"Organization","site_admin":false},"repo":{"id":41288708,"node_id":"MDEwOlJlcG9zaXRvcnk0MTI4ODcwOA==","name":"sourcegraph","full_name":"sourcegraph/sourcegraph","private":false,"owner":{"login":"sourcegraph","id":3979584,"node_id":"MDEyOk9yZ2FuaXphdGlvbjM5Nzk1ODQ=","avatar_url":"https://avatars.githubusercontent.com/u/3979584?v=4","gravatar_id":"","url":"https://api.github.com/users/sourcegraph","html_url":"https://github.com/sourcegraph","followers_url":"https://api.github.com/users/sourcegraph/followers","following_url":"https://api.github.com/users/sourcegraph/following{/other_user}","gists_url":"https://api.github.com/users/sourcegraph/gists{/gist_id}","starred_url":"https://api.github.com/users/sourcegraph/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sourcegraph/subscriptions","organizations_url":"https://api.github.com/users/sourcegraph/orgs","repos_url":"https://api.github.com/users/sourcegraph/repos","events_url":"https://api.github.com/users/sourcegraph/events{/privacy}","received_events_url":"https://api.github.com/users/sourcegraph/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/sourcegraph/sourcegraph","description":"Universal code search (self-hosted)","fork":false,"url":"https://api.github.com/repos/sourcegraph/sourcegraph","forks_url":"https://api.github.com/repos/sourcegraph/sourcegraph/forks","keys_url":"https://api.github.com/repos/sourcegraph/sourcegraph/keys{/key_id}","collaborators_url":"https://api.github.com/repos/sourcegraph/sourcegraph/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/sourcegraph/sourcegraph/teams","hooks_url":"https://api.github.com/repos/sourcegraph/sourcegraph/hooks","issue_events_url":"https://api.github.com/repos/sourcegraph/sourcegraph/issues/events{/number}","events_url":"https://api.github.com/repos/sourcegraph/sourcegraph/events","assignees_url":"https://api.github.com/repos/sourcegraph/sourcegraph/assignees{/user}","branches_url":"https://api.github.com/repos/sourcegraph/sourcegraph/branches{/branch}","tags_url":"https://api.github.com/repos/sourcegraph/sourcegraph/tags","blobs_url":"https://api.github.com/repos/sourcegraph/sourcegraph/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/sourcegraph/sourcegraph/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/sourcegraph/sourcegraph/git/refs{/sha}","trees_url":"https://api.github.com/repos/sourcegraph/sourcegraph/git/trees{/sha}","statuses_url":"https://api.github.com/repos/sourcegraph/sourcegraph/statuses/{sha}","languages_url":"https://api.github.com/repos/sourcegraph/sourcegraph/languages","stargazers_url":"https://api.github.com/repos/sourcegraph/sourcegraph/stargazers","contributors_url":"https://api.github.com/repos/sourcegraph/sourcegraph/contributors","subscribers_url":"https://api.github.com/repos/sourcegraph/sourcegraph/subscribers","subscription_url":"https://api.github.com/repos/sourcegraph/sourcegraph/subscription","commits_url":"https://api.github.com/repos/sourcegraph/sourcegraph/commits{/sha}","git_commits_url":"https://api.github.com/repos/sourcegraph/sourcegraph/git/commits{/sha}","comments_url":"https://api.github.com/repos/sourcegraph/sourcegraph/comments{/number}","issue_comment_url":"https://api.github.com/repos/sourcegraph/sourcegraph/issues/comments{/number}","contents_url":"https://api.github.com/repos/sourcegraph/sourcegraph/contents/{+path}","compare_url":"https://api.github.com/repos/sourcegraph/sourcegraph/compare/{base}...{head}","merges_url":"https://api.github.com/repos/sourcegraph/sourcegraph/merges","archive_url":"https://api.github.com/repos/sourcegraph/sourcegraph/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/sourcegraph/sourcegraph/downloads","issues_url":"https://api.github.com/repos/sourcegraph/sourcegraph/issues{/number}","pulls_url":"https://api.github.com/repos/sourcegraph/sourcegraph/pulls{/number}","milestones_url":"https://api.github.com/repos/sourcegraph/sourcegraph/milestones{/number}","notifications_url":"https://api.github.com/repos/sourcegraph/sourcegraph/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/sourcegraph/sourcegraph/labels{/name}","releases_url":"https://api.github.com/repos/sourcegraph/sourcegraph/releases{/id}","deployments_url":"https://api.github.com/repos/sourcegraph/sourcegraph/deployments","created_at":"2015-08-24T07:27:28Z","updated_at":"2022-03-24T14:07:31Z","pushed_at":"2022-03-24T15:05:25Z","git_url":"git://github.com/sourcegraph/sourcegraph.git","ssh_url":"git@github.com:sourcegraph/sourcegraph.git","clone_url":"https://github.com/sourcegraph/sourcegraph.git","svn_url":"https://github.com/sourcegraph/sourcegraph","homepage":"https://sourcegraph.com","size":626663,"stargazers_count":5855,"watchers_count":5855,"language":"Go","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":729,"mirror_url":null,"archived":false,"disabled":false,"open_issues_count":3597,"license":{"key":"other","name":"Other","spdx_id":"NOASSERTION","url":null,"node_id":"MDc6TGljZW5zZTA="},"allow_forking":true,"is_template":false,"topics":["code-intelligence","code-search","lsif-enabled","open-source","repo-type-main","sourcegraph"],"visibility":"public","forks":729,"open_issues":3597,"watchers":5855,"default_branch":"main"}},"base":{"label":"sourcegraph:main","ref":"main","sha":"68374f229042704f1663ca2fd19401ba0772c828","user":{"login":"sourcegraph","id":3979584,"node_id":"MDEyOk9yZ2FuaXphdGlvbjM5Nzk1ODQ=","avatar_url":"https://avatars.githubusercontent.com/u/3979584?v=4","gravatar_id":"","url":"https://api.github.com/users/sourcegraph","html_url":"https://github.com/sourcegraph","followers_url":"https://api.github.com/users/sourcegraph/followers","following_url":"https://api.github.com/users/sourcegraph/following{/other_user}","gists_url":"https://api.github.com/users/sourcegraph/gists{/gist_id}","starred_url":"https://api.github.com/users/sourcegraph/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sourcegraph/subscriptions","organizations_url":"https://api.github.com/users/sourcegraph/orgs","repos_url":"https://api.github.com/users/sourcegraph/repos","events_url":"https://api.github.com/users/sourcegraph/events{/privacy}","received_events_url":"https://api.github.com/users/sourcegraph/received_events","type":"Organization","site_admin":false},"repo":{"id":41288708,"node_id":"MDEwOlJlcG9zaXRvcnk0MTI4ODcwOA==","name":"sourcegraph","full_name":"sourcegraph/sourcegraph","private":false,"owner":{"login":"sourcegraph","id":3979584,"node_id":"MDEyOk9yZ2FuaXphdGlvbjM5Nzk1ODQ=","avatar_url":"https://avatars.githubusercontent.com/u/3979584?v=4","gravatar_id":"","url":"https://api.github.com/users/sourcegraph","html_url":"https://github.com/sourcegraph","followers_url":"https://api.github.com/users/sourcegraph/followers","following_url":"https://api.github.com/users/sourcegraph/following{/other_user}","gists_url":"https://api.github.com/users/sourcegraph/gists{/gist_id}","starred_url":"https://api.github.com/users/sourcegraph/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sourcegraph/subscriptions","organizations_url":"https://api.github.com/users/sourcegraph/orgs","repos_url":"https://api.github.com/users/sourcegraph/repos","events_url":"https://api.github.com/users/sourcegraph/events{/privacy}","received_events_url":"https://api.github.com/users/sourcegraph/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/sourcegraph/sourcegraph","description":"Universal diff --git a/dev/gqltest/organization_test.go b/dev/gqltest/organization_test.go index 2e088b57d14..4ad40f448f7 100644 --- a/dev/gqltest/organization_test.go +++ b/dev/gqltest/organization_test.go @@ -93,7 +93,7 @@ func TestOrganization(t *testing.T) { } }) - // Docs: https://docs.sourcegraph.com/user/organizations + // Docs: https://sourcegraph.com/docs/user/organizations t.Run("auth.userOrgMap", func(t *testing.T) { // Create a test user (gqltest-org-user-1) without settings "auth.userOrgMap", // the user should not be added to the organization (gqltest-org) automatically. diff --git a/dev/internal/cmd/auth-proxy-http-header/auth-proxy-http-header.go b/dev/internal/cmd/auth-proxy-http-header/auth-proxy-http-header.go index 6f35eded9e1..d688183bb55 100644 --- a/dev/internal/cmd/auth-proxy-http-header/auth-proxy-http-header.go +++ b/dev/internal/cmd/auth-proxy-http-header/auth-proxy-http-header.go @@ -45,7 +45,7 @@ func main() { log.Fatal(err) } - fmt.Printf(`https://docs.sourcegraph.com/admin/auth#http-authentication-proxies + fmt.Printf(`https://sourcegraph.com/docs/admin/auth#http-authentication-proxies "auth.providers": [ { diff --git a/dev/licenses.sh b/dev/licenses.sh index 5ed37890ede..6dca9188aad 100755 --- a/dev/licenses.sh +++ b/dev/licenses.sh @@ -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://docs.sourcegraph.com/dev/background-information/ci#third-party-licenses +# Please refer to the handbook entry for more details: https://sourcegraph.com/docs/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://docs.sourcegraph.com/dev/background-information/ci#third-party-licenses" +echo "Running license_finder - if this fails, refer to our handbook: https://sourcegraph.com/docs/dev/background-information/ci#third-party-licenses" license_finder "${COMMAND}" --columns=package_manager name version licenses homepage approved diff --git a/dev/redis-postgres.yml b/dev/redis-postgres.yml index 533a480ef33..da28784aacd 100644 --- a/dev/redis-postgres.yml +++ b/dev/redis-postgres.yml @@ -1,7 +1,7 @@ # This files provides an easy way to start Redis and PostgreSQL servers for # development, via docker-compose. # -# See https://docs.sourcegraph.com/dev/getting-started/quickstart_3_initialize_database#with-docker +# See https://sourcegraph.com/docs/dev/setup/quickstart#run-databases # # You can also use `sg run redis-postgres`. services: diff --git a/dev/release/src/batchChanges.ts b/dev/release/src/batchChanges.ts index 1101e520163..10b44f22f18 100644 --- a/dev/release/src/batchChanges.ts +++ b/dev/release/src/batchChanges.ts @@ -133,7 +133,7 @@ export async function addToBatchChange( } /** - * Subset of batch change spec: https://docs.sourcegraph.com/batch_changes/references/batch_spec_yaml_reference + * Subset of batch change spec: https://sourcegraph.com/docs/batch_changes/references/batch_spec_yaml_reference */ interface BatchChangeSpec { name: string diff --git a/dev/release/src/github.ts b/dev/release/src/github.ts index 5fed5615a7f..5396950c478 100644 --- a/dev/release/src/github.ts +++ b/dev/release/src/github.ts @@ -668,7 +668,7 @@ export async function createLatestRelease( return '' } - const updateURL = 'https://docs.sourcegraph.com/admin/updates' + const updateURL = 'https://sourcegraph.com/docs/admin/updates' const releasePostURL = `https://sourcegraph.com/blog/release/${release.major}.${release.minor}` // CI:URL_OK const request: Octokit.RequestOptions & Octokit.ReposCreateReleaseParams = { diff --git a/dev/sg/README.md b/dev/sg/README.md index 26d5362599d..cc3e737af0f 100644 --- a/dev/sg/README.md +++ b/dev/sg/README.md @@ -26,4 +26,4 @@ ``` `sg` is the CLI tool that Sourcegraph developers can use to develop Sourcegraph. -Learn more about it [here](https://docs.sourcegraph.com/dev/background-information/sg). +Learn more about it [here](https://sourcegraph.com/docs/dev/background-information/sg). diff --git a/dev/sg/VISION.md b/dev/sg/VISION.md index 570af6916e7..23ecd807daa 100644 --- a/dev/sg/VISION.md +++ b/dev/sg/VISION.md @@ -1,3 +1,3 @@ # `sg` Vision -This page has moved to [`sg` vision](https://docs.sourcegraph.com/dev/background-information/sg/vision). +This page has moved to [`sg` vision](https://sourcegraph.com/docs/dev/background-information/sg/vision). diff --git a/dev/sg/internal/check/common.go b/dev/sg/internal/check/common.go index 6847ed3c9f3..02821271f0a 100644 --- a/dev/sg/internal/check/common.go +++ b/dev/sg/internal/check/common.go @@ -189,7 +189,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://docs.sourcegraph.com/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://sourcegraph.com/docs/dev/background-information/sg#changing-database-configuration)", dsn) } return nil } diff --git a/dev/sg/internal/migration/add.go b/dev/sg/internal/migration/add.go index f31a40ac8c1..c6e8092facb 100644 --- a/dev/sg/internal/migration/add.go +++ b/dev/sg/internal/migration/add.go @@ -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://docs.sourcegraph.com/dev/background-information/sql/migrations") + line := output.Styled(output.StyleUnderline, "https://sourcegraph.com/docs/dev/background-information/sql/migrations") line.Prefix = "Checkout the development docs for migrations: " std.Out.WriteLine(line) diff --git a/dev/sg/linters/go_checks.go b/dev/sg/linters/go_checks.go index 9a380d57157..44f13799063 100644 --- a/dev/sg/linters/go_checks.go +++ b/dev/sg/linters/go_checks.go @@ -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://docs.sourcegraph.com/dev/how-to/add_logging", + HelpText: "Learn more about logging and why some libraries are banned: https://sourcegraph.com/docs/dev/how-to/add_logging", }) } diff --git a/dev/sg/main.go b/dev/sg/main.go index 2bcf06f341a..cfcd2e10bdd 100644 --- a/dev/sg/main.go +++ b/dev/sg/main.go @@ -84,7 +84,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://docs.sourcegraph.com/dev/background-information/sg", + Description: "Learn more: https://sourcegraph.com/docs/dev/background-information/sg", Version: BuildCommit, Compiled: time.Now(), Flags: []cli.Flag{ diff --git a/dev/sg/sg_audit.go b/dev/sg/sg_audit.go index 87743122eee..b0d4421e67c 100644 --- a/dev/sg/sg_audit.go +++ b/dev/sg/sg_audit.go @@ -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://docs.sourcegraph.com/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://sourcegraph.com/docs/dev/background-information/testing_principles#test-plans) and [reviews](https://docs.sourcegraph.com/dev/background-information/pull_request_reviews). {{""}} {{- range . }} - _{{ .CreatedAt }}_ @{{ .Author }} diff --git a/dev/sg/sg_cloud.go b/dev/sg/sg_cloud.go index 0d3af9a6989..778ee37a28d 100644 --- a/dev/sg/sg_cloud.go +++ b/dev/sg/sg_cloud.go @@ -24,7 +24,7 @@ var cloudCommand = &cli.Command{ Usage: "Install and work with Sourcegraph Cloud tools", Description: `Learn more about Sourcegraph Cloud: -- Product: https://docs.sourcegraph.com/cloud +- Product: https://sourcegraph.com/docs/cloud - Handbook: https://handbook.sourcegraph.com/departments/cloud/ `, Category: category.Company, diff --git a/dev/sg/sg_monitoring.go b/dev/sg/sg_monitoring.go index b9243949228..d588e498307 100644 --- a/dev/sg/sg_monitoring.go +++ b/dev/sg/sg_monitoring.go @@ -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://docs.sourcegraph.com/dev/background-information/observability/monitoring-generator + Description: `Learn more about the Sourcegraph monitoring generator here: https://sourcegraph.com/docs/dev/background-information/observability/monitoring-generator Also refer to the generated reference documentation available for site admins: diff --git a/dev/sg/sg_start.go b/dev/sg/sg_start.go index f9faeeecd4a..71bc0ad828c 100644 --- a/dev/sg/sg_start.go +++ b/dev/sg/sg_start.go @@ -251,7 +251,7 @@ func startExec(ctx *cli.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://docs.sourcegraph.com/dev/setup/quickstart#run-sg-setup")) + 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.Write("") overwritePath := filepath.Join(repoRoot, "sg.config.overwrite.yaml") diff --git a/dev/sg/sg_telemetry.go b/dev/sg/sg_telemetry.go index 9f6f1e803de..4fd49dcf032 100644 --- a/dev/sg/sg_telemetry.go +++ b/dev/sg/sg_telemetry.go @@ -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://docs.sourcegraph.com/dev/background-information/telemetry +For more details, see https://sourcegraph.com/docs/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://docs.sourcegraph.com/dev/background-information/data-usage-pipeline#allow-list +https://sourcegraph.com/docs/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. `, diff --git a/doc/admin/observability/alerts.md b/doc/admin/observability/alerts.md index 4f9d832ad02..f14fc349d8f 100644 --- a/doc/admin/observability/alerts.md +++ b/doc/admin/observability/alerts.md @@ -208,7 +208,7 @@ Generated query for warning alert: `max((sum by (alert_type) (increase(src_graph - Confirm that the Sourcegraph frontend has enough CPU/memory using the provisioning panels. - Investigate potential sources of latency by selecting Explore and modifying the `sum by(le)` section to include additional labels: for example, `sum by(le, job)` or `sum by (le, instance)`. -- Trace a request to see what the slowest part is: https://docs.sourcegraph.com/admin/observability/tracing +- Trace a request to see what the slowest part is: https://sourcegraph.com/docs/admin/observability/tracing - Learn more about the related dashboard panel in the [dashboards reference](./dashboards.md#frontend-page-load-latency). - **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: @@ -842,7 +842,7 @@ Generated query for critical alert: `max((sum(increase(src_cloudkms_cryptographi **Next steps** - Increase SRC_PGSQL_MAX_OPEN together with giving more memory to the database if needed -- Scale up Postgres memory/cpus - [see our scaling guide](https://docs.sourcegraph.com/admin/config/postgres-conf) +- Scale up Postgres memory/cpus - [see our scaling guide](https://sourcegraph.com/docs/admin/config/postgres-conf) - If using GCP Cloud SQL, check for high lock waits or CPU usage in query insights - Learn more about the related dashboard panel in the [dashboards reference](./dashboards.md#frontend-mean-blocked-seconds-per-conn-request). - **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: @@ -1518,7 +1518,7 @@ Generated query for critical alert: `max((max(max_over_time(src_conf_client_time **Next steps** - Increase SRC_PGSQL_MAX_OPEN together with giving more memory to the database if needed -- Scale up Postgres memory/cpus - [see our scaling guide](https://docs.sourcegraph.com/admin/config/postgres-conf) +- Scale up Postgres memory/cpus - [see our scaling guide](https://sourcegraph.com/docs/admin/config/postgres-conf) - If using GCP Cloud SQL, check for high lock waits or CPU usage in query insights - Learn more about the related dashboard panel in the [dashboards reference](./dashboards.md#gitserver-mean-blocked-seconds-per-conn-request). - **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: @@ -1836,7 +1836,7 @@ Generated query for warning alert: `min((sum by (job) (pg_stat_activity_count{da **Next steps** -- Consider increasing [max_connections](https://www.postgresql.org/docs/current/runtime-config-connection.html#GUC-MAX-CONNECTIONS) of the database instance, [learn more](https://docs.sourcegraph.com/admin/config/postgres-conf) +- Consider increasing [max_connections](https://www.postgresql.org/docs/current/runtime-config-connection.html#GUC-MAX-CONNECTIONS) of the database instance, [learn more](https://sourcegraph.com/docs/admin/config/postgres-conf) - Learn more about the related dashboard panel in the [dashboards reference](./dashboards.md#postgres-usage-connections-percentage). - **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: @@ -2260,7 +2260,7 @@ Generated query for warning alert: `max((max(src_codeintel_upload_queued_duratio **Next steps** - Increase SRC_PGSQL_MAX_OPEN together with giving more memory to the database if needed -- Scale up Postgres memory/cpus - [see our scaling guide](https://docs.sourcegraph.com/admin/config/postgres-conf) +- Scale up Postgres memory/cpus - [see our scaling guide](https://sourcegraph.com/docs/admin/config/postgres-conf) - If using GCP Cloud SQL, check for high lock waits or CPU usage in query insights - Learn more about the related dashboard panel in the [dashboards reference](./dashboards.md#precise-code-intel-worker-mean-blocked-seconds-per-conn-request). - **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: @@ -3204,7 +3204,7 @@ Generated query for warning alert: `max((max(src_codeintel_commit_graph_queued_d **Next steps** - **Enabled permissions for the first time:** Wait for few minutes and see if the number goes down. -- **Otherwise:** Increase the API rate limit to [GitHub](https://docs.sourcegraph.com/admin/external_service/github#github-com-rate-limits), [GitLab](https://docs.sourcegraph.com/admin/external_service/gitlab#internal-rate-limits) or [Bitbucket Server](https://docs.sourcegraph.com/admin/external_service/bitbucket_server#internal-rate-limits). +- **Otherwise:** Increase the API rate limit to [GitHub](https://sourcegraph.com/docs/admin/external_service/github#github-com-rate-limits), [GitLab](https://sourcegraph.com/docs/admin/external_service/gitlab#internal-rate-limits) or [Bitbucket Server](https://sourcegraph.com/docs/admin/external_service/bitbucket_server#internal-rate-limits). - Learn more about the related dashboard panel in the [dashboards reference](./dashboards.md#worker-perms-syncer-outdated-perms). - **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: @@ -3331,7 +3331,7 @@ Generated query for warning alert: `max((max(src_query_runner_worker_total{job=~ **Next steps** - Increase SRC_PGSQL_MAX_OPEN together with giving more memory to the database if needed -- Scale up Postgres memory/cpus - [see our scaling guide](https://docs.sourcegraph.com/admin/config/postgres-conf) +- Scale up Postgres memory/cpus - [see our scaling guide](https://sourcegraph.com/docs/admin/config/postgres-conf) - If using GCP Cloud SQL, check for high lock waits or CPU usage in query insights - Learn more about the related dashboard panel in the [dashboards reference](./dashboards.md#worker-mean-blocked-seconds-per-conn-request). - **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: @@ -4448,7 +4448,7 @@ Generated query for critical alert: `max((max(max_over_time(src_conf_client_time **Next steps** - Increase SRC_PGSQL_MAX_OPEN together with giving more memory to the database if needed -- Scale up Postgres memory/cpus - [see our scaling guide](https://docs.sourcegraph.com/admin/config/postgres-conf) +- Scale up Postgres memory/cpus - [see our scaling guide](https://sourcegraph.com/docs/admin/config/postgres-conf) - If using GCP Cloud SQL, check for high lock waits or CPU usage in query insights - Learn more about the related dashboard panel in the [dashboards reference](./dashboards.md#repo-updater-mean-blocked-seconds-per-conn-request). - **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: @@ -4893,7 +4893,7 @@ Generated query for critical alert: `max((max(max_over_time(src_conf_client_time **Next steps** - Increase SRC_PGSQL_MAX_OPEN together with giving more memory to the database if needed -- Scale up Postgres memory/cpus - [see our scaling guide](https://docs.sourcegraph.com/admin/config/postgres-conf) +- Scale up Postgres memory/cpus - [see our scaling guide](https://sourcegraph.com/docs/admin/config/postgres-conf) - If using GCP Cloud SQL, check for high lock waits or CPU usage in query insights - Learn more about the related dashboard panel in the [dashboards reference](./dashboards.md#searcher-mean-blocked-seconds-per-conn-request). - **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: @@ -5278,7 +5278,7 @@ Generated query for critical alert: `max((max(max_over_time(src_conf_client_time **Next steps** - Increase SRC_PGSQL_MAX_OPEN together with giving more memory to the database if needed -- Scale up Postgres memory/cpus - [see our scaling guide](https://docs.sourcegraph.com/admin/config/postgres-conf) +- Scale up Postgres memory/cpus - [see our scaling guide](https://sourcegraph.com/docs/admin/config/postgres-conf) - If using GCP Cloud SQL, check for high lock waits or CPU usage in query insights - Learn more about the related dashboard panel in the [dashboards reference](./dashboards.md#symbols-mean-blocked-seconds-per-conn-request). - **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: @@ -5987,7 +5987,7 @@ Generated query for warning alert: `max((sum by (code) (increase(src_zoekt_reque - Enabling shard merging for Zoekt: Set SRC_ENABLE_SHARD_MERGING="1" for zoekt-indexserver. Use this option if your corpus of repositories has a high percentage of small, rarely updated repositories. See -[documentation](https://docs.sourcegraph.com/code_search/explanations/search_details#shard-merging). +[documentation](https://sourcegraph.com/docs/code-search/features#shard-merging). - Creating additional Zoekt replicas: This spreads all the shards out amongst more replicas, which means that each _individual_ replica will have fewer shards. This, in turn, decreases the amount of memory map areas that a _single_ replica can create (in order to load the shards into memory). @@ -6576,7 +6576,7 @@ Generated query for warning alert: `max((sum by (rule_group) (rate(prometheus_ru **Next steps** - Check the Container monitoring (not available on server) panels and try increasing resources for Prometheus if necessary. -- Ensure that your [`observability.alerts` configuration](https://docs.sourcegraph.com/admin/observability/alerting#setting-up-alerting) (in site configuration) is valid. +- Ensure that your [`observability.alerts` configuration](https://sourcegraph.com/docs/admin/observability/alerting#setting-up-alerting) (in site configuration) is valid. - Check if the relevant alert integration service is experiencing downtime or issues. - Learn more about the related dashboard panel in the [dashboards reference](./dashboards.md#prometheus-alertmanager-notification-latency). - **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: @@ -6608,7 +6608,7 @@ Generated query for warning alert: `max((sum by (integration) (rate(alertmanager **Next steps** -- Ensure that your [`observability.alerts` configuration](https://docs.sourcegraph.com/admin/observability/alerting#setting-up-alerting) (in site configuration) is valid. +- Ensure that your [`observability.alerts` configuration](https://sourcegraph.com/docs/admin/observability/alerting#setting-up-alerting) (in site configuration) is valid. - Check if the relevant alert integration service is experiencing downtime or issues. - Learn more about the related dashboard panel in the [dashboards reference](./dashboards.md#prometheus-alertmanager-notification-failures). - **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: @@ -6641,7 +6641,7 @@ Generated query for warning alert: `max((sum by (integration) (rate(alertmanager **Next steps** - Check Prometheus logs for messages related to configuration loading. -- Ensure any [custom configuration you have provided Prometheus](https://docs.sourcegraph.com/admin/observability/metrics#prometheus-configuration) is valid. +- Ensure any [custom configuration you have provided Prometheus](https://sourcegraph.com/docs/admin/observability/metrics#prometheus-configuration) is valid. - More help interpreting this metric is available in the [dashboards reference](./dashboards.md#prometheus-prometheus-config-status). - **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: @@ -6672,7 +6672,7 @@ Generated query for warning alert: `min((prometheus_config_last_reload_successfu **Next steps** -- Ensure that your [`observability.alerts` configuration](https://docs.sourcegraph.com/admin/observability/alerting#setting-up-alerting) (in site configuration) is valid. +- Ensure that your [`observability.alerts` configuration](https://sourcegraph.com/docs/admin/observability/alerting#setting-up-alerting) (in site configuration) is valid. - More help interpreting this metric is available in the [dashboards reference](./dashboards.md#prometheus-alertmanager-config-status). - **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: @@ -7661,7 +7661,7 @@ Generated query for critical alert: `max((max(max_over_time(src_conf_client_time **Next steps** - Increase SRC_PGSQL_MAX_OPEN together with giving more memory to the database if needed -- Scale up Postgres memory/cpus - [see our scaling guide](https://docs.sourcegraph.com/admin/config/postgres-conf) +- Scale up Postgres memory/cpus - [see our scaling guide](https://sourcegraph.com/docs/admin/config/postgres-conf) - If using GCP Cloud SQL, check for high lock waits or CPU usage in query insights - Learn more about the related dashboard panel in the [dashboards reference](./dashboards.md#embeddings-mean-blocked-seconds-per-conn-request). - **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: diff --git a/doc/admin/observability/dashboards.md b/doc/admin/observability/dashboards.md index 5a0586c793e..f9d0a0c53b6 100644 --- a/doc/admin/observability/dashboards.md +++ b/doc/admin/observability/dashboards.md @@ -4,7 +4,7 @@ This document contains a complete reference on Sourcegraph's available dashboards, as well as details on how to interpret the panels and metrics. -To learn more about Sourcegraph's metrics and how to view these dashboards, see [our metrics guide](https://docs.sourcegraph.com/admin/observability/metrics). +To learn more about Sourcegraph's metrics and how to view these dashboards, see [our metrics guide](https://sourcegraph.com/docs/admin/observability/metrics). ## Frontend @@ -5223,7 +5223,7 @@ p95 response time to incoming webhook requests from code hosts. Increases in response time can point to too much load on the database to keep up with the incoming requests. - See this documentation page for more details on webhook requests: (https://docs.sourcegraph.com/admin/config/webhooks/incoming) + See this documentation page for more details on webhook requests: (https://sourcegraph.com/docs/admin/config/webhooks/incoming) This panel has no related alerts. @@ -11478,7 +11478,7 @@ Query: `max by (type) (ceil(rate(src_repo_perms_syncer_sync_errors_total[1m])))`

    Total number of repos scheduled for permissions sync

    Indicates how many repositories have been scheduled for a permissions sync. -More about repository permissions synchronization [here](https://docs.sourcegraph.com/admin/permissions/syncing#scheduling) +More about repository permissions synchronization [here](https://sourcegraph.com/docs/admin/permissions/syncing#scheduling) This panel has no related alerts. @@ -22485,7 +22485,7 @@ Query: `sum by(job) (scrape_samples_post_metric_relabeling{job!=""})` A high value here indicates Prometheus rule evaluation is taking longer than expected. It might indicate that certain rule groups are taking too long to evaluate, or Prometheus is underprovisioned. -Rules that Sourcegraph ships with are grouped under `/sg_config_prometheus`. [Custom rules are grouped under `/sg_prometheus_addons`](https://docs.sourcegraph.com/admin/observability/metrics#prometheus-configuration). +Rules that Sourcegraph ships with are grouped under `/sg_config_prometheus`. [Custom rules are grouped under `/sg_prometheus_addons`](https://sourcegraph.com/docs/admin/observability/metrics#prometheus-configuration). Refer to the [alerts reference](./alerts.md#prometheus-prometheus-rule-eval-duration) for 1 alert related to this panel. @@ -22506,7 +22506,7 @@ Query: `sum by(rule_group) (avg_over_time(prometheus_rule_group_last_duration_se

    Failed prometheus rule evaluations over 5m by rule group

    -Rules that Sourcegraph ships with are grouped under `/sg_config_prometheus`. [Custom rules are grouped under `/sg_prometheus_addons`](https://docs.sourcegraph.com/admin/observability/metrics#prometheus-configuration). +Rules that Sourcegraph ships with are grouped under `/sg_config_prometheus`. [Custom rules are grouped under `/sg_prometheus_addons`](https://sourcegraph.com/docs/admin/observability/metrics#prometheus-configuration). Refer to the [alerts reference](./alerts.md#prometheus-prometheus-rule-eval-failures) for 1 alert related to this panel. diff --git a/docker-images/alpine-3.14/Dockerfile b/docker-images/alpine-3.14/Dockerfile index af8bfd1432e..fb0b1189040 100644 --- a/docker-images/alpine-3.14/Dockerfile +++ b/docker-images/alpine-3.14/Dockerfile @@ -6,7 +6,7 @@ FROM alpine:3.14@sha256:92d13cc58a46e012300ef49924edc56de5642ada25c9a457dce4a6db LABEL org.opencontainers.image.url=https://sourcegraph.com/ LABEL org.opencontainers.image.source=https://github.com/sourcegraph/sourcegraph/ -LABEL org.opencontainers.image.documentation=https://docs.sourcegraph.com/ +LABEL org.opencontainers.image.documentation=https://sourcegraph.com/docs/ # Add the sourcegraph group, user, and create the home directory. # diff --git a/docker-images/cadvisor/README.md b/docker-images/cadvisor/README.md index 9bb18d3b0bd..77886d7aa7d 100644 --- a/docker-images/cadvisor/README.md +++ b/docker-images/cadvisor/README.md @@ -1,6 +1,6 @@ # Sourcegraph cAdvisor -Learn more about the Sourcegraph cAdvisor distribution in the [cAdvisor documentation](https://docs.sourcegraph.com/dev/background-information/observability/cadvisor). +Learn more about the Sourcegraph cAdvisor distribution in the [cAdvisor documentation](https://sourcegraph.com/docs/dev/background-information/observability/cadvisor). ## Updating the image diff --git a/docker-images/dind/Dockerfile b/docker-images/dind/Dockerfile index 39e7e55052b..37e34e8b645 100644 --- a/docker-images/dind/Dockerfile +++ b/docker-images/dind/Dockerfile @@ -12,7 +12,7 @@ LABEL org.opencontainers.image.created=${DATE} LABEL org.opencontainers.image.version=${VERSION} LABEL org.opencontainers.image.url=https://sourcegraph.com/ LABEL org.opencontainers.image.source=https://github.com/sourcegraph/sourcegraph/ -LABEL org.opencontainers.image.documentation=https://docs.sourcegraph.com/ +LABEL org.opencontainers.image.documentation=https://sourcegraph.com/docs/ LABEL com.sourcegraph.github.url=https://github.com/sourcegraph/sourcegraph/commit/${COMMIT_SHA} VOLUME /var/lib/docker diff --git a/docker-images/grafana/README.md b/docker-images/grafana/README.md index 7909ba5d01b..0bcfb369cca 100644 --- a/docker-images/grafana/README.md +++ b/docker-images/grafana/README.md @@ -2,7 +2,7 @@ Vanilla Grafana image with provisioned Sourcegraph dashboards and config. -To learn more, refer to the [Sourcegraph observability developer guide](https://docs.sourcegraph.com/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://sourcegraph.com/docs/dev/background-information/observability) and [monitoring architecture](https://handbook.sourcegraph.com/engineering/observability/monitoring_architecture#sourcegraph-grafana). ## Image API diff --git a/docker-images/opentelemetry-collector/README.md b/docker-images/opentelemetry-collector/README.md index 79d4ca5168c..4c3330fa8ba 100644 --- a/docker-images/opentelemetry-collector/README.md +++ b/docker-images/opentelemetry-collector/README.md @@ -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://docs.sourcegraph.com/dev/background-information/ci#image-vulnerability-scanning) to audit the bundled dependencies. +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. To get started: diff --git a/docker-images/prometheus/README.md b/docker-images/prometheus/README.md index 541fb4b7a01..fb9043b5f50 100644 --- a/docker-images/prometheus/README.md +++ b/docker-images/prometheus/README.md @@ -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://docs.sourcegraph.com/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://sourcegraph.com/docs/dev/background-information/observability) and [monitoring architecture](https://handbook.sourcegraph.com/engineering/observability/monitoring_architecture#sourcegraph-prometheus). ## Image API diff --git a/docker-images/prometheus/cmd/prom-wrapper/README.md b/docker-images/prometheus/cmd/prom-wrapper/README.md index 29266f25a1c..265339d5cb2 100644 --- a/docker-images/prometheus/cmd/prom-wrapper/README.md +++ b/docker-images/prometheus/cmd/prom-wrapper/README.md @@ -1,3 +1,3 @@ # prom-wrapper -Prom-wrapper is a service that ships with the [Sourcegraph Prometheus image](https://docs.sourcegraph.com/dev/background-information/observability/prometheus). +Prom-wrapper is a service that ships with the [Sourcegraph Prometheus image](https://sourcegraph.com/docs/dev/background-information/observability/prometheus). diff --git a/docker-images/prometheus/cmd/prom-wrapper/main.go b/docker-images/prometheus/cmd/prom-wrapper/main.go index 9da882c780d..014bcb728cc 100644 --- a/docker-images/prometheus/cmd/prom-wrapper/main.go +++ b/docker-images/prometheus/cmd/prom-wrapper/main.go @@ -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://docs.sourcegraph.com/dev/background-information/observability/prometheus +// See https://sourcegraph.com/docs/dev/background-information/observability/prometheus package main import ( diff --git a/docker-images/prometheus/cmd/prom-wrapper/receivers.go b/docker-images/prometheus/cmd/prom-wrapper/receivers.go index f7a4d27dd88..90fcf5a0a47 100644 --- a/docker-images/prometheus/cmd/prom-wrapper/receivers.go +++ b/docker-images/prometheus/cmd/prom-wrapper/receivers.go @@ -27,7 +27,7 @@ const ( colorGood = "#00FF00" // green ) -const docsURL = "https://docs.sourcegraph.com" +const docsURL = "https://sourcegraph.com/docs" const alertsDocsPathPath = "admin/observability/alerts" // alertsReferenceURL generates a link to the alerts reference page that embeds the appropriate version diff --git a/go.mod b/go.mod index cc4131394bf..352f029e6cb 100644 --- a/go.mod +++ b/go.mod @@ -8,7 +8,7 @@ go 1.21 // or intentional forks. replace ( // We use a fork of Alertmanager to allow prom-wrapper to better manipulate Alertmanager configuration. - // See https://docs.sourcegraph.com/dev/background-information/observability/prometheus + // See https://sourcegraph.com/docs/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. diff --git a/internal/authz/providers/authz_test.go b/internal/authz/providers/authz_test.go index 3d5cb2cad30..ea8c9afe299 100644 --- a/internal/authz/providers/authz_test.go +++ b/internal/authz/providers/authz_test.go @@ -157,7 +157,7 @@ func TestAuthzProvidersFromConfig(t *testing.T) { }, }, expAuthzAllowAccessByDefault: false, - expSeriousProblems: []string{"Did not find authentication provider matching \"https://gitlab.mine\". Check the [**site configuration**](/site-admin/configuration) to verify an entry in [`auth.providers`](https://docs.sourcegraph.com/admin/auth) exists for https://gitlab.mine."}, + expSeriousProblems: []string{"Did not find authentication provider matching \"https://gitlab.mine\". Check the [**site configuration**](/site-admin/configuration) to verify an entry in [`auth.providers`](https://sourcegraph.com/docs/admin/auth) exists for https://gitlab.mine."}, }, { description: "1 GitLab connection with authz enabled, no GitLab auth provider", @@ -178,7 +178,7 @@ func TestAuthzProvidersFromConfig(t *testing.T) { }, }, expAuthzAllowAccessByDefault: false, - expSeriousProblems: []string{"Did not find authentication provider matching \"https://gitlab.mine\". Check the [**site configuration**](/site-admin/configuration) to verify an entry in [`auth.providers`](https://docs.sourcegraph.com/admin/auth) exists for https://gitlab.mine."}, + expSeriousProblems: []string{"Did not find authentication provider matching \"https://gitlab.mine\". Check the [**site configuration**](/site-admin/configuration) to verify an entry in [`auth.providers`](https://sourcegraph.com/docs/admin/auth) exists for https://gitlab.mine."}, }, { description: "Two GitLab connections with authz enabled, two matching GitLab auth providers", @@ -1806,7 +1806,7 @@ func TestValidateExternalServiceConfig(t *testing.T) { "authorization": { "identityProvider": { "type": "oauth" } } } `, - assert: includes("Did not find authentication provider matching \"https://gitlab.foo.bar\". Check the [**site configuration**](/site-admin/configuration) to verify an entry in [`auth.providers`](https://docs.sourcegraph.com/admin/auth) exists for https://gitlab.foo.bar."), + assert: includes("Did not find authentication provider matching \"https://gitlab.foo.bar\". Check the [**site configuration**](/site-admin/configuration) to verify an entry in [`auth.providers`](https://sourcegraph.com/docs/admin/auth) exists for https://gitlab.foo.bar."), }, { kind: extsvc.KindGitLab, @@ -1820,7 +1820,7 @@ func TestValidateExternalServiceConfig(t *testing.T) { ps: []schema.AuthProviders{ {Gitlab: &schema.GitLabAuthProvider{Url: "https://gitlab.foo.bar"}}, }, - assert: excludes("Did not find authentication provider matching \"https://gitlab.foo.bar\". Check the [**site configuration**](/site-admin/configuration) to verify an entry in [`auth.providers`](https://docs.sourcegraph.com/admin/auth) exists for https://gitlab.foo.bar."), + assert: excludes("Did not find authentication provider matching \"https://gitlab.foo.bar\". Check the [**site configuration**](/site-admin/configuration) to verify an entry in [`auth.providers`](https://sourcegraph.com/docs/admin/auth) exists for https://gitlab.foo.bar."), }, { kind: extsvc.KindGitLab, @@ -1838,7 +1838,7 @@ func TestValidateExternalServiceConfig(t *testing.T) { } } `, - assert: includes("Did not find authentication provider matching type bar and configID foo. Check the [**site configuration**](/site-admin/configuration) to verify that an entry in [`auth.providers`](https://docs.sourcegraph.com/admin/auth) matches the type and configID."), + assert: includes("Did not find authentication provider matching type bar and configID foo. Check the [**site configuration**](/site-admin/configuration) to verify that an entry in [`auth.providers`](https://sourcegraph.com/docs/admin/auth) matches the type and configID."), }, { kind: extsvc.KindGitLab, @@ -1864,7 +1864,7 @@ func TestValidateExternalServiceConfig(t *testing.T) { }, }, }, - assert: excludes("Did not find authentication provider matching type bar and configID foo. Check the [**site configuration**](/site-admin/configuration) to verify that an entry in [`auth.providers`](https://docs.sourcegraph.com/admin/auth) matches the type and configID."), + assert: excludes("Did not find authentication provider matching type bar and configID foo. Check the [**site configuration**](/site-admin/configuration) to verify that an entry in [`auth.providers`](https://sourcegraph.com/docs/admin/auth) matches the type and configID."), }, { kind: extsvc.KindGitLab, @@ -1890,7 +1890,7 @@ func TestValidateExternalServiceConfig(t *testing.T) { }, }, }, - assert: excludes("Did not find authentication provider matching type bar and configID foo. Check the [**site configuration**](/site-admin/configuration) to verify that an entry in [`auth.providers`](https://docs.sourcegraph.com/admin/auth) matches the type and configID."), + assert: excludes("Did not find authentication provider matching type bar and configID foo. Check the [**site configuration**](/site-admin/configuration) to verify that an entry in [`auth.providers`](https://sourcegraph.com/docs/admin/auth) matches the type and configID."), }, { kind: extsvc.KindGitLab, diff --git a/internal/authz/providers/bitbucketserver/provider_test.go b/internal/authz/providers/bitbucketserver/provider_test.go index 48e2a9c368d..5786386578d 100644 --- a/internal/authz/providers/bitbucketserver/provider_test.go +++ b/internal/authz/providers/bitbucketserver/provider_test.go @@ -315,7 +315,7 @@ func marshalJSON(v any) []byte { // need a Bitbucket Server API up and running to run those tests. But if // you want to work on these tests / code, you need to start a new instance // of Bitbucket Server with docker, create an Application Link as per -// https://docs.sourcegraph.com/admin/external_service/bitbucket_server, and +// https://sourcegraph.com/docs/admin/external_service/bitbucket_server, and // then run the tests with -update=true. type fixtures struct { users map[string]*bitbucketserver.User diff --git a/internal/authz/providers/github/authz.go b/internal/authz/providers/github/authz.go index 4944477fd24..8cc9babf0fc 100644 --- a/internal/authz/providers/github/authz.go +++ b/internal/authz/providers/github/authz.go @@ -83,7 +83,7 @@ func NewAuthzProviders( fmt.Sprintf("GitHub config for %[1]s has `authorization.groupsCacheTTL` enabled, but "+ "the authentication provider matching %[1]q does not have `allowGroupsPermissionsSync` enabled. "+ "Update the [**site configuration**](/site-admin/configuration) in the appropriate entry "+ - "in [`auth.providers`](https://docs.sourcegraph.com/admin/auth) to enable this.", + "in [`auth.providers`](https://sourcegraph.com/docs/admin/auth) to enable this.", p.ServiceID())) // Forcibly disable groups cache. p.groupsCache = nil diff --git a/internal/authz/providers/github/github.go b/internal/authz/providers/github/github.go index 75e5ef1453e..ef1189fb26e 100644 --- a/internal/authz/providers/github/github.go +++ b/internal/authz/providers/github/github.go @@ -160,7 +160,7 @@ func (p *Provider) requiredAuthScopes() (requiredAuthScope, bool) { oneOf: []string{"read:org", "write:org", "admin:org"}, message: "Scope `read:org`, `write:org`, or `admin:org` is required to enable `authorization.groupsCacheTTL` - " + "please provide a `token` with the required scopes, or try updating the [**site configuration**](/site-admin/configuration)'s " + - "corresponding entry in [`auth.providers`](https://docs.sourcegraph.com/admin/auth) to enable `allowGroupsPermissionsSync`.", + "corresponding entry in [`auth.providers`](https://sourcegraph.com/docs/admin/auth) to enable `allowGroupsPermissionsSync`.", }, true } diff --git a/internal/authz/providers/gitlab/authz.go b/internal/authz/providers/gitlab/authz.go index 09e0c01680c..9492687e521 100644 --- a/internal/authz/providers/gitlab/authz.go +++ b/internal/authz/providers/gitlab/authz.go @@ -84,7 +84,7 @@ func newAuthzProvider(db database.DB, c *types.GitLabConnection, ps []schema.Aut } } if !foundAuthProvider { - return nil, errors.Errorf("Did not find authentication provider matching %q. Check the [**site configuration**](/site-admin/configuration) to verify an entry in [`auth.providers`](https://docs.sourcegraph.com/admin/auth) exists for %s.", c.Url, c.Url) + return nil, errors.Errorf("Did not find authentication provider matching %q. Check the [**site configuration**](/site-admin/configuration) to verify an entry in [`auth.providers`](https://sourcegraph.com/docs/admin/auth) exists for %s.", c.Url, c.Url) } return NewOAuthProvider(OAuthProviderOp{ @@ -125,7 +125,7 @@ func newAuthzProvider(db database.DB, c *types.GitLabConnection, ps []schema.Aut }), nil } } - return nil, errors.Errorf("Did not find authentication provider matching type %s and configID %s. Check the [**site configuration**](/site-admin/configuration) to verify that an entry in [`auth.providers`](https://docs.sourcegraph.com/admin/auth) matches the type and configID.", ext.AuthProviderType, ext.AuthProviderID) + return nil, errors.Errorf("Did not find authentication provider matching type %s and configID %s. Check the [**site configuration**](/site-admin/configuration) to verify that an entry in [`auth.providers`](https://sourcegraph.com/docs/admin/auth) matches the type and configID.", ext.AuthProviderType, ext.AuthProviderID) default: return nil, errors.Errorf("No identityProvider was specified") } diff --git a/internal/batches/sources/github.go b/internal/batches/sources/github.go index a13308cce3a..19d1e1a5f2a 100644 --- a/internal/batches/sources/github.go +++ b/internal/batches/sources/github.go @@ -207,7 +207,7 @@ func (s GitHubSource) createChangeset(ctx context.Context, c *Changeset, prInput // There is a creation limit (undocumented) in GitHub. When reached, GitHub provides an unclear error // message to users. See https://github.com/cli/cli/issues/4801. if strings.Contains(err.Error(), "was submitted too quickly") { - return exists, errors.Wrap(err, "reached GitHub's internal creation limit: see https://docs.sourcegraph.com/admin/config/batch_changes#avoiding-hitting-rate-limits") + return exists, errors.Wrapf(err, "reached GitHub's internal creation limit: see https://sourcegraph.com/docs/admin/config/batch_changes#avoiding-hitting-rate-limits") } return exists, err } diff --git a/internal/batches/sources/github_test.go b/internal/batches/sources/github_test.go index 9a239e53629..5b1d4d7d794 100644 --- a/internal/batches/sources/github_test.go +++ b/internal/batches/sources/github_test.go @@ -174,7 +174,7 @@ func TestGithubSource_CreateChangeset_CreationLimit(t *testing.T) { assert.Error(t, err) assert.Equal( t, - "reached GitHub's internal creation limit: see https://docs.sourcegraph.com/admin/config/batch_changes#avoiding-hitting-rate-limits: error in GraphQL response: error in GraphQL response: was submitted too quickly", + "reached GitHub's internal creation limit: see https://sourcegraph.com/docs/admin/config/batch_changes#avoiding-hitting-rate-limits: error in GraphQL response: error in GraphQL response: was submitted too quickly", err.Error(), ) } diff --git a/internal/batches/store/changeset_specs.go b/internal/batches/store/changeset_specs.go index bd6431d51f7..e0e91555fa1 100644 --- a/internal/batches/store/changeset_specs.go +++ b/internal/batches/store/changeset_specs.go @@ -110,7 +110,7 @@ func (s *Store) CreateChangesetSpec(ctx context.Context, cs ...*btypes.Changeset // We check if the resulting diff is greater than 1GB, since the limit // for the diff column (which is bytea) is 1GB if len(c.Diff) > oneGigabyte { - link := "https://docs.sourcegraph.com/batch_changes/references/batch_spec_yaml_reference#transformchanges" + link := "https://sourcegraph.com/docs/batch_changes/references/batch_spec_yaml_reference#transformchanges" return errors.Errorf("The changeset patch generated is over the size limit. You can make use of [transformChanges](%s) to break down the changesets into smaller pieces.", link) } diff --git a/internal/cody/feature_flag.go b/internal/cody/feature_flag.go index d2dbd889e7a..9066f925eed 100644 --- a/internal/cody/feature_flag.go +++ b/internal/cody/feature_flag.go @@ -21,7 +21,7 @@ import ( func init() { conf.ContributeWarning(func(c conftypes.SiteConfigQuerier) (problems conf.Problems) { if c.SiteConfig().CodyRestrictUsersFeatureFlag != nil { - problems = append(problems, conf.NewSiteProblem("cody.restrictUsersFeatureFlag has been deprecated. Please remove it from your site config and use cody.permissions instead: https://docs.sourcegraph.com/cody/overview/enable-cody-enterprise#enable-cody-only-for-some-users")) + problems = append(problems, conf.NewSiteProblem("cody.restrictUsersFeatureFlag has been deprecated. Please remove it from your site config and use cody.permissions instead: https://sourcegraph.com/docs/cody/overview/enable-cody-enterprise#enable-cody-only-for-some-users")) } return }) diff --git a/internal/conf/confdefaults/confdefaults.go b/internal/conf/confdefaults/confdefaults.go index c94cd9c2dad..94959f3706c 100644 --- a/internal/conf/confdefaults/confdefaults.go +++ b/internal/conf/confdefaults/confdefaults.go @@ -61,7 +61,7 @@ var KubernetesOrDockerComposeOrPureDocker = conftypes.RawUnified{ // The builtin auth provider with signup disallowed (shown below) means that // after the initial site admin signs in, all other users must be invited. // - // Other providers are documented at https://docs.sourcegraph.com/admin/auth. + // Other providers are documented at https://sourcegraph.com/docs/admin/auth. "auth.providers": [ { "type": "builtin", diff --git a/internal/database/dbtest/dbtest.go b/internal/database/dbtest/dbtest.go index c9b6b95dcc6..ff864675060 100644 --- a/internal/database/dbtest/dbtest.go +++ b/internal/database/dbtest/dbtest.go @@ -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://docs.sourcegraph.com/dev/background-information/bazel/faq#tests-fail-with-connection-refuse`, cfg, err) +See https://sourcegraph.com/docs/dev/background-information/bazel/faq#tests-fail-with-connection-refused`, cfg, err) } t.Fatalf("failed to connect to database %q: %s", cfg, err) } diff --git a/internal/database/event_logs.go b/internal/database/event_logs.go index 6c513d0a36b..3c2bb9681e9 100644 --- a/internal/database/event_logs.go +++ b/internal/database/event_logs.go @@ -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://docs.sourcegraph.com/dev/background-information/telemetry + // Learn more: https://sourcegraph.com/docs/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://docs.sourcegraph.com/dev/background-information/telemetry + // Learn more: https://sourcegraph.com/docs/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. diff --git a/internal/database/migration/cliutil/up.go b/internal/database/migration/cliutil/up.go index 836d49f9fea..3540ad00511 100644 --- a/internal/database/migration/cliutil/up.go +++ b/internal/database/migration/cliutil/up.go @@ -52,7 +52,7 @@ func Up(commandName string, factory RunnerFactory, outFactory OutputFactory, dev } skipUpgradeValidationFlag := &cli.BoolFlag{ Name: "skip-upgrade-validation", - Usage: "Do not attempt to compare the previous instance version with the target instance version for upgrade compatibility. Please refer to https://docs.sourcegraph.com/admin/updates#update-policy for our instance upgrade compatibility policy.", + Usage: "Do not attempt to compare the previous instance version with the target instance version for upgrade compatibility. Please refer to https://sourcegraph.com/docs/admin/updates#update-policy for our instance upgrade compatibility policy.", // NOTE: version 0.0.0+dev (the development version) effectively skips this check as well Value: development, } diff --git a/internal/database/migration/multiversion/drift.go b/internal/database/migration/multiversion/drift.go index 3b0ae8aa02b..3e4dc28e938 100644 --- a/internal/database/migration/multiversion/drift.go +++ b/internal/database/migration/multiversion/drift.go @@ -83,7 +83,7 @@ func CheckDrift(ctx context.Context, r *runner.Runner, version string, out *outp ""+ "Before continuing with this operation, run the migrator's drift command and follow instructions to repair the schema to the expected current state."+ " "+ - "See https://docs.sourcegraph.com/admin/updates/migrator/schema-drift for additional instructions."+ + "See https://sourcegraph.com/docs/admin/updates/migrator/schema-drift for additional instructions."+ "\n", )) diff --git a/internal/database/migration/runner/errors.go b/internal/database/migration/runner/errors.go index e8840ecdf83..79ca3ee4451 100644 --- a/internal/database/migration/runner/errors.go +++ b/internal/database/migration/runner/errors.go @@ -94,7 +94,7 @@ func (e *privilegedMigrationError) Error() string { instructions: strings.Join([]string{ `The migration runner is currently being run with -unprivileged-only.`, `The indicated migration is marked as privileged and cannot be applied by this invocation of the migration runner.`, - `Before re-invoking the migration runner, follow the instructions on https://docs.sourcegraph.com/admin/how-to/privileged_migrations.`, + `Before re-invoking the migration runner, follow the instructions on https://sourcegraph.com/docs/admin/how-to/privileged_migrations.`, `Please contact support@sourcegraph.com for further assistance.`, }, " "), }).Error() diff --git a/internal/goroutine/background.go b/internal/goroutine/background.go index 5b098c26a82..1504ecfe696 100644 --- a/internal/goroutine/background.go +++ b/internal/goroutine/background.go @@ -13,7 +13,7 @@ var GracefulShutdownTimeout = env.MustGetDuration("SRC_GRACEFUL_SHUTDOWN_TIMEOUT // running process with a graceful shutdown mechanism. // // See -// https://docs.sourcegraph.com/dev/background-information/backgroundroutine +// https://sourcegraph.com/docs/dev/background-information/backgroundroutine // for more information and a step-by-step guide on how to implement a // BackgroundRoutine. type BackgroundRoutine = background.Routine diff --git a/internal/goroutine/periodic.go b/internal/goroutine/periodic.go index b65ad829bf4..679f78b6117 100644 --- a/internal/goroutine/periodic.go +++ b/internal/goroutine/periodic.go @@ -22,7 +22,7 @@ type getConcurrencyFunc func() int // PeriodicGoroutine represents a goroutine whose main behavior is reinvoked periodically. // // See -// https://docs.sourcegraph.com/dev/background-information/backgroundroutine +// https://sourcegraph.com/docs/dev/background-information/backgroundroutine // for more information and a step-by-step guide on how to implement a // PeriodicBackgroundRoutine. type PeriodicGoroutine struct { diff --git a/internal/gqltestutil/client.go b/internal/gqltestutil/client.go index 40376b079e7..5c5785fc371 100644 --- a/internal/gqltestutil/client.go +++ b/internal/gqltestutil/client.go @@ -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://docs.sourcegraph.com/dev/security/csrf_security_model#authentication-in-api-endpoints + // https://sourcegraph.com/docs/dev/security/csrf_security_model#authentication-in-api-endpoints req.Header.Set("X-Requested-With", "Sourcegraph") req.AddCookie(c.sessionCookie) diff --git a/internal/gqltestutil/compute.go b/internal/gqltestutil/compute.go index 3e016038fd2..fca38ccc2d4 100644 --- a/internal/gqltestutil/compute.go +++ b/internal/gqltestutil/compute.go @@ -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://docs.sourcegraph.com/dev/security/csrf_security_model#authentication-in-api-endpoints + // https://sourcegraph.com/docs/dev/security/csrf_security_model#authentication-in-api-endpoints req.Header.Set("X-Requested-With", "Sourcegraph") s.Client.addCookies(req) diff --git a/internal/gqltestutil/search.go b/internal/gqltestutil/search.go index 9463e6e66bd..6d8813bfa46 100644 --- a/internal/gqltestutil/search.go +++ b/internal/gqltestutil/search.go @@ -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://docs.sourcegraph.com/dev/security/csrf_security_model#authentication-in-api-endpoints + // https://sourcegraph.com/docs/dev/security/csrf_security_model#authentication-in-api-endpoints req.Header.Set("X-Requested-With", "Sourcegraph") s.Client.addCookies(req) diff --git a/internal/logging/main.go b/internal/logging/main.go index 8ad73691ebd..fdab64daba6 100644 --- a/internal/logging/main.go +++ b/internal/logging/main.go @@ -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://docs.sourcegraph.com/dev/how-to/add_logging +// Deprecated: All logging should use github.com/sourcegraph/log instead. See https://sourcegraph.com/docs/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://docs.sourcegraph.com/dev/how-to/add_logging +// Deprecated: All logging should use github.com/sourcegraph/log instead. See https://sourcegraph.com/docs/dev/how-to/add_logging type Option func(*Options) -// Deprecated: All logging should use github.com/sourcegraph/log instead. See https://docs.sourcegraph.com/dev/how-to/add_logging +// Deprecated: All logging should use github.com/sourcegraph/log instead. See https://sourcegraph.com/docs/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://docs.sourcegraph.com/dev/how-to/add_logging +// Deprecated: All logging should use github.com/sourcegraph/log instead. See https://sourcegraph.com/docs/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://docs.sourcegraph.com/dev/how-to/add_logging +// Deprecated: All logging should use github.com/sourcegraph/log instead. See https://sourcegraph.com/docs/dev/how-to/add_logging func LogEntryLevelString(l log15.Lvl) string { switch l { case log15.LvlDebug: @@ -113,9 +113,9 @@ func LogEntryLevelString(l log15.Lvl) string { } // Init initializes log15's root logger based on Sourcegraph-wide logging configuration -// variables. See https://docs.sourcegraph.com/admin/observability#logs +// variables. See https://sourcegraph.com/docs/admin/observability/logs // -// Deprecated: All logging should use github.com/sourcegraph/log instead. See https://docs.sourcegraph.com/dev/how-to/add_logging +// Deprecated: All logging should use github.com/sourcegraph/log instead. See https://sourcegraph.com/docs/dev/how-to/add_logging func Init(options ...Option) { opts := &Options{} for _, setter := range options { diff --git a/internal/observation/observation.go b/internal/observation/observation.go index 89156a3709d..19b3b4eaeb9 100644 --- a/internal/observation/observation.go +++ b/internal/observation/observation.go @@ -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://docs.sourcegraph.com/dev/how-to/add_observability +// To learn more, refer to "How to add observability": https://sourcegraph.com/docs/dev/how-to/add_observability package observation import ( diff --git a/internal/opencodegraph/docs_provider.go b/internal/opencodegraph/docs_provider.go index aff2f0b2c7e..dcb418c0704 100644 --- a/internal/opencodegraph/docs_provider.go +++ b/internal/opencodegraph/docs_provider.go @@ -86,19 +86,19 @@ var docsPatterns = []struct { PathPattern: regexp.MustCompile(`\.tsx?$`), ContentPattern: regexp.MustCompile(`eventLogger.log(?:ViewEvent)?`), Title: "Telemetry", - URL: "https://docs.sourcegraph.com/dev/background-information/telemetry#sourcegraph-web-app", + URL: "https://sourcegraph.com/docs/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://docs.sourcegraph.com/dev/background-information/web/styling", + URL: "https://sourcegraph.com/docs/dev/background-information/web/styling", }, { Id: "bazel", PathPattern: regexp.MustCompile(`(^|/)BUILD\.bazel$`), Title: "Bazel at Sourcegraph", - URL: "https://docs.sourcegraph.com/dev/background-information/bazel", + URL: "https://sourcegraph.com/docs/dev/background-information/bazel", }, } diff --git a/internal/rockskip/search.go b/internal/rockskip/search.go index ae74126a425..2a13f63613b 100644 --- a/internal/rockskip/search.go +++ b/internal/rockskip/search.go @@ -43,10 +43,10 @@ func (s *Service) Search(ctx context.Context, args search.SymbolsParameters) (_ return } - err = errors.Newf("Processing symbols is taking a while, try again later ([more details](https://docs.sourcegraph.com/code_navigation/explanations/rockskip)).") + err = errors.Newf("Processing symbols is taking a while, try again later ([more details](https://sourcegraph.com/docs/code_navigation/explanations/rockskip)).") for _, status := range s.status.threadIdToThreadStatus { if strings.HasPrefix(status.Name, fmt.Sprintf("indexing %s", args.Repo)) { - err = errors.Newf("Still processing symbols ([more details](https://docs.sourcegraph.com/code_navigation/explanations/rockskip)). Estimated completion: %s.", status.Remaining()) + err = errors.Newf("Still processing symbols ([more details](https://sourcegraph.com/docs/code_navigation/explanations/rockskip)). Estimated completion: %s.", status.Remaining()) } } }() diff --git a/internal/rockskip/status.go b/internal/rockskip/status.go index 43617709f14..8b3e7848d7d 100644 --- a/internal/rockskip/status.go +++ b/internal/rockskip/status.go @@ -107,7 +107,7 @@ func (s *Service) HandleStatus(w http.ResponseWriter, r *http.Request) { fmt.Fprintln(w, "⚠️ None of the enabled repositories have been indexed yet!") fmt.Fprintln(w, "⚠️ Open the symbols sidebar on a repository with Rockskip enabled to trigger indexing.") fmt.Fprintln(w, "⚠️ Check the logs for errors if requests fail or if there are no in-flight requests below.") - fmt.Fprintln(w, "⚠️ Docs: https://docs.sourcegraph.com/code_navigation/explanations/rockskip") + fmt.Fprintln(w, "⚠️ Docs: https://sourcegraph.com/docs/code_navigation/explanations/rockskip") fmt.Fprintln(w, "") } } else if os.Getenv("ROCKSKIP_MIN_REPO_SIZE_MB") != "" { diff --git a/internal/scim/init.go b/internal/scim/init.go index c40bd026f40..1e2a21e5ff1 100644 --- a/internal/scim/init.go +++ b/internal/scim/init.go @@ -35,7 +35,7 @@ func getConfiguredIdentityProvider() IdentityProvider { // NewHandler creates and returns a new SCIM 2.0 handler. func NewHandler(ctx context.Context, db database.DB, observationCtx *observation.Context) http.Handler { config := scim.ServiceProviderConfig{ - DocumentationURI: optional.NewString("docs.sourcegraph.com/admin/scim"), + DocumentationURI: optional.NewString("sourcegraph.com/docs/admin/scim"), MaxResults: 100, SupportFiltering: true, SupportPatch: true, @@ -45,7 +45,7 @@ func NewHandler(ctx context.Context, db database.DB, observationCtx *observation Name: "OAuth Bearer Token", Description: "Authentication scheme using the Bearer Token standard – use the key 'scim.authToken' in the site config to set the token.", SpecURI: optional.NewString("https://tools.ietf.org/html/rfc6750"), - DocumentationURI: optional.NewString("docs.sourcegraph.com/admin/scim"), + DocumentationURI: optional.NewString("sourcegraph.com/docs/admin/scim"), Primary: true, }, }, diff --git a/internal/search/alert.go b/internal/search/alert.go index 02fd3493d8d..1ae3017a334 100644 --- a/internal/search/alert.go +++ b/internal/search/alert.go @@ -162,7 +162,7 @@ func AlertForInvalidRevision(revision string) *Alert { revision = strings.TrimSuffix(revision, "^0") return &Alert{ Title: "Invalid revision syntax", - Description: fmt.Sprintf("We don't know how to interpret the revision (%s) you specified. Learn more about the revision syntax in our documentation: https://docs.sourcegraph.com/code_search/reference/queries#repository-revisions.", revision), + Description: fmt.Sprintf("We don't know how to interpret the revision (%s) you specified. Learn more about the revision syntax in our documentation: https://sourcegraph.com/docs/code-search/queries#repository-revisions.", revision), } } @@ -170,7 +170,7 @@ func AlertForUnownedResult() *Alert { return &Alert{ Kind: "unowned-results", Title: "Some results have no owners", - Description: "For some results, no ownership data was found, or no rule applied to the result. [Learn more about configuring code ownership](https://docs.sourcegraph.com/own).", + Description: "For some results, no ownership data was found, or no rule applied to the result. [Learn more about configuring code ownership](https://sourcegraph.com/docs/own).", // Explicitly set a low priority, so other alerts take precedence. Priority: 0, } diff --git a/internal/search/job/jobutil/log_job.go b/internal/search/job/jobutil/log_job.go index 9ed75187b19..12af23f71dd 100644 --- a/internal/search/job/jobutil/log_job.go +++ b/internal/search/job/jobutil/log_job.go @@ -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://docs.sourcegraph.com/dev/background-information/telemetry + // New events that get exported: https://sourcegraph.com/docs/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) diff --git a/internal/search/job/jobutil/log_job_test.go b/internal/search/job/jobutil/log_job_test.go index d822b6d09ba..4da42115c3d 100644 --- a/internal/search/job/jobutil/log_job_test.go +++ b/internal/search/job/jobutil/log_job_test.go @@ -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://docs.sourcegraph.com/dev/background-information/telemetry + new []string // https://sourcegraph.com/docs/dev/background-information/telemetry } for literal, wantEventNames := range map[string]wantEvents{ "file:has.owner(one@example.com)": { diff --git a/internal/search/query/validate.go b/internal/search/query/validate.go index 5cda523abca..a290970ca5e 100644 --- a/internal/search/query/validate.go +++ b/internal/search/query/validate.go @@ -340,7 +340,7 @@ func validateRepoRevPair(nodes []Node) error { } // Queries containing commit parameters without type:diff or type:commit are not -// valid. cf. https://docs.sourcegraph.com/code_search/reference/language#commit-parameter +// valid. cf. https://sourcegraph.com/docs/code_search/reference/language#commit-parameter func validateCommitParameters(nodes []Node) error { var seenCommitParam string var typeCommitExists bool diff --git a/internal/src-prometheus/prometheus.go b/internal/src-prometheus/prometheus.go index 5ac6e8890d6..cc5abe7df77 100644 --- a/internal/src-prometheus/prometheus.go +++ b/internal/src-prometheus/prometheus.go @@ -1,5 +1,5 @@ // Package srcprometheus defines an API to interact with Sourcegraph Prometheus, including -// prom-wrapper. See https://docs.sourcegraph.com/dev/background-information/observability/prometheus +// prom-wrapper. See https://sourcegraph.com/docs/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://docs.sourcegraph.com/dev/background-information/observability/prometheus +// prom-wrapper. See https://sourcegraph.com/docs/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://docs.sourcegraph.com/dev/background-information/observability/prometheus +// See https://sourcegraph.com/docs/dev/background-information/observability/prometheus func NewClient(prometheusURL string) (Client, error) { if prometheusURL == "" { return nil, ErrPrometheusUnavailable diff --git a/internal/usagestats/batches_test.go b/internal/usagestats/batches_test.go index 2a90489310b..8d5c3d9f6e3 100644 --- a/internal/usagestats/batches_test.go +++ b/internal/usagestats/batches_test.go @@ -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://docs.sourcegraph.com/dev/background-information/languages/testing_go_code#testing-time + // https://sourcegraph.com/docs/dev/background-information/languages/testing_go_code#testing-time clock := glock.NewMockClock() now := clock.Now() diff --git a/internal/usagestats/event_handlers.go b/internal/usagestats/event_handlers.go index 0362e92735e..e343c978b0e 100644 --- a/internal/usagestats/event_handlers.go +++ b/internal/usagestats/event_handlers.go @@ -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://docs.sourcegraph.com/dev/background-information/telemetry +// Learn more: https://sourcegraph.com/docs/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://docs.sourcegraph.com/dev/background-information/telemetry +// Learn more: https://sourcegraph.com/docs/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://docs.sourcegraph.com/dev/background-information/telemetry +// Learn more: https://sourcegraph.com/docs/dev/background-information/telemetry func LogEvents(ctx context.Context, db database.DB, events []Event) error { if !conf.EventLoggingEnabled() { return nil diff --git a/internal/version/upgradestore/errors.go b/internal/version/upgradestore/errors.go index 2dee50dbd3b..d60e092eb1d 100644 --- a/internal/version/upgradestore/errors.go +++ b/internal/version/upgradestore/errors.go @@ -21,6 +21,6 @@ func (e UpgradeError) Error() string { e.Service, e.Previous, e.Latest, - "https://docs.sourcegraph.com/admin/updates#update-policy", + "https://sourcegraph.com/docs/admin/updates#update-policy", ) } diff --git a/internal/version/upgradestore/store.go b/internal/version/upgradestore/store.go index e20588ca26d..febd4e7b399 100644 --- a/internal/version/upgradestore/store.go +++ b/internal/version/upgradestore/store.go @@ -66,14 +66,14 @@ SELECT version FROM versions WHERE service = %s ` // ValidateUpgrade enforces our documented upgrade policy and will return an error (performing no side-effects) -// if the upgrade is between two unsupported versions. See https://docs.sourcegraph.com/#upgrading-sourcegraph. +// if the upgrade is between two unsupported versions. See https://sourcegraph.com/docs/admin/updates. func (s *store) ValidateUpgrade(ctx context.Context, service, version string) error { return s.updateServiceVersion(ctx, service, version, false) } // UpdateServiceVersion updates the latest version for the given Sourcegraph service. This method also enforces // our documented upgrade policy and will return an error (performing no side-effects) if the upgrade is between -// two unsupported versions. See https://docs.sourcegraph.com/#upgrading-sourcegraph. +// two unsupported versions. See https://sourcegraph.com/docs/admin/updates. func (s *store) UpdateServiceVersion(ctx context.Context, version string) error { return s.updateServiceVersion(ctx, "frontend", version, true) } @@ -122,7 +122,7 @@ WHERE versions.version = %s // SetServiceVersion updates the latest version for the given Sourcegraph service. This method also enforces // our documented upgrade policy and will return an error (performing no side-effects) if the upgrade is between -// two unsupported versions. See https://docs.sourcegraph.com/#upgrading-sourcegraph. +// two unsupported versions. See https://sourcegraph.com/docs/admin/updates. func (s *store) SetServiceVersion(ctx context.Context, version string) error { return s.db.Exec(ctx, sqlf.Sprintf(setServiceVersionQuery, version, time.Now().UTC(), "frontend")) } diff --git a/internal/version/upgradestore/upgrade.go b/internal/version/upgradestore/upgrade.go index 6405439cb2c..4e42cecc28f 100644 --- a/internal/version/upgradestore/upgrade.go +++ b/internal/version/upgradestore/upgrade.go @@ -7,7 +7,7 @@ import ( // IsValidUpgrade returns true if the given previous and latest versions comply with our // documented upgrade policy. All roll-backs or downgrades are supported. // -// See https://docs.sourcegraph.com/#upgrading-sourcegraph. +// See https://sourcegraph.com/docs/admin/updates func IsValidUpgrade(previous, latest *semver.Version) bool { switch { case previous == nil || latest == nil: diff --git a/migrations/README.md b/migrations/README.md index 4326e4fdebe..c2421f53ed7 100644 --- a/migrations/README.md +++ b/migrations/README.md @@ -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://docs.sourcegraph.com/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://sourcegraph.com/docs/dev/background-information/sql/migrations) in our developer documentation for additional context. To create a new migration file, run the following command. diff --git a/monitoring/README.md b/monitoring/README.md index 373a187a5d3..2d7dbbfe21e 100644 --- a/monitoring/README.md +++ b/monitoring/README.md @@ -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://docs.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.sourcegraph.com/dev/background-information/observability). +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). ## Usage @@ -12,7 +12,7 @@ From this directory: go generate ./... ``` -Logging output supports the [Sourcegraph log level flags](https://docs.sourcegraph.com/admin/observability#logs). +Logging output supports the [Sourcegraph log level flags](https://sourcegraph.com/docs/admin/observability/logs). Other configuration options can be customized via flags declared in [`main.go`](./main.go). ## Development @@ -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://docs.sourcegraph.com/dev/background-information/observability). + 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). - _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://docs.sourcegraph.com/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://sourcegraph.com/docs/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). diff --git a/monitoring/definitions/frontend.go b/monitoring/definitions/frontend.go index 4c44de8dfa3..c8cc2b7a3f4 100644 --- a/monitoring/definitions/frontend.go +++ b/monitoring/definitions/frontend.go @@ -159,7 +159,7 @@ func Frontend() *monitoring.Dashboard { NextSteps: ` - Confirm that the Sourcegraph frontend has enough CPU/memory using the provisioning panels. - Investigate potential sources of latency by selecting Explore and modifying the 'sum by(le)' section to include additional labels: for example, 'sum by(le, job)' or 'sum by (le, instance)'. - - Trace a request to see what the slowest part is: https://docs.sourcegraph.com/admin/observability/tracing + - Trace a request to see what the slowest part is: https://sourcegraph.com/docs/admin/observability/tracing `, }, }, @@ -1058,7 +1058,7 @@ func Frontend() *monitoring.Dashboard { Increases in response time can point to too much load on the database to keep up with the incoming requests. - See this documentation page for more details on webhook requests: (https://docs.sourcegraph.com/admin/config/webhooks/incoming)`, + See this documentation page for more details on webhook requests: (https://sourcegraph.com/docs/admin/config/webhooks/incoming)`, }, }, }, diff --git a/monitoring/definitions/postgres.go b/monitoring/definitions/postgres.go index 52690bf6628..50a0fa79428 100644 --- a/monitoring/definitions/postgres.go +++ b/monitoring/definitions/postgres.go @@ -46,7 +46,7 @@ func Postgres() *monitoring.Dashboard { Warning: monitoring.Alert().GreaterOrEqual(80).For(5 * time.Minute), Critical: monitoring.Alert().GreaterOrEqual(100).For(5 * time.Minute), NextSteps: ` - - Consider increasing [max_connections](https://www.postgresql.org/docs/current/runtime-config-connection.html#GUC-MAX-CONNECTIONS) of the database instance, [learn more](https://docs.sourcegraph.com/admin/config/postgres-conf) + - Consider increasing [max_connections](https://www.postgresql.org/docs/current/runtime-config-connection.html#GUC-MAX-CONNECTIONS) of the database instance, [learn more](https://sourcegraph.com/docs/admin/config/postgres-conf) `, }, monitoring.Observable{ diff --git a/monitoring/definitions/prometheus.go b/monitoring/definitions/prometheus.go index 94d0cc92066..1462c796cb1 100644 --- a/monitoring/definitions/prometheus.go +++ b/monitoring/definitions/prometheus.go @@ -12,7 +12,7 @@ func Prometheus() *monitoring.Dashboard { containerName = "prometheus" // ruleGroupInterpretation provides interpretation documentation for observables that are per prometheus rule_group. - ruleGroupInterpretation = `Rules that Sourcegraph ships with are grouped under '/sg_config_prometheus'. [Custom rules are grouped under '/sg_prometheus_addons'](https://docs.sourcegraph.com/admin/observability/metrics#prometheus-configuration).` + ruleGroupInterpretation = `Rules that Sourcegraph ships with are grouped under '/sg_config_prometheus'. [Custom rules are grouped under '/sg_prometheus_addons'](https://sourcegraph.com/docs/admin/observability/metrics#prometheus-configuration).` ) return &monitoring.Dashboard{ @@ -94,7 +94,7 @@ func Prometheus() *monitoring.Dashboard { Owner: monitoring.ObservableOwnerInfraOrg, NextSteps: fmt.Sprintf(` - Check the %s panels and try increasing resources for Prometheus if necessary. - - Ensure that your ['observability.alerts' configuration](https://docs.sourcegraph.com/admin/observability/alerting#setting-up-alerting) (in site configuration) is valid. + - Ensure that your ['observability.alerts' configuration](https://sourcegraph.com/docs/admin/observability/alerting#setting-up-alerting) (in site configuration) is valid. - Check if the relevant alert integration service is experiencing downtime or issues. `, shared.TitleContainerMonitoring), }, @@ -106,7 +106,7 @@ func Prometheus() *monitoring.Dashboard { Panel: monitoring.Panel().LegendFormat("{{integration}}"), Owner: monitoring.ObservableOwnerInfraOrg, NextSteps: ` - - Ensure that your ['observability.alerts' configuration](https://docs.sourcegraph.com/admin/observability/alerting#setting-up-alerting) (in site configuration) is valid. + - Ensure that your ['observability.alerts' configuration](https://sourcegraph.com/docs/admin/observability/alerting#setting-up-alerting) (in site configuration) is valid. - Check if the relevant alert integration service is experiencing downtime or issues. `, }, @@ -128,7 +128,7 @@ func Prometheus() *monitoring.Dashboard { Interpretation: "A '1' indicates Prometheus reloaded its configuration successfully.", NextSteps: ` - Check Prometheus logs for messages related to configuration loading. - - Ensure any [custom configuration you have provided Prometheus](https://docs.sourcegraph.com/admin/observability/metrics#prometheus-configuration) is valid. + - Ensure any [custom configuration you have provided Prometheus](https://sourcegraph.com/docs/admin/observability/metrics#prometheus-configuration) is valid. `, }, { @@ -139,7 +139,7 @@ func Prometheus() *monitoring.Dashboard { Panel: monitoring.Panel().LegendFormat("reload success").Max(1), Owner: monitoring.ObservableOwnerInfraOrg, Interpretation: "A '1' indicates Alertmanager reloaded its configuration successfully.", - NextSteps: "Ensure that your [`observability.alerts` configuration](https://docs.sourcegraph.com/admin/observability/alerting#setting-up-alerting) (in site configuration) is valid.", + NextSteps: "Ensure that your [`observability.alerts` configuration](https://sourcegraph.com/docs/admin/observability/alerting#setting-up-alerting) (in site configuration) is valid.", }, }, { diff --git a/monitoring/definitions/shared/dbconns.go b/monitoring/definitions/shared/dbconns.go index a8b15e2ca38..92d534a27ca 100644 --- a/monitoring/definitions/shared/dbconns.go +++ b/monitoring/definitions/shared/dbconns.go @@ -68,7 +68,7 @@ func DatabaseConnectionsMonitoring(app string, owner monitoring.ObservableOwner) Owner: owner, NextSteps: ` - Increase SRC_PGSQL_MAX_OPEN together with giving more memory to the database if needed - - Scale up Postgres memory/cpus - [see our scaling guide](https://docs.sourcegraph.com/admin/config/postgres-conf) + - Scale up Postgres memory/cpus - [see our scaling guide](https://sourcegraph.com/docs/admin/config/postgres-conf) - If using GCP Cloud SQL, check for high lock waits or CPU usage in query insights `, }, diff --git a/monitoring/definitions/telemetry.go b/monitoring/definitions/telemetry.go index b095d7fca6d..62ed4305106 100644 --- a/monitoring/definitions/telemetry.go +++ b/monitoring/definitions/telemetry.go @@ -18,7 +18,7 @@ func Telemetry() *monitoring.Dashboard { Title: "Telemetry", Description: "Monitoring telemetry services in Sourcegraph.", Groups: []monitoring.Group{ - // The new stuff - https://docs.sourcegraph.com/dev/background-information/telemetry + // The new stuff - https://sourcegraph.com/docs/dev/background-information/telemetry { Title: "Telemetry Gateway Exporter: Export and queue metrics", Rows: []monitoring.Row{ diff --git a/monitoring/definitions/worker.go b/monitoring/definitions/worker.go index df9d4c6073d..b2afdf2995a 100644 --- a/monitoring/definitions/worker.go +++ b/monitoring/definitions/worker.go @@ -412,7 +412,7 @@ func repoPermsSyncerGroup(owner monitoring.ObservableOwner) monitoring.Group { Owner: owner, NextSteps: ` - **Enabled permissions for the first time:** Wait for few minutes and see if the number goes down. - - **Otherwise:** Increase the API rate limit to [GitHub](https://docs.sourcegraph.com/admin/external_service/github#github-com-rate-limits), [GitLab](https://docs.sourcegraph.com/admin/external_service/gitlab#internal-rate-limits) or [Bitbucket Server](https://docs.sourcegraph.com/admin/external_service/bitbucket_server#internal-rate-limits). + - **Otherwise:** Increase the API rate limit to [GitHub](https://sourcegraph.com/docs/admin/external_service/github#github-com-rate-limits), [GitLab](https://sourcegraph.com/docs/admin/external_service/gitlab#internal-rate-limits) or [Bitbucket Server](https://sourcegraph.com/docs/admin/external_service/bitbucket_server#internal-rate-limits). `, }, }, @@ -449,7 +449,7 @@ func repoPermsSyncerGroup(owner monitoring.ObservableOwner) monitoring.Group { Owner: owner, Interpretation: ` Indicates how many repositories have been scheduled for a permissions sync. - More about repository permissions synchronization [here](https://docs.sourcegraph.com/admin/permissions/syncing#scheduling) + More about repository permissions synchronization [here](https://sourcegraph.com/docs/admin/permissions/syncing#scheduling) `, }, }, diff --git a/monitoring/definitions/zoekt.go b/monitoring/definitions/zoekt.go index e225669e86f..c3466902ce7 100644 --- a/monitoring/definitions/zoekt.go +++ b/monitoring/definitions/zoekt.go @@ -846,7 +846,7 @@ func Zoekt() *monitoring.Dashboard { - Enabling shard merging for Zoekt: Set SRC_ENABLE_SHARD_MERGING="1" for zoekt-indexserver. Use this option if your corpus of repositories has a high percentage of small, rarely updated repositories. See - [documentation](https://docs.sourcegraph.com/code_search/explanations/search_details#shard-merging). + [documentation](https://sourcegraph.com/docs/code-search/features#shard-merging). - Creating additional Zoekt replicas: This spreads all the shards out amongst more replicas, which means that each _individual_ replica will have fewer shards. This, in turn, decreases the amount of memory map areas that a _single_ replica can create (in order to load the shards into memory). diff --git a/monitoring/monitoring/README.md b/monitoring/monitoring/README.md index eb2f26e78f0..683ca836294 100755 --- a/monitoring/monitoring/README.md +++ b/monitoring/monitoring/README.md @@ -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://docs.sourcegraph.com/dev/background-information/observability). +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 the Sourcegraph monitoring generator, refer to [the monitoring generator overview](https://docs.sourcegraph.com/dev/background-information/observability/monitoring-generator). +To learn more about the Sourcegraph monitoring generator, refer to [the monitoring generator overview](https://sourcegraph.com/docs/dev/background-information/observability/monitoring-generator). diff --git a/monitoring/monitoring/doc.go b/monitoring/monitoring/doc.go index 2c4389560e3..6c159bbe5ef 100644 --- a/monitoring/monitoring/doc.go +++ b/monitoring/monitoring/doc.go @@ -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://docs.sourcegraph.com/dev/background-information/observability. +To learn more about developing monitoring for Sourcegraph, refer to https://sourcegraph.com/docs/dev/background-information/observability. -To learn more about the Sourcegraph monitoring generator, refer to https://docs.sourcegraph.com/dev/background-information/observability/monitoring-generator. +To learn more about the Sourcegraph monitoring generator, refer to https://sourcegraph.com/docs/dev/background-information/observability/monitoring-generator. */ package monitoring diff --git a/monitoring/monitoring/documentation.go b/monitoring/monitoring/documentation.go index b8af9fba6e4..9b6315d5402 100644 --- a/monitoring/monitoring/documentation.go +++ b/monitoring/monitoring/documentation.go @@ -36,7 +36,7 @@ const dashboardsHeader = `# Dashboards reference This document contains a complete reference on Sourcegraph's available dashboards, as well as details on how to interpret the panels and metrics. -To learn more about Sourcegraph's metrics and how to view these dashboards, see [our metrics guide](https://docs.sourcegraph.com/admin/observability/metrics). +To learn more about Sourcegraph's metrics and how to view these dashboards, see [our metrics guide](https://sourcegraph.com/docs/admin/observability/metrics). ` diff --git a/monitoring/monitoring/monitoring.go b/monitoring/monitoring/monitoring.go index 4b13b78bc64..8d4dc51ae41 100644 --- a/monitoring/monitoring/monitoring.go +++ b/monitoring/monitoring/monitoring.go @@ -185,7 +185,7 @@ func (c *Dashboard) renderDashboard(injectLabelMatchers []*labels.Matcher, folde description.TextPanel.Content = fmt.Sprintf(`
    -
    %s: %s (⧉ architecture diagram) + `, c.Name, c.Description) board.Panels = append(board.Panels, description) @@ -337,7 +337,7 @@ func (c *Dashboard) alertDescription(o Observable, alert *ObservableAlertDefinit // high-level alerting metrics for the container. For more information about // how these work, see: // -// https://docs.sourcegraph.com/admin/observability/metrics#high-level-alerting-metrics +// https://sourcegraph.com/docs/admin/observability/metrics#high-level-alerting-metrics func (c *Dashboard) RenderPrometheusRules(injectLabelMatchers []*labels.Matcher) (*PrometheusRules, error) { group := newPrometheusRuleGroup(c.Name) for groupIndex, g := range c.Groups { @@ -503,14 +503,14 @@ type Observable struct { // suggest checking in on these periodically, or using a notification channel that // will not bother anyone if it is spammed. // - // Learn more about how alerting is used: https://docs.sourcegraph.com/admin/observability/alerting + // Learn more about how alerting is used: https://sourcegraph.com/docs/admin/observability/alerting Warning *ObservableAlertDefinition // Critical alerts indicate that something is definitively wrong with Sourcegraph, // in a way that is very likely to be noticeable to users. We suggest using a // high-visibility notification channel, such as paging, for these alerts. // - // Learn more about how alerting is used: https://docs.sourcegraph.com/admin/observability/alerting + // Learn more about how alerting is used: https://sourcegraph.com/docs/admin/observability/alerting Critical *ObservableAlertDefinition // NoAlerts must be set by Observables that do not have any alerts. This ensures the diff --git a/schema/azuredevops.schema.json b/schema/azuredevops.schema.json index 602650b01b0..0dd6a85a61d 100644 --- a/schema/azuredevops.schema.json +++ b/schema/azuredevops.schema.json @@ -42,7 +42,7 @@ } }, "gitURLType": { - "description": "The type of Git URLs to use for cloning and fetching Git repositories.\n\nIf \"http\", Sourcegraph will access repositories using Git URLs of the form http(s)://dev.azure.com/myrepo.git.\n\nIf \"ssh\", Sourcegraph will access repositories using Git URLs of the form git@ssh.dev.azure.com:v3/myrepo. See the documentation for how to provide SSH private keys and known_hosts: https://docs.sourcegraph.com/admin/repo/auth#repositories-that-need-http-s-or-ssh-authentication.", + "description": "The type of Git URLs to use for cloning and fetching Git repositories.\n\nIf \"http\", Sourcegraph will access repositories using Git URLs of the form http(s)://dev.azure.com/myrepo.git.\n\nIf \"ssh\", Sourcegraph will access repositories using Git URLs of the form git@ssh.dev.azure.com:v3/myrepo. See the documentation for how to provide SSH private keys and known_hosts: https://sourcegraph.com/docs/admin/repo/auth.", "type": "string", "enum": ["http", "ssh"], "default": "http" diff --git a/schema/bitbucket_cloud.schema.json b/schema/bitbucket_cloud.schema.json index 3e06ed6ad14..42ea27c5000 100644 --- a/schema/bitbucket_cloud.schema.json +++ b/schema/bitbucket_cloud.schema.json @@ -74,7 +74,7 @@ }, "authorization": { "title": "BitbucketCloudAuthorization", - "description": "If non-null, enforces Bitbucket Cloud repository permissions. This requires that there is an item in the [site configuration json](https://docs.sourcegraph.com/admin/config/site_config#auth-providers) `auth.providers` field, of type \"bitbucketcloud\" with the same `url` field as specified in this `BitbucketCloudConnection`.", + "description": "If non-null, enforces Bitbucket Cloud repository permissions. This requires that there is an item in the [site configuration json](https://sourcegraph.com/docs/admin/config/site_config#auth-providers) `auth.providers` field, of type \"bitbucketcloud\" with the same `url` field as specified in this `BitbucketCloudConnection`.", "type": "object", "properties": { "identityProvider": { @@ -96,7 +96,7 @@ "type": "string" }, "gitURLType": { - "description": "The type of Git URLs to use for cloning and fetching Git repositories on this Bitbucket Cloud.\n\nIf \"http\", Sourcegraph will access Bitbucket Cloud repositories using Git URLs of the form https://bitbucket.org/myteam/myproject.git.\n\nIf \"ssh\", Sourcegraph will access Bitbucket Cloud repositories using Git URLs of the form git@bitbucket.org:myteam/myproject.git. See the documentation for how to provide SSH private keys and known_hosts: https://docs.sourcegraph.com/admin/repo/auth#repositories-that-need-http-s-or-ssh-authentication.", + "description": "The type of Git URLs to use for cloning and fetching Git repositories on this Bitbucket Cloud.\n\nIf \"http\", Sourcegraph will access Bitbucket Cloud repositories using Git URLs of the form https://bitbucket.org/myteam/myproject.git.\n\nIf \"ssh\", Sourcegraph will access Bitbucket Cloud repositories using Git URLs of the form git@bitbucket.org:myteam/myproject.git. See the documentation for how to provide SSH private keys and known_hosts: https://sourcegraph.com/docs/admin/repo/auth#repositories-that-need-http-s-or-ssh-authentication.", "type": "string", "enum": ["http", "ssh"], "default": "http", @@ -146,7 +146,7 @@ }, "webhookSecret": { "description": "A shared secret used to authenticate incoming webhooks (minimum 12 characters).", - "deprecationMessage": "Deprecated in favour of first class webhooks. See https://docs.sourcegraph.com/admin/config/webhooks/incoming#deprecation-notice", + "deprecationMessage": "Deprecated in favour of first class webhooks. See https://sourcegraph.com/docs/admin/config/webhooks/incoming#deprecation-notice", "type": "string", "minLength": 12 } diff --git a/schema/bitbucket_server.schema.json b/schema/bitbucket_server.schema.json index 3448b319652..20ee157ca60 100644 --- a/schema/bitbucket_server.schema.json +++ b/schema/bitbucket_server.schema.json @@ -70,7 +70,7 @@ "type": "string" }, "gitURLType": { - "description": "The type of Git URLs to use for cloning and fetching Git repositories on this Bitbucket Server / Bitbucket Data Center instance.\n\nIf \"http\", Sourcegraph will access Bitbucket Server / Bitbucket Data Center repositories using Git URLs of the form http(s)://bitbucket.example.com/scm/myproject/myrepo.git (using https: if the Bitbucket Server / Bitbucket Data Center instance uses HTTPS).\n\nIf \"ssh\", Sourcegraph will access Bitbucket Server / Bitbucket Data Center repositories using Git URLs of the form ssh://git@example.bitbucket.org/myproject/myrepo.git. See the documentation for how to provide SSH private keys and known_hosts: https://docs.sourcegraph.com/admin/repo/auth#repositories-that-need-http-s-or-ssh-authentication.", + "description": "The type of Git URLs to use for cloning and fetching Git repositories on this Bitbucket Server / Bitbucket Data Center instance.\n\nIf \"http\", Sourcegraph will access Bitbucket Server / Bitbucket Data Center repositories using Git URLs of the form http(s)://bitbucket.example.com/scm/myproject/myrepo.git (using https: if the Bitbucket Server / Bitbucket Data Center instance uses HTTPS).\n\nIf \"ssh\", Sourcegraph will access Bitbucket Server / Bitbucket Data Center repositories using Git URLs of the form ssh://git@example.bitbucket.org/myproject/myrepo.git. See the documentation for how to provide SSH private keys and known_hosts: https://sourcegraph.com/docs/admin/repo/auth.", "type": "string", "enum": ["http", "ssh"], "default": "http", @@ -100,7 +100,7 @@ "properties": { "webhooks": { "title": "BitbucketServerPluginWebhooks", - "deprecationMessage": "Deprecated in favour of first class webhooks. See https://docs.sourcegraph.com/admin/config/webhooks/incoming#deprecation-notice", + "deprecationMessage": "Deprecated in favour of first class webhooks. See https://sourcegraph.com/docs/admin/config/webhooks/incoming#deprecation-notice", "type": "object", "required": ["secret"], "properties": { @@ -110,7 +110,7 @@ "minLength": 1 }, "disableSync": { - "description": "Disallow Sourcegraph from automatically syncing webhook config with the Bitbucket Server / Bitbucket Data Center instance. For details of how the webhook is configured, see our docs: https://docs.sourcegraph.com/admin/external_service/bitbucket_server#webhooks", + "description": "Disallow Sourcegraph from automatically syncing webhook config with the Bitbucket Server / Bitbucket Data Center instance. For details of how the webhook is configured, see our docs: https://sourcegraph.com/docs/admin/external_service/bitbucket_server#webhooks", "type": "boolean", "default": false } @@ -131,7 +131,7 @@ "examples": ["{projectKey}/{repositorySlug}"] }, "excludePersonalRepositories": { - "description": "Whether or not personal repositories should be excluded or not. When true, Sourcegraph will ignore personal repositories it may have access to. See https://docs.sourcegraph.com/integration/bitbucket_server#excluding-personal-repositories for more information.", + "description": "Whether or not personal repositories should be excluded or not. When true, Sourcegraph will ignore personal repositories it may have access to. See https://sourcegraph.com/docs/integration/bitbucket_server#excluding-personal-repositories for more information.", "type": "boolean", "default": false }, diff --git a/schema/gerrit.schema.json b/schema/gerrit.schema.json index 8dfc958aae5..5306c5143d2 100644 --- a/schema/gerrit.schema.json +++ b/schema/gerrit.schema.json @@ -58,7 +58,7 @@ }, "authorization": { "title": "GerritAuthorization", - "description": "If non-null, enforces Gerrit repository permissions. This requires that there is an item in the [site configuration json](https://docs.sourcegraph.com/admin/config/site_config#auth-providers) `auth.providers` field, of type \"gerrit\" with the same `url` field as specified in this `GerritConnection`.", + "description": "If non-null, enforces Gerrit repository permissions. This requires that there is an item in the [site configuration json](https://sourcegraph.com/docs/admin/config/site_config#auth-providers) `auth.providers` field, of type \"gerrit\" with the same `url` field as specified in this `GerritConnection`.", "type": "object", "properties": { "identityProvider": { diff --git a/schema/github.schema.json b/schema/github.schema.json index 488ec90ba0d..94cf80fbf4d 100644 --- a/schema/github.schema.json +++ b/schema/github.schema.json @@ -20,13 +20,13 @@ "examples": ["https://github.com", "https://github-enterprise.example.com"] }, "gitURLType": { - "description": "The type of Git URLs to use for cloning and fetching Git repositories on this GitHub instance.\n\nIf \"http\", Sourcegraph will access GitHub repositories using Git URLs of the form http(s)://github.com/myteam/myproject.git (using https: if the GitHub instance uses HTTPS).\n\nIf \"ssh\", Sourcegraph will access GitHub repositories using Git URLs of the form git@github.com:myteam/myproject.git. See the documentation for how to provide SSH private keys and known_hosts: https://docs.sourcegraph.com/admin/repo/auth#repositories-that-need-http-s-or-ssh-authentication.", + "description": "The type of Git URLs to use for cloning and fetching Git repositories on this GitHub instance.\n\nIf \"http\", Sourcegraph will access GitHub repositories using Git URLs of the form http(s)://github.com/myteam/myproject.git (using https: if the GitHub instance uses HTTPS).\n\nIf \"ssh\", Sourcegraph will access GitHub repositories using Git URLs of the form git@github.com:myteam/myproject.git. See the documentation for how to provide SSH private keys and known_hosts: https://sourcegraph.com/docs/admin/repo/auth.", "type": "string", "enum": ["http", "ssh"], "default": "http" }, "token": { - "description": "A GitHub personal access token. Create one for GitHub.com at https://github.com/settings/tokens/new?description=Sourcegraph (for GitHub Enterprise, replace github.com with your instance's hostname). See https://docs.sourcegraph.com/admin/external_service/github#github-api-token-and-access for which scopes are required for which use cases.", + "description": "A GitHub personal access token. Create one for GitHub.com at https://github.com/settings/tokens/new?description=Sourcegraph (for GitHub Enterprise, replace github.com with your instance's hostname). See https://sourcegraph.com/docs/admin/external_service/github#github-api-access for which scopes are required for which use cases.", "type": "string", "minLength": 1 }, @@ -73,7 +73,7 @@ }, "webhooks": { "description": "An array of configurations defining existing GitHub webhooks that send updates back to Sourcegraph.", - "deprecationMessage": "Deprecated in favour of first class webhooks. See https://docs.sourcegraph.com/admin/config/webhooks/incoming#deprecation-notice", + "deprecationMessage": "Deprecated in favour of first class webhooks. See https://sourcegraph.com/docs/admin/config/webhooks/incoming#deprecation-notice", "type": "array", "items": { "type": "object", @@ -177,11 +177,11 @@ }, "authorization": { "title": "GitHubAuthorization", - "description": "If non-null, enforces GitHub repository permissions. This requires that there is an item in the [site configuration json](https://docs.sourcegraph.com/admin/config/site_config#auth-providers) `auth.providers` field, of type \"github\" with the same `url` field as specified in this `GitHubConnection`.", + "description": "If non-null, enforces GitHub repository permissions. This requires that there is an item in the [site configuration json](https://sourcegraph.com/docs/admin/config/site_config#auth-providers) `auth.providers` field, of type \"github\" with the same `url` field as specified in this `GitHubConnection`.", "type": "object", "properties": { "groupsCacheTTL": { - "description": "Experimental: If set, configures hours cached permissions from teams and organizations should be kept for. Setting a negative value disables syncing from teams and organizations, and falls back to the default behaviour of syncing all permisisons directly from user-repository affiliations instead. [Learn more](https://docs.sourcegraph.com/admin/external_service/github#teams-and-organizations-permissions-caching).", + "description": "Experimental: If set, configures hours cached permissions from teams and organizations should be kept for. Setting a negative value disables syncing from teams and organizations, and falls back to the default behaviour of syncing all permisisons directly from user-repository affiliations instead. [Learn more](https://sourcegraph.com/docs/admin/external_service/github#teams-and-organizations-permissions-caching).", "type": "number", "default": 72 }, diff --git a/schema/gitlab.schema.json b/schema/gitlab.schema.json index a9d31d6c359..4aad528eecf 100644 --- a/schema/gitlab.schema.json +++ b/schema/gitlab.schema.json @@ -62,7 +62,7 @@ } }, "gitURLType": { - "description": "The type of Git URLs to use for cloning and fetching Git repositories on this GitLab instance.\n\nIf \"http\", Sourcegraph will access GitLab repositories using Git URLs of the form http(s)://gitlab.example.com/myteam/myproject.git (using https: if the GitLab instance uses HTTPS).\n\nIf \"ssh\", Sourcegraph will access GitLab repositories using Git URLs of the form git@example.gitlab.com:myteam/myproject.git. See the documentation for how to provide SSH private keys and known_hosts: https://docs.sourcegraph.com/admin/repo/auth#repositories-that-need-http-s-or-ssh-authentication.", + "description": "The type of Git URLs to use for cloning and fetching Git repositories on this GitLab instance.\n\nIf \"http\", Sourcegraph will access GitLab repositories using Git URLs of the form http(s)://gitlab.example.com/myteam/myproject.git (using https: if the GitLab instance uses HTTPS).\n\nIf \"ssh\", Sourcegraph will access GitLab repositories using Git URLs of the form git@example.gitlab.com:myteam/myproject.git. See the documentation for how to provide SSH private keys and known_hosts: https://sourcegraph.com/docs/admin/repo/auth#repositories-that-need-http-s-or-ssh-authentication.", "type": "string", "enum": ["http", "ssh"], "default": "http" @@ -212,7 +212,7 @@ }, "webhooks": { "description": "An array of webhook configurations", - "deprecationMessage": "Deprecated in favour of first class webhooks. See https://docs.sourcegraph.com/admin/config/webhooks/incoming#deprecation-notice", + "deprecationMessage": "Deprecated in favour of first class webhooks. See https://sourcegraph.com/docs/admin/config/webhooks/incoming#deprecation-notice", "type": "array", "items": { "type": "object", diff --git a/schema/schema.go b/schema/schema.go index d6f0448113d..8a189633a47 100644 --- a/schema/schema.go +++ b/schema/schema.go @@ -256,7 +256,7 @@ type AzureDevOpsConnection struct { // // If "http", Sourcegraph will access repositories using Git URLs of the form http(s)://dev.azure.com/myrepo.git. // - // If "ssh", Sourcegraph will access repositories using Git URLs of the form git@ssh.dev.azure.com:v3/myrepo. See the documentation for how to provide SSH private keys and known_hosts: https://docs.sourcegraph.com/admin/repo/auth#repositories-that-need-http-s-or-ssh-authentication. + // If "ssh", Sourcegraph will access repositories using Git URLs of the form git@ssh.dev.azure.com:v3/myrepo. See the documentation for how to provide SSH private keys and known_hosts: https://sourcegraph.com/docs/admin/repo/auth. GitURLType string `json:"gitURLType,omitempty"` // Orgs description: An array of organization names identifying Azure DevOps organizations whose repositories should be mirrored on Sourcegraph. Orgs []string `json:"orgs,omitempty"` @@ -337,7 +337,7 @@ type BitbucketCloudAuthProvider struct { Url string `json:"url,omitempty"` } -// BitbucketCloudAuthorization description: If non-null, enforces Bitbucket Cloud repository permissions. This requires that there is an item in the [site configuration json](https://docs.sourcegraph.com/admin/config/site_config#auth-providers) `auth.providers` field, of type "bitbucketcloud" with the same `url` field as specified in this `BitbucketCloudConnection`. +// BitbucketCloudAuthorization description: If non-null, enforces Bitbucket Cloud repository permissions. This requires that there is an item in the [site configuration json](https://sourcegraph.com/docs/admin/config/site_config#auth-providers) `auth.providers` field, of type "bitbucketcloud" with the same `url` field as specified in this `BitbucketCloudConnection`. type BitbucketCloudAuthorization struct { // IdentityProvider description: The identity provider to use for user information. If not set, the `url` field is used. IdentityProvider string `json:"identityProvider,omitempty"` @@ -351,7 +351,7 @@ type BitbucketCloudConnection struct { ApiURL string `json:"apiURL,omitempty"` // AppPassword description: The app password to use when authenticating to the Bitbucket Cloud. Also set the corresponding "username" field. AppPassword string `json:"appPassword,omitempty"` - // Authorization description: If non-null, enforces Bitbucket Cloud repository permissions. This requires that there is an item in the [site configuration json](https://docs.sourcegraph.com/admin/config/site_config#auth-providers) `auth.providers` field, of type "bitbucketcloud" with the same `url` field as specified in this `BitbucketCloudConnection`. + // Authorization description: If non-null, enforces Bitbucket Cloud repository permissions. This requires that there is an item in the [site configuration json](https://sourcegraph.com/docs/admin/config/site_config#auth-providers) `auth.providers` field, of type "bitbucketcloud" with the same `url` field as specified in this `BitbucketCloudConnection`. Authorization *BitbucketCloudAuthorization `json:"authorization,omitempty"` // Exclude description: A list of repositories to never mirror from Bitbucket Cloud. Takes precedence over "teams" configuration. // @@ -361,7 +361,7 @@ type BitbucketCloudConnection struct { // // If "http", Sourcegraph will access Bitbucket Cloud repositories using Git URLs of the form https://bitbucket.org/myteam/myproject.git. // - // If "ssh", Sourcegraph will access Bitbucket Cloud repositories using Git URLs of the form git@bitbucket.org:myteam/myproject.git. See the documentation for how to provide SSH private keys and known_hosts: https://docs.sourcegraph.com/admin/repo/auth#repositories-that-need-http-s-or-ssh-authentication. + // If "ssh", Sourcegraph will access Bitbucket Cloud repositories using Git URLs of the form git@bitbucket.org:myteam/myproject.git. See the documentation for how to provide SSH private keys and known_hosts: https://sourcegraph.com/docs/admin/repo/auth#repositories-that-need-http-s-or-ssh-authentication. GitURLType string `json:"gitURLType,omitempty"` // RateLimit description: Rate limit applied when making background API requests to Bitbucket Cloud. RateLimit *BitbucketCloudRateLimit `json:"rateLimit,omitempty"` @@ -409,13 +409,13 @@ type BitbucketServerConnection struct { // // Supports excluding by name ({"name": "projectKey/repositorySlug"}) or by ID ({"id": 42}). Exclude []*ExcludedBitbucketServerRepo `json:"exclude,omitempty"` - // ExcludePersonalRepositories description: Whether or not personal repositories should be excluded or not. When true, Sourcegraph will ignore personal repositories it may have access to. See https://docs.sourcegraph.com/integration/bitbucket_server#excluding-personal-repositories for more information. + // ExcludePersonalRepositories description: Whether or not personal repositories should be excluded or not. When true, Sourcegraph will ignore personal repositories it may have access to. See https://sourcegraph.com/docs/integration/bitbucket_server#excluding-personal-repositories for more information. ExcludePersonalRepositories bool `json:"excludePersonalRepositories,omitempty"` // GitURLType description: The type of Git URLs to use for cloning and fetching Git repositories on this Bitbucket Server / Bitbucket Data Center instance. // // If "http", Sourcegraph will access Bitbucket Server / Bitbucket Data Center repositories using Git URLs of the form http(s)://bitbucket.example.com/scm/myproject/myrepo.git (using https: if the Bitbucket Server / Bitbucket Data Center instance uses HTTPS). // - // If "ssh", Sourcegraph will access Bitbucket Server / Bitbucket Data Center repositories using Git URLs of the form ssh://git@example.bitbucket.org/myproject/myrepo.git. See the documentation for how to provide SSH private keys and known_hosts: https://docs.sourcegraph.com/admin/repo/auth#repositories-that-need-http-s-or-ssh-authentication. + // If "ssh", Sourcegraph will access Bitbucket Server / Bitbucket Data Center repositories using Git URLs of the form ssh://git@example.bitbucket.org/myproject/myrepo.git. See the documentation for how to provide SSH private keys and known_hosts: https://sourcegraph.com/docs/admin/repo/auth. GitURLType string `json:"gitURLType,omitempty"` // InitialRepositoryEnablement description: Deprecated and ignored field which will be removed entirely in the next release. BitBucket repositories can no longer be enabled or disabled explicitly. InitialRepositoryEnablement bool `json:"initialRepositoryEnablement,omitempty"` @@ -497,7 +497,7 @@ type BitbucketServerPlugin struct { Webhooks *BitbucketServerPluginWebhooks `json:"webhooks,omitempty"` } type BitbucketServerPluginWebhooks struct { - // DisableSync description: Disallow Sourcegraph from automatically syncing webhook config with the Bitbucket Server / Bitbucket Data Center instance. For details of how the webhook is configured, see our docs: https://docs.sourcegraph.com/admin/external_service/bitbucket_server#webhooks + // DisableSync description: Disallow Sourcegraph from automatically syncing webhook config with the Bitbucket Server / Bitbucket Data Center instance. For details of how the webhook is configured, see our docs: https://sourcegraph.com/docs/admin/external_service/bitbucket_server#webhooks DisableSync bool `json:"disableSync,omitempty"` // Secret description: Secret for authenticating incoming webhook payloads Secret string `json:"secret"` @@ -1138,7 +1138,7 @@ type GerritAuthProvider struct { Url string `json:"url"` } -// GerritAuthorization description: If non-null, enforces Gerrit repository permissions. This requires that there is an item in the [site configuration json](https://docs.sourcegraph.com/admin/config/site_config#auth-providers) `auth.providers` field, of type "gerrit" with the same `url` field as specified in this `GerritConnection`. +// GerritAuthorization description: If non-null, enforces Gerrit repository permissions. This requires that there is an item in the [site configuration json](https://sourcegraph.com/docs/admin/config/site_config#auth-providers) `auth.providers` field, of type "gerrit" with the same `url` field as specified in this `GerritConnection`. type GerritAuthorization struct { // IdentityProvider description: The identity provider to use for user information. If not set, the `url` field is used. IdentityProvider string `json:"identityProvider,omitempty"` @@ -1146,7 +1146,7 @@ type GerritAuthorization struct { // GerritConnection description: Configuration for a connection to Gerrit. type GerritConnection struct { - // Authorization description: If non-null, enforces Gerrit repository permissions. This requires that there is an item in the [site configuration json](https://docs.sourcegraph.com/admin/config/site_config#auth-providers) `auth.providers` field, of type "gerrit" with the same `url` field as specified in this `GerritConnection`. + // Authorization description: If non-null, enforces Gerrit repository permissions. This requires that there is an item in the [site configuration json](https://sourcegraph.com/docs/admin/config/site_config#auth-providers) `auth.providers` field, of type "gerrit" with the same `url` field as specified in this `GerritConnection`. Authorization *GerritAuthorization `json:"authorization,omitempty"` // Exclude description: A list of repositories to never mirror from this Gerrit instance. Takes precedence over "projects" configuration. // @@ -1212,7 +1212,7 @@ type GitHubAppDetails struct { // GitHubAuthProvider description: Configures the GitHub (or GitHub Enterprise) OAuth authentication provider for SSO. In addition to specifying this configuration object, you must also create a OAuth App on your GitHub instance: https://developer.github.com/apps/building-oauth-apps/creating-an-oauth-app/. When a user signs into Sourcegraph or links their GitHub account to their existing Sourcegraph account, GitHub will prompt the user for the repo scope. type GitHubAuthProvider struct { - // AllowGroupsPermissionsSync description: Experimental: Allows sync of GitHub teams and organizations permissions across all external services associated with this provider to allow enabling of [repository permissions caching](https://docs.sourcegraph.com/admin/external_service/github#teams-and-organizations-permissions-caching). + // AllowGroupsPermissionsSync description: Experimental: Allows sync of GitHub teams and organizations permissions across all external services associated with this provider to allow enabling of [repository permissions caching](https://sourcegraph.com/docs/admin/external_service/github#teams-and-organizations-permissions-caching). AllowGroupsPermissionsSync bool `json:"allowGroupsPermissionsSync,omitempty"` // AllowOrgs description: Restricts new logins and signups (if allowSignup is true) to members of these GitHub organizations. Existing sessions won't be invalidated. Leave empty or unset for no org restrictions. AllowOrgs []string `json:"allowOrgs,omitempty"` @@ -1233,9 +1233,9 @@ type GitHubAuthProvider struct { Url string `json:"url,omitempty"` } -// GitHubAuthorization description: If non-null, enforces GitHub repository permissions. This requires that there is an item in the [site configuration json](https://docs.sourcegraph.com/admin/config/site_config#auth-providers) `auth.providers` field, of type "github" with the same `url` field as specified in this `GitHubConnection`. +// GitHubAuthorization description: If non-null, enforces GitHub repository permissions. This requires that there is an item in the [site configuration json](https://sourcegraph.com/docs/admin/config/site_config#auth-providers) `auth.providers` field, of type "github" with the same `url` field as specified in this `GitHubConnection`. type GitHubAuthorization struct { - // GroupsCacheTTL description: Experimental: If set, configures hours cached permissions from teams and organizations should be kept for. Setting a negative value disables syncing from teams and organizations, and falls back to the default behaviour of syncing all permisisons directly from user-repository affiliations instead. [Learn more](https://docs.sourcegraph.com/admin/external_service/github#teams-and-organizations-permissions-caching). + // GroupsCacheTTL description: Experimental: If set, configures hours cached permissions from teams and organizations should be kept for. Setting a negative value disables syncing from teams and organizations, and falls back to the default behaviour of syncing all permisisons directly from user-repository affiliations instead. [Learn more](https://sourcegraph.com/docs/admin/external_service/github#teams-and-organizations-permissions-caching). GroupsCacheTTL float64 `json:"groupsCacheTTL,omitempty"` // MarkInternalReposAsPublic description: If true, internal repositories will be accessible to all users on Sourcegraph as if they were public. This overrides repository permissions but allows easier discovery and access to internal repositories, and may be desirable if all users on the Sourcegraph instance should have access to all internal repositories anyways. Defaults to false. MarkInternalReposAsPublic bool `json:"markInternalReposAsPublic,omitempty"` @@ -1245,7 +1245,7 @@ type GitHubAuthorization struct { // GitHubConnection description: Configuration for a connection to GitHub or GitHub Enterprise. type GitHubConnection struct { - // Authorization description: If non-null, enforces GitHub repository permissions. This requires that there is an item in the [site configuration json](https://docs.sourcegraph.com/admin/config/site_config#auth-providers) `auth.providers` field, of type "github" with the same `url` field as specified in this `GitHubConnection`. + // Authorization description: If non-null, enforces GitHub repository permissions. This requires that there is an item in the [site configuration json](https://sourcegraph.com/docs/admin/config/site_config#auth-providers) `auth.providers` field, of type "github" with the same `url` field as specified in this `GitHubConnection`. Authorization *GitHubAuthorization `json:"authorization,omitempty"` // Certificate description: TLS certificate of the GitHub Enterprise instance. This is only necessary if the certificate is self-signed or signed by an internal CA. To get the certificate run `openssl s_client -connect HOST:443 -showcerts < /dev/null 2> /dev/null | openssl x509 -outform PEM`. To escape the value into a JSON string, you may want to use a tool like https://json-escape-text.now.sh. Certificate string `json:"certificate,omitempty"` @@ -1265,7 +1265,7 @@ type GitHubConnection struct { // // If "http", Sourcegraph will access GitHub repositories using Git URLs of the form http(s)://github.com/myteam/myproject.git (using https: if the GitHub instance uses HTTPS). // - // If "ssh", Sourcegraph will access GitHub repositories using Git URLs of the form git@github.com:myteam/myproject.git. See the documentation for how to provide SSH private keys and known_hosts: https://docs.sourcegraph.com/admin/repo/auth#repositories-that-need-http-s-or-ssh-authentication. + // If "ssh", Sourcegraph will access GitHub repositories using Git URLs of the form git@github.com:myteam/myproject.git. See the documentation for how to provide SSH private keys and known_hosts: https://sourcegraph.com/docs/admin/repo/auth. GitURLType string `json:"gitURLType,omitempty"` // GithubAppInstallationID description: DEPRECATED: The installation ID of the GitHub App. GithubAppInstallationID string `json:"githubAppInstallationID,omitempty"` @@ -1302,7 +1302,7 @@ type GitHubConnection struct { // // If you need to narrow the set of mirrored repositories further (and don't want to enumerate it with a list or query set as above), create a new bot/machine user on GitHub or GitHub Enterprise that is only affiliated with the desired repositories. RepositoryQuery []string `json:"repositoryQuery,omitempty"` - // Token description: A GitHub personal access token. Create one for GitHub.com at https://github.com/settings/tokens/new?description=Sourcegraph (for GitHub Enterprise, replace github.com with your instance's hostname). See https://docs.sourcegraph.com/admin/external_service/github#github-api-token-and-access for which scopes are required for which use cases. + // Token description: A GitHub personal access token. Create one for GitHub.com at https://github.com/settings/tokens/new?description=Sourcegraph (for GitHub Enterprise, replace github.com with your instance's hostname). See https://sourcegraph.com/docs/admin/external_service/github#github-api-access for which scopes are required for which use cases. Token string `json:"token,omitempty"` // Url description: URL of a GitHub instance, such as https://github.com or https://github-enterprise.example.com. Url string `json:"url"` @@ -1373,7 +1373,7 @@ type GitLabConnection struct { // // If "http", Sourcegraph will access GitLab repositories using Git URLs of the form http(s)://gitlab.example.com/myteam/myproject.git (using https: if the GitLab instance uses HTTPS). // - // If "ssh", Sourcegraph will access GitLab repositories using Git URLs of the form git@example.gitlab.com:myteam/myproject.git. See the documentation for how to provide SSH private keys and known_hosts: https://docs.sourcegraph.com/admin/repo/auth#repositories-that-need-http-s-or-ssh-authentication. + // If "ssh", Sourcegraph will access GitLab repositories using Git URLs of the form git@example.gitlab.com:myteam/myproject.git. See the documentation for how to provide SSH private keys and known_hosts: https://sourcegraph.com/docs/admin/repo/auth#repositories-that-need-http-s-or-ssh-authentication. GitURLType string `json:"gitURLType,omitempty"` // InitialRepositoryEnablement description: Deprecated and ignored field which will be removed entirely in the next release. GitLab repositories can no longer be enabled or disabled explicitly. InitialRepositoryEnablement bool `json:"initialRepositoryEnablement,omitempty"` @@ -1785,11 +1785,11 @@ type ObservabilityClient struct { OpenTelemetry *OpenTelemetry `json:"openTelemetry,omitempty"` } -// ObservabilityTracing description: Configures distributed tracing within Sourcegraph. To learn more, refer to https://docs.sourcegraph.com/admin/observability/tracing +// ObservabilityTracing description: Configures distributed tracing within Sourcegraph. To learn more, refer to https://sourcegraph.com/docs/admin/observability/tracing type ObservabilityTracing struct { // Debug description: Turns on debug logging of tracing client requests. This can be useful for debugging connectivity issues between the tracing client and tracing backend, the performance overhead of tracing, and other issues related to the use of distributed tracing. May have performance implications in production. Debug bool `json:"debug,omitempty"` - // Sampling description: Determines the conditions under which distributed traces are recorded. "none" turns off tracing entirely. "selective" (default) sends traces whenever `?trace=1` is present in the URL (though background jobs may still emit traces). "all" sends traces on every request. Note that this only affects the behavior of the distributed tracing client. To learn more about additional sampling and traace export configuration with the default tracing type "opentelemetry", refer to https://docs.sourcegraph.com/admin/observability/opentelemetry#tracing + // Sampling description: Determines the conditions under which distributed traces are recorded. "none" turns off tracing entirely. "selective" (default) sends traces whenever `?trace=1` is present in the URL (though background jobs may still emit traces). "all" sends traces on every request. Note that this only affects the behavior of the distributed tracing client. To learn more about additional sampling and traace export configuration with the default tracing type "opentelemetry", refer to https://sourcegraph.com/docs/admin/observability/opentelemetry#tracing Sampling string `json:"sampling,omitempty"` // Type description: Determines what tracing provider to enable. For "opentelemetry", the required backend is an OpenTelemetry collector instance (deployed by default with Sourcegraph). For "jaeger", a Jaeger instance is required to be configured via Jaeger client environment variables: https://github.com/jaegertracing/jaeger-client-go#environment-variables Type string `json:"type,omitempty"` @@ -2253,7 +2253,7 @@ type SAMLAuthProvider struct { } // SMTPServerConfig description: The SMTP server used to send transactional emails. -// Please see https://docs.sourcegraph.com/admin/config/email +// Please see https://sourcegraph.com/docs/admin/config/email type SMTPServerConfig struct { // AdditionalHeaders description: Additional headers to include on SMTP messages that cannot be configured with other 'email.smtp' fields. AdditionalHeaders []*Header `json:"additionalHeaders,omitempty"` @@ -2756,9 +2756,9 @@ type SiteConfiguration struct { CodeIntelRankingStaleResultsAge int `json:"codeIntelRanking.staleResultsAge,omitempty"` // CodyEnabled description: Enable or disable Cody instance-wide. When Cody is disabled, all Cody endpoints and GraphQL queries will return errors, Cody will not show up in the site-admin sidebar, and Cody in the global navbar will only show a call-to-action for site-admins to enable Cody. 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://docs.sourcegraph.com/admin/access_control + // 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://docs.sourcegraph.com/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://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 *bool `json:"cody.restrictUsersFeatureFlag,omitempty"` // Completions description: Configuration for the completions service. Completions *Completions `json:"completions,omitempty"` @@ -2783,12 +2783,12 @@ type SiteConfiguration struct { // Dotcom description: Configuration options for Sourcegraph.com only. Dotcom *Dotcom `json:"dotcom,omitempty"` // EmailAddress description: The "from" address for emails sent by this server. - // Please see https://docs.sourcegraph.com/admin/config/email + // Please see https://sourcegraph.com/docs/admin/config/email EmailAddress string `json:"email.address,omitempty"` // EmailSenderName description: The name to use in the "from" address for emails sent by this server. EmailSenderName string `json:"email.senderName,omitempty"` // EmailSmtp description: The SMTP server used to send transactional emails. - // Please see https://docs.sourcegraph.com/admin/config/email + // Please see https://sourcegraph.com/docs/admin/config/email EmailSmtp *SMTPServerConfig `json:"email.smtp,omitempty"` // EmailTemplates description: Configurable templates for some email types sent by Sourcegraph. EmailTemplates *EmailTemplates `json:"email.templates,omitempty"` @@ -2885,7 +2885,7 @@ type SiteConfiguration struct { ObservabilityLogSlowSearches int `json:"observability.logSlowSearches,omitempty"` // ObservabilitySilenceAlerts description: Silence individual Sourcegraph alerts by identifier. ObservabilitySilenceAlerts []string `json:"observability.silenceAlerts,omitempty"` - // ObservabilityTracing description: Configures distributed tracing within Sourcegraph. To learn more, refer to https://docs.sourcegraph.com/admin/observability/tracing + // ObservabilityTracing description: Configures distributed tracing within Sourcegraph. To learn more, refer to https://sourcegraph.com/docs/admin/observability/tracing ObservabilityTracing *ObservabilityTracing `json:"observability.tracing,omitempty"` // OrganizationInvitations description: Configuration for organization invitations. OrganizationInvitations *OrganizationInvitations `json:"organizationInvitations,omitempty"` diff --git a/schema/site.schema.json b/schema/site.schema.json index f7c1ba37435..283e8115e08 100644 --- a/schema/site.schema.json +++ b/schema/site.schema.json @@ -1412,7 +1412,7 @@ }, "email.smtp": { "title": "SMTPServerConfig", - "description": "The SMTP server used to send transactional emails.\nPlease see https://docs.sourcegraph.com/admin/config/email", + "description": "The SMTP server used to send transactional emails.\nPlease see https://sourcegraph.com/docs/admin/config/email", "type": "object", "additionalProperties": false, "required": ["host", "port", "authentication"], @@ -1487,7 +1487,7 @@ "group": "Email" }, "email.address": { - "description": "The \"from\" address for emails sent by this server.\nPlease see https://docs.sourcegraph.com/admin/config/email", + "description": "The \"from\" address for emails sent by this server.\nPlease see https://sourcegraph.com/docs/admin/config/email", "type": "string", "format": "email", "group": "Email", @@ -1754,11 +1754,11 @@ ] }, "observability.tracing": { - "description": "Configures distributed tracing within Sourcegraph. To learn more, refer to https://docs.sourcegraph.com/admin/observability/tracing", + "description": "Configures distributed tracing within Sourcegraph. To learn more, refer to https://sourcegraph.com/docs/admin/observability/tracing", "type": "object", "properties": { "sampling": { - "description": "Determines the conditions under which distributed traces are recorded. \"none\" turns off tracing entirely. \"selective\" (default) sends traces whenever `?trace=1` is present in the URL (though background jobs may still emit traces). \"all\" sends traces on every request. Note that this only affects the behavior of the distributed tracing client. To learn more about additional sampling and traace export configuration with the default tracing type \"opentelemetry\", refer to https://docs.sourcegraph.com/admin/observability/opentelemetry#tracing ", + "description": "Determines the conditions under which distributed traces are recorded. \"none\" turns off tracing entirely. \"selective\" (default) sends traces whenever `?trace=1` is present in the URL (though background jobs may still emit traces). \"all\" sends traces on every request. Note that this only affects the behavior of the distributed tracing client. To learn more about additional sampling and traace export configuration with the default tracing type \"opentelemetry\", refer to https://sourcegraph.com/docs/admin/observability/opentelemetry#tracing ", "type": "string", "enum": ["selective", "all", "none"], "default": "selective" @@ -2576,7 +2576,7 @@ "group": "Cody" }, "cody.permissions": { - "description": "Whether to enable Cody role-based access controls. Only respected if cody.restrictUsersFeatureFlag is not set. See https://docs.sourcegraph.com/admin/access_control", + "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", "type": "boolean", "default": true, "!go": { @@ -2585,7 +2585,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://docs.sourcegraph.com/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://sourcegraph.com/docs/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": { @@ -3333,7 +3333,7 @@ ] }, "allowGroupsPermissionsSync": { - "description": "Experimental: Allows sync of GitHub teams and organizations permissions across all external services associated with this provider to allow enabling of [repository permissions caching](https://docs.sourcegraph.com/admin/external_service/github#teams-and-organizations-permissions-caching).", + "description": "Experimental: Allows sync of GitHub teams and organizations permissions across all external services associated with this provider to allow enabling of [repository permissions caching](https://sourcegraph.com/docs/admin/external_service/github#teams-and-organizations-permissions-caching).", "default": false, "type": "boolean" } diff --git a/sg.config.yaml b/sg.config.yaml index aa447cfec9b..3a456bd6fc4 100644 --- a/sg.config.yaml +++ b/sg.config.yaml @@ -303,7 +303,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://docs.sourcegraph.com/dev/how-to/cody_gateway + # Set in override if you want to test local Cody Gateway: https://sourcegraph.com/docs/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 @@ -1684,7 +1684,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://docs.sourcegraph.com/dev/how-to/testing#running-end-to-end-tests + See more details: https://sourcegraph.com/docs/dev/how-to/testing#running-end-to-end-tests cmd: pnpm test-e2e env: TEST_USER_EMAIL: test@sourcegraph.com @@ -1701,7 +1701,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://docs.sourcegraph.com/dev/how-to/testing#running-regression-tests + See more details: https://sourcegraph.com/docs/dev/how-to/testing#running-regression-tests cmd: pnpm test-regression env: @@ -1715,7 +1715,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://docs.sourcegraph.com/dev/how-to/testing#running-integration-tests + See more details: https://sourcegraph.com/docs/dev/how-to/testing#running-integration-tests cmd: pnpm test-integration @@ -1724,6 +1724,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://docs.sourcegraph.com/dev/how-to/testing#running-integration-tests + See more details: https://sourcegraph.com/docs/dev/how-to/testing#running-integration-tests cmd: pnpm test-integration:debug diff --git a/wolfi-images/grafana.yaml b/wolfi-images/grafana.yaml index 0b588da78b2..c873136f203 100644 --- a/wolfi-images/grafana.yaml +++ b/wolfi-images/grafana.yaml @@ -102,4 +102,4 @@ archs: annotations: org.opencontainers.image.url: https://sourcegraph.com/ org.opencontainers.image.source: https://github.com/sourcegraph/sourcegraph/ - org.opencontainers.image.documentation: https://docs.sourcegraph.com/ + org.opencontainers.image.documentation: https://sourcegraph.com/docs/ diff --git a/wolfi-images/sourcegraph-base.yaml b/wolfi-images/sourcegraph-base.yaml index aa8d8ac2f63..76d26008ab6 100644 --- a/wolfi-images/sourcegraph-base.yaml +++ b/wolfi-images/sourcegraph-base.yaml @@ -40,6 +40,6 @@ archs: annotations: org.opencontainers.image.url: https://sourcegraph.com/ org.opencontainers.image.source: https://github.com/sourcegraph/sourcegraph/ - org.opencontainers.image.documentation: https://docs.sourcegraph.com/ + org.opencontainers.image.documentation: https://sourcegraph.com/docs/ # MANUAL REBUILD: Wed Oct 11 09:59:22 BST 2023