Elevate product areas in documentation (#14792)

This commit is contained in:
Christina Forney 2020-10-18 10:55:18 -07:00 committed by GitHub
parent 72a51c8ced
commit e4958b671b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
111 changed files with 144 additions and 99 deletions

View File

@ -39,7 +39,7 @@ All notable changes to Sourcegraph are documented in this file.
- Changesets created by campaigns will now include a link back to the campaign in their body text. [#14033](https://github.com/sourcegraph/sourcegraph/issues/14033)
- Users can now preview commits that are going to be created in their repositories in the campaign preview UI. [#14181](https://github.com/sourcegraph/sourcegraph/pull/14181)
- If emails are configured, the user will be sent an email when important account information is changed. This currently encompasses changing/resetting the password, adding/removing emails, and adding/removing access tokens. [#14320](https://github.com/sourcegraph/sourcegraph/pull/14320)
- A subset of changesets can now be published by setting the `published` flag in campaign specs [to an array](https://docs.sourcegraph.com/@main/user/campaigns/campaign_spec_yaml_reference#publishing-only-specific-changesets), which allows only specific changesets within a campaign to be published based on the repository name. [#13476](https://github.com/sourcegraph/sourcegraph/pull/13476)
- A subset of changesets can now be published by setting the `published` flag in campaign specs [to an array](https://docs.sourcegraph.com/@main/campaigns/campaign_spec_yaml_reference#publishing-only-specific-changesets), which allows only specific changesets within a campaign to be published based on the repository name. [#13476](https://github.com/sourcegraph/sourcegraph/pull/13476)
- Homepage panels are now enabled by default. [#14287](https://github.com/sourcegraph/sourcegraph/issues/14287)
- The most recent ping data is now available to site admins via the Site-admin > Pings page. [#13956](https://github.com/sourcegraph/sourcegraph/issues/13956)
- Homepage panel engagement metrics will be sent back in pings. [#14589](https://github.com/sourcegraph/sourcegraph/pull/14589)
@ -101,7 +101,7 @@ All notable changes to Sourcegraph are documented in this file.
- To define repository groups (`search.repositoryGroups` in global, org, or user settings), you can now specify regular expressions in addition to single repository names. [#13730](https://github.com/sourcegraph/sourcegraph/pull/13730)
- The new site configuration property `search.limits` configures the maximum search timeout and the maximum number of repositories to search for various types of searches. [#13448](https://github.com/sourcegraph/sourcegraph/pull/13448)
- Files and directories can now be excluded from search by adding the file `.sourcegraph/ignore` to the root directory of a repository. Each line in the _ignore_ file is interpreted as a globbing pattern. [#13690](https://github.com/sourcegraph/sourcegraph/pull/13690)
- Structural search syntax now allows regular expressions in patterns. Also, `...` can now be used in place of `:[_]`. See the [documentation](https://docs.sourcegraph.com/@main/user/search/structural) for example syntax. [#13809](https://github.com/sourcegraph/sourcegraph/pull/13809)
- Structural search syntax now allows regular expressions in patterns. Also, `...` can now be used in place of `:[_]`. See the [documentation](https://docs.sourcegraph.com/@main/code_search/reference/structural) for example syntax. [#13809](https://github.com/sourcegraph/sourcegraph/pull/13809)
- The total size of all Git repositories and the lines of code for indexed branches will be sent back in pings. [#13764](https://github.com/sourcegraph/sourcegraph/pull/13764)
- Experimental: A new homepage UI for Sourcegraph Server shows the user their recent searches, repositories, files, and saved searches. It can be enabled with `experimentalFeatures.showEnterpriseHomePanels`. [#13407](https://github.com/sourcegraph/sourcegraph/issues/13407)
@ -277,7 +277,7 @@ All notable changes to Sourcegraph are documented in this file.
- Notifications about Sourcegraph being out of date will now be shown to site admins and users (depending on how out-of-date it is).
- Alerts are now configured using `observability.alerts` in the site configuration, instead of via the Grafana web UI. This does not yet support all Grafana notification channel types, and is not yet supported on `sourcegraph/server` ([#11473](https://github.com/sourcegraph/sourcegraph/issues/11473)). For more details, please refer to the [Sourcegraph alerting guide](https://docs.sourcegraph.com/admin/observability/alerting).
- Experimental basic support for detecting if your Sourcegraph instance is over or under-provisioned has been added through a set of dashboards and warning-level alerts based on container utilization.
- Query [operators](https://docs.sourcegraph.com/user/search/reference/queries#operators) `and` and `or` are now enabled by default in all search modes for searching file content. [#11521](https://github.com/sourcegraph/sourcegraph/pull/11521)
- Query [operators](https://docs.sourcegraph.com/code_search/reference/queries#operators) `and` and `or` are now enabled by default in all search modes for searching file content. [#11521](https://github.com/sourcegraph/sourcegraph/pull/11521)
### Changed
@ -690,7 +690,7 @@ This is `3.12.8` release with internal infrastructure fixes to publish the docke
### Added
- Bitbucket Server repositories with the label `archived` can be excluded from search with `archived:no` [syntax](https://docs.sourcegraph.com/user/search/reference/queries). [#5494](https://github.com/sourcegraph/sourcegraph/issues/5494)
- Bitbucket Server repositories with the label `archived` can be excluded from search with `archived:no` [syntax](https://docs.sourcegraph.com/code_search/reference/queries). [#5494](https://github.com/sourcegraph/sourcegraph/issues/5494)
- Add button to download file in code view. [#5478](https://github.com/sourcegraph/sourcegraph/issues/5478)
- The new `allowOrgs` site config setting in GitHub `auth.providers` enables admins to restrict GitHub logins to members of specific GitHub organizations. [#4195](https://github.com/sourcegraph/sourcegraph/issues/4195)
- Support case field in repository search. [#7671](https://github.com/sourcegraph/sourcegraph/issues/7671)
@ -753,7 +753,7 @@ This is `3.12.8` release with internal infrastructure fixes to publish the docke
- Logging for GraphQL API requests not issued by Sourcegraph is now much more verbose, allowing for easier debugging of problematic queries and where they originate from. [#5706](https://github.com/sourcegraph/sourcegraph/issues/5706)
- A new campaign type finds and removes leaked NPM credentials. [#6893](https://github.com/sourcegraph/sourcegraph/pull/6893)
- Campaigns can now be retried to create failed changesets due to ephemeral errors (e.g. network problems when creating a pull request on GitHub). [#6718](https://github.com/sourcegraph/sourcegraph/issues/6718)
- The initial release of [structural code search](https://docs.sourcegraph.com/user/search/structural).
- The initial release of [structural code search](https://docs.sourcegraph.com/code_search/reference/structural).
### Changed

View File

@ -11,7 +11,7 @@ export const base64ImageBadge: Omit<BadgeAttachmentRenderOptions, 'kind'> = {
light: { icon: base64icon },
hoverMessage:
'Search-based results - click to see how these results are calculated and how to get precise intelligence with LSIF.',
linkURL: 'https://docs.sourcegraph.com/user/code_intelligence/explanations/basic_code_intelligence',
linkURL: 'https://docs.sourcegraph.com/code_intelligence/explanations/basic_code_intelligence',
}
export const badgeWithKind: BadgeAttachmentRenderOptions = {

View File

@ -6,7 +6,7 @@ exports[`BadgeAttachment renders an img element with a base64 icon 1`] = `
class=""
data-placement="left"
data-tooltip="Search-based results - click to see how these results are calculated and how to get precise intelligence with LSIF."
href="https://docs.sourcegraph.com/user/code_intelligence/explanations/basic_code_intelligence"
href="https://docs.sourcegraph.com/code_intelligence/explanations/basic_code_intelligence"
rel="noreferrer noopener"
target="_blank"
>
@ -23,7 +23,7 @@ exports[`BadgeAttachment renders an svg element with a predefined icon 1`] = `
class=""
data-placement="left"
data-tooltip="Search-based results - click to see how these results are calculated and how to get precise intelligence with LSIF."
href="https://docs.sourcegraph.com/user/code_intelligence/explanations/basic_code_intelligence"
href="https://docs.sourcegraph.com/code_intelligence/explanations/basic_code_intelligence"
rel="noreferrer noopener"
target="_blank"
>

View File

@ -58,7 +58,7 @@ const FIXTURE_BADGE: BadgeAttachmentRenderOptions = {
kind: 'info',
hoverMessage:
'Search-based results - click to see how these results are calculated and how to get precise intelligence with LSIF.',
linkURL: 'https://docs.sourcegraph.com/user/code_intelligence/explanations/basic_code_intelligence',
linkURL: 'https://docs.sourcegraph.com/code_intelligence/explanations/basic_code_intelligence',
}
const LEGACY_FIXTURE_BADGE = {
@ -70,7 +70,7 @@ const LEGACY_FIXTURE_BADGE = {
},
hoverMessage:
'Search-based results - click to see how these results are calculated and how to get precise intelligence with LSIF.',
linkURL: 'https://docs.sourcegraph.com/user/code_intelligence/explanations/basic_code_intelligence',
linkURL: 'https://docs.sourcegraph.com/code_intelligence/explanations/basic_code_intelligence',
} as BadgeAttachmentRenderOptions
const FIXTURE_CONTENT: Badged<MarkupContent> = {

View File

@ -76,7 +76,7 @@ export const CampaignCloseAlert: React.FunctionComponent<CampaignCloseAlertProps
{!viewerCanAdminister && (
<p className="text-warning">
You don't have permission to close this campaign. See{' '}
<a href="https://docs.sourcegraph.com/user/campaigns/explanations/permissions_in_campaigns">
<a href="https://docs.sourcegraph.com/campaigns/explanations/permissions_in_campaigns">
Permissions in campaigns
</a>{' '}
for more information about the campaigns permission model.

View File

@ -56,7 +56,7 @@ export const CampaignsDotComPage: React.FunctionComponent<CampaignsDotComPagePro
</li>
<li>
Follow the{' '}
<a href="https://docs.sourcegraph.com/user/campaigns/getting_started" rel="noopener">
<a href="https://docs.sourcegraph.com/campaigns/getting_started" rel="noopener">
Getting started with campaigns
</a>{' '}
guide to enable campaigns on your instance and start using them.

View File

@ -109,7 +109,7 @@ exports[`CampaignsDotComPage renders 1`] = `
Follow the
<a
href="https://docs.sourcegraph.com/user/campaigns/getting_started"
href="https://docs.sourcegraph.com/campaigns/getting_started"
rel="noopener"
>
Getting started with campaigns

View File

@ -196,7 +196,7 @@ export const CodeIntelIndexesPage: FunctionComponent<CodeIntelIndexesPageProps>
</a>
. Enable precise code intelligence for non-Go code by{' '}
<a
href="https://docs.sourcegraph.com/user/code_intelligence/explanations/precise_code_intelligence"
href="https://docs.sourcegraph.com/code_intelligence/explanations/precise_code_intelligence"
target="_blank"
rel="noreferrer noopener"
>

View File

@ -208,7 +208,7 @@ export const CodeIntelUploadsPage: FunctionComponent<CodeIntelUploadsPageProps>
<p>
Enable precise code intelligence by{' '}
<a
href="https://docs.sourcegraph.com/user/code_intelligence/explanations/precise_code_intelligence"
href="https://docs.sourcegraph.com/code_intelligence/explanations/precise_code_intelligence"
target="_blank"
rel="noreferrer noopener"
>

View File

@ -104,7 +104,7 @@ export const SearchHelpDropdownButton: React.FunctionComponent = () => {
// eslint-disable-next-line react/jsx-no-target-blank
target="_blank"
rel="noopener"
href={`${documentationUrlPrefix}/user/search/reference/queries`}
href={`${documentationUrlPrefix}/code_search/reference/queries`}
className="dropdown-item"
onClick={toggleIsOpen}
>

View File

@ -359,7 +359,7 @@ export class QueryBuilder extends React.Component<QueryBuilderProps, QueryBuilde
/>
</div>
<div className="query-builder__docs-link">
<a target="blank" href={`${documentationUrlPrefix}/user/search/reference/queries`}>
<a target="blank" href={`${documentationUrlPrefix}/code_search/reference/queries`}>
View all search options in docs <ExternalLinkIcon className="icon-inline small" />
</a>
</div>

View File

@ -396,7 +396,7 @@ func (r *searchResolver) alertForInvalidRevision(revision string) *searchAlert {
revision = strings.TrimSuffix(revision, "^0")
return &searchAlert{
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/user/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://docs.sourcegraph.com/code_search/reference/queries#repository-revisions.", revision),
}
}

View File

@ -17,7 +17,7 @@ ALPINE_MATCHES=$(git grep -e '\salpine\:' --and --not -e '^\s*//' --and --not -e
':(exclude)docker-images/README.md' \
':(exclude)docker-images/alpine' \
':(exclude)doc/dev/campaigns_design.md' \
':(exclude)doc/user/campaigns/' \
':(exclude)doc/campaigns/' \
':(exclude)web/src/enterprise/campaigns/create/CreateCampaignPage.tsx' \
':(exclude)vendor' \
':(eclude)testdata')

View File

@ -130,11 +130,6 @@
/dev/documentation /dev/how-to/documentation_implementation 308
/dev/zoekt /dev/how-to/zoekt_local_dev 308
/user/automation /user/campaigns 308
/user/campaigns/examples /user/campaigns/tutorials 308
/user/campaigns/managing_access /user/campaigns/explanations/permissions_in_campaigns 308
/dev/automation_development /dev/campaigns_development 308
/user/search/examples /user/search/tutorials/examples 308
/user/search/queries /user/search/reference/queries 308
/user/search/language /user/search/reference/language 308
@ -159,3 +154,13 @@
/user/repository/badges /user/personalization/badges 308
/user/quick_links /user/personalization/quick_links 308
/user/themes /user/personalization/themes 308
/user/automation /user/campaigns 308
/user/campaigns/examples /campaigns/tutorials 308
/user/campaigns/managing_access /campaigns/explanations/permissions_in_campaigns 308
/dev/automation_development /dev/background-information/campaigns/index 308
/user/search /code_search 308
/user/campaigns /campaigns 308
/user/code_intelligence /code_intelligence 308
/user /getting-started 308

View File

@ -96,13 +96,39 @@
{{define "fallbackSidebar"}}
{{/* The fallback sidebar for revisions before the sidebar.md file existed. */}}
<ul>
<li class="expand"><a href="/user">Usage</a>
<li class="expand"><a href="/getting-started">Getting started</a>
<ul>
<li><a href="/user/tour">Tour</a></li>
<li class="expand"><a href="/user/search">Code search</a></li>
<li><a href="/user/code_intelligence">Code intelligence</a></li>
<li><a href="/user/campaigns">Campaigns</a></li>
</ul></li>
<li><a href="/getting-started/tour">Product tour</a></li>
<li><a href="/getting-started/personalization">Personalization</a></li>
</ul>
</li>
<li class="expand"><a href="/code_search">Code search</a>
<ul>
<li><a href="code_search/tutorials">Tutorials</a></li>
<li><a href="code_search/how-to">How-to guides</a></li>
<li><a href="code_search/explanations">Explanations</a></li>
<li><a href="code_search/reference">Reference</a></li>
</ul>
</li>
<li><a href="/code_intelligence">Code intelligence</a>
<ul>
<li><a href="code_intelligence/tutorials">Tutorials</a></li>
<li><a href="code_intelligence/how-to">How-to guides</a></li>
<li><a href="code_intelligence/explanations">Explanations</a></li>
<li><a href="code_intelligence/reference">Reference</a></li>
</ul>
</li>
<li><a href="/campaigns">Campaigns</a>
<ul>
<li><a href="campaigns/tutorials">Tutorials</a></li>
<li><a href="campaigns/how-to">How-to guides</a></li>
<li><a href="campaigns/explanations">Explanations</a></li>
<li><a href="campaigns/reference">Reference</a></li>
</ul>
</li>
<li><a href="/integration">Integrations</a></li>
<li><a href="/extensions">Extensions</a></li>
<li><a href="/adopt">Adopting</a></li>
<li><a href="/admin">Administration</a>
<ul>
<li><a href="/admin/install">Install</a></li>
@ -115,10 +141,6 @@
<li><a href="/admin/faq">FAQ</a></li>
<li><a href="/admin/troubleshooting">Troubleshooting</a></li>
</ul></li>
<li><a href="/integration">Integrations</a></li>
<li><a href="/extensions">Extensions</a></li>
<li><a href="/api/graphql">GraphQL API</a></li>
<li><a href="/adopt">Adopting</a></li>
<li><a href="/dev">Development</a></li>
<ul>
<li><a href="dev/getting-started">Getting started</a></li>
@ -127,6 +149,7 @@
</ul>
<li><br></li>
<li><a href="/#quickstart-guide">★ Quick install</a></li>
<li><a href="/user/search/reference/queries">★ Search query syntax</a></li>
<li><a href="/code_search/reference/queries">★ Search query syntax</a></li>
<li><a href="/api/graphql">★ GraphQL API</a></li>
</ul>
{{end}}

View File

@ -8,7 +8,7 @@
- [Add Git repositories from your code host](../repo/add.md)
- [Add user authentication providers (SSO)](../auth/index.md)
- [Configure search scopes](../../user/search/how-to/scopes.md)
- [Configure search scopes](../../code_search/how-to/scopes.md)
- [Integrate with Phabricator](../../integration/phabricator.md)
- [Add organizations](../organizations.md)
- [Set up HTTPS](../http_https_configuration.md)

View File

@ -32,7 +32,7 @@ Internal rate limiting can be configured to limit the rate at which requests are
If enabled, the default rate is set at 7200 per hour (2 per second) which can be configured via the `requestsPerHour` field (see below). If rate limiting is configured more than once for the same code host instance, the most restrictive limit will be used.
**NOTE** Internal rate limiting is only currently applied when synchronising [campaign](../../user/campaigns/index.md) changesets.
**NOTE** Internal rate limiting is only currently applied when synchronising [campaign](../../campaigns/index.md) changesets.
## Configuration

View File

@ -15,7 +15,7 @@ Also consider installing the [Sourcegraph Bitbucket Server plugin](../../integra
Sourcegraph requires a Bitbucket Server personal access token with **read** permissions to sync repositories.
When using [campaigns](../../user/campaigns/index.md) the access token needs **write** permissions on the project and repository level. See "[Code host interactions in campaigns](../../user/campaigns/explanations/permissions_in_campaigns.md#code-host-interactions-in-campaigns)" for details.
When using [campaigns](../../campaigns/index.md) the access token needs **write** permissions on the project and repository level. See "[Code host interactions in campaigns](../../campaigns/explanations/permissions_in_campaigns.md#code-host-interactions-in-campaigns)" for details.
You can create a personal access token at `https://[your-bitbucket-hostname]/plugins/servlet/access-tokens/add`. Also set the corresponding `username` field.
@ -34,7 +34,7 @@ There are four fields for configuring which repositories are mirrored:
The [Sourcegraph Bitbucket Server plugin](../../integration/bitbucket_server.md#sourcegraph-bitbucket-server-plugin) enables the Bitbucket Server instance to send webhooks to Sourcegraph.
Using webhooks is highly recommended when using [campaigns](../../user/campaigns/index.md), since they speed up the syncing of pull request data between Bitbucket Server and Sourcegraph and make it more efficient.
Using webhooks is highly recommended when using [campaigns](../../campaigns/index.md), since they speed up the syncing of pull request data between Bitbucket Server and Sourcegraph and make it more efficient.
To set up webhooks:
@ -53,7 +53,7 @@ To set up webhooks:
* **Secret**: The secret you configured in step 4
1. Confirm that the new webhook is listed under **All webhooks** with a timestamp in the **Last successful** column.
Done! Sourcegraph will now receive webhook events from Bitbucket Server and use them to sync pull request events, used by [campaigns](../../user/campaigns/index.md), faster and more efficiently.
Done! Sourcegraph will now receive webhook events from Bitbucket Server and use them to sync pull request events, used by [campaigns](../../campaigns/index.md), faster and more efficiently.
## Repository permissions
@ -88,7 +88,7 @@ Sourcegraph by default clones repositories from your Bitbucket Server via HTTP(S
## Repository labels
Sourcegraph will mark repositories as archived if they have the `archived` label on Bitbucket Server. You can exclude these repositories in search with `archived:no` [search syntax](../../user/search/reference/queries.md).
Sourcegraph will mark repositories as archived if they have the `archived` label on Bitbucket Server. You can exclude these repositories in search with `archived:no` [search syntax](../../code_search/reference/queries.md).
## Internal rate limits
@ -96,7 +96,7 @@ Internal rate limiting can be configured to limit the rate at which requests are
If enabled, the default rate is set at 28,800 per hour (8 per second) which can be configured via the `requestsPerHour` field (see below). If rate limiting is configured more than once for the same code host instance, the most restrictive limit will be used.
**NOTE** Internal rate limiting is only currently applied when synchronising [campaign](../../user/campaigns/index.md) changesets.
**NOTE** Internal rate limiting is only currently applied when synchronising [campaign](../../campaigns/index.md) changesets.
## Configuration

View File

@ -38,7 +38,7 @@ No token scopes are required if you only want to sync public repositories and do
- `repo` to sync private repositories from GitHub to Sourcegraph.
- `read:org` to use the `"allowOrgs"` setting [with a GitHub authentication provider](../auth/index.md#github).
- `repo`, `read:org`, and `read:discussion` to use [campaigns](../../user/campaigns/index.md) with GitHub repositories. See "[Code host interactions in campaigns](../../user/campaigns/explanations/permissions_in_campaigns.md#code-host-interactions-in-campaigns)" for details.
- `repo`, `read:org`, and `read:discussion` to use [campaigns](../../campaigns/index.md) with GitHub repositories. See "[Code host interactions in campaigns](../../campaigns/explanations/permissions_in_campaigns.md#code-host-interactions-in-campaigns)" for details.
>NOTE: If you plan to use repository permissions with background syncing, an access token that has admin access to all private repositories is required. It is because only admin can list all collaborators of a repository.
@ -52,7 +52,7 @@ Internal rate limiting can be configured to limit the rate at which requests are
If enabled, the default rate is set at 5000 per hour which can be configured via the `requestsPerHour` field (see below). If rate limiting is configured more than once for the same code host instance, the most restrictive limit will be used.
**NOTE** Internal rate limiting is only currently applied when synchronising [campaign](../../user/campaigns/index.md) changesets.
**NOTE** Internal rate limiting is only currently applied when synchronising [campaign](../../campaigns/index.md) changesets.
## Repository permissions
@ -74,7 +74,7 @@ The `webhooks` setting allows specifying the organization webhook secrets necess
]
```
Using webhooks is highly recommended when using [campaigns](../../user/campaigns/index.md), since they speed up the syncing of pull request data between GitHub and Sourcegraph and make it more efficient.
Using webhooks is highly recommended when using [campaigns](../../campaigns/index.md), since they speed up the syncing of pull request data between GitHub and Sourcegraph and make it more efficient.
To set up webhooks:
@ -99,7 +99,7 @@ To set up webhooks:
1. Click **Add webhook**.
1. Confirm that the new webhook is listed.
Done! Sourcegraph will now receive webhook events from GitHub and use them to sync pull request events, used by [campaigns](../../user/campaigns/index.md), faster and more efficiently.
Done! Sourcegraph will now receive webhook events from GitHub and use them to sync pull request events, used by [campaigns](../../campaigns/index.md), faster and more efficiently.
## Configuration

View File

@ -53,7 +53,7 @@ Internal rate limiting can be configured to limit the rate at which requests are
If enabled, the default rate is set at 36,000 per hour (10 per second) which can be configured via the `requestsPerHour` field (see below). If rate limiting is configured more than once for the same code host instance, the most restrictive limit will be used.
**NOTE** Internal rate limiting is only currently applied when synchronising [campaign](../../user/campaigns/index.md) changesets.
**NOTE** Internal rate limiting is only currently applied when synchronising [campaign](../../campaigns/index.md) changesets.
## Configuration
@ -97,7 +97,7 @@ We are actively collaborating with GitLab to improve our integration (e.g. the [
| [`GET /users/:id`](https://docs.gitlab.com/ee/api/users.html#single-user) | `read_user` or `api` | If using GitLab OAuth, used to fetch user metadata during the OAuth sign in process. |
| [`GET /projects/:id`](https://docs.gitlab.com/ee/api/projects.html#get-single-project) | `api` | (1) If using GitLab OAuth and repository permissions, used to determine if a user has access to a given _project_; (2) Used to query repository metadata (e.g. description) for display on Sourcegraph. |
| [`GET /projects/:id/repository/tree`](https://docs.gitlab.com/ee/api/repositories.html#list-repository-tree) | `api` | If using GitLab OAuth and repository permissions, used to verify a given user has access to the file contents of a repository within a project (i.e. does not merely have `Guest` permissions). |
| Campaigns requests | `api`, `read_repository`, `write_repository` | [Campaigns](../../user/campaigns/index.md) require write access to push commits and create, update and close merge requests on GitLab repositories. See "[Code host interactions in campaigns](../../user/campaigns/explanations/permissions_in_campaigns.md#code-host-interactions-in-campaigns)" for details. |
| Campaigns requests | `api`, `read_repository`, `write_repository` | [Campaigns](../../campaigns/index.md) require write access to push commits and create, update and close merge requests on GitLab repositories. See "[Code host interactions in campaigns](../../campaigns/explanations/permissions_in_campaigns.md#code-host-interactions-in-campaigns)" for details. |
## Webhooks
@ -109,7 +109,7 @@ The `webhooks` setting allows specifying the webhook secrets necessary to authen
]
```
Using webhooks is highly recommended when using [campaigns](../../user/campaigns/index.md), since they speed up the syncing of pull request data between GitLab and Sourcegraph and make it more efficient.
Using webhooks is highly recommended when using [campaigns](../../campaigns/index.md), since they speed up the syncing of pull request data between GitLab and Sourcegraph and make it more efficient.
To set up webhooks:
@ -126,4 +126,4 @@ To set up webhooks:
1. Click **Add webhook**.
1. Confirm that the new webhook is listed below **Project Hooks**.
Done! Sourcegraph will now receive webhook events from GitLab and use them to sync merge request events, used by [campaigns](../../user/campaigns/index.md), faster and more efficiently.
Done! Sourcegraph will now receive webhook events from GitLab and use them to sync merge request events, used by [campaigns](../../campaigns/index.md), faster and more efficiently.

View File

@ -31,7 +31,7 @@ Site administrators are the admins responsible for deploying, managing, and conf
## Features
- [Code intelligence and language servers](../user/code_intelligence/index.md)
- [Code intelligence and language servers](../code_intelligence/index.md)
- [Sourcegraph extensions and extension registry](extensions/index.md)
- [Search](search.md)
- [Federation](federation/index.md)

View File

@ -38,10 +38,10 @@ This list is not guaranteed to be complete, but rather representative of the typ
|[Repository permissions](../repo/permissions.md)|Yes||
|[Organizations](../organizations.md)|No||
|[User and org settings](../config/settings.md)|No|Global settings can be backed up as described above, but user- and org-level settings cannot.|
|[Saved searches](../../user/search/how-to/saved_searches.md)|No||
|[Saved searches](../../code_search/how-to/saved_searches.md)|No||
|User-generated access tokens|No||
|[Campaigns](../../user/campaigns/index.md)|No||
|[Precise code intelligence (LSIF) metadata](../../user/code_intelligence/explanations/precise_code_intelligence.md)|Yes (if manually regenerated)|This can be regenerated by re-running the LSIF indexing and upload process for affected repositories and revisions, but will not be regenerated by default.|
|[Campaigns](../../campaigns/index.md)|No||
|[Precise code intelligence (LSIF) metadata](../../code_intelligence/explanations/precise_code_intelligence.md)|Yes (if manually regenerated)|This can be regenerated by re-running the LSIF indexing and upload process for affected repositories and revisions, but will not be regenerated by default.|
|[User survey responses](../user_surveys.md)|No||
|[Usage statistics and event logs](../usage_statistics.md)|No|Event logs allow admins to track and audit usage, but are not necessary for Sourcegraph to work|
@ -55,7 +55,7 @@ This list is not guaranteed to be complete, but rather representative of the typ
|---|---|---|
|Repository (git) data|Yes||
|Search indexes|Yes||
|[Precise code intelligence (LSIF) data](../../user/code_intelligence/explanations/precise_code_intelligence.md)|No|This can be regenerated by re-running the LSIF indexing and upload process for affected repositories and revisions, but will not be regenerated by default.|
|[Precise code intelligence (LSIF) data](../../code_intelligence/explanations/precise_code_intelligence.md)|No|This can be regenerated by re-running the LSIF indexing and upload process for affected repositories and revisions, but will not be regenerated by default.|
|[Prometheus metrics](../observability/metrics.md)|No||
### Ephemeral data (Redis)

View File

@ -1,6 +1,6 @@
# Migrating from Oracle OpenGrok to Sourcegraph for code search
> NOTE: This guide helps Sourcegraph admins migrate from deploying Oracle OpenGrok to Sourcegraph. See our [Oracle OpenGrok end user migration guide](../../../user/search/how-to/opengrok.md) to learn how to switch from OpenGrok's search syntax to Sourcegraph's.
> NOTE: This guide helps Sourcegraph admins migrate from deploying Oracle OpenGrok to Sourcegraph. See our [Oracle OpenGrok end user migration guide](../../../code_search/how-to/opengrok.md) to learn how to switch from OpenGrok's search syntax to Sourcegraph's.
You can migrate from Oracle's [OpenGrok](https://oracle.github.io/opengrok/) to [Sourcegraph](https://about.sourcegraph.com) for code search by following the steps in this document.
@ -15,9 +15,9 @@ You can migrate from Oracle's [OpenGrok](https://oracle.github.io/opengrok/) to
Sourcegraph is a self-hosted code search and intelligence tool that helps developers find, review, understand, and debug code. Organizations that switch from OpenGrok to Sourcegraph typically cite the following reasons:
- Sourcegraph supports [searching any revision](../../user/search/explanations/features.md) (not just specific branches) and does not require waiting for periodic reindexing.
- Sourcegraph's [query syntax](../../user/search/reference/queries.md), user interface, and [integrations](../../integration/index.md) are superior and easier to use.
- Sourcegraph's [code intelligence](../../user/code_intelligence/index.md), has better language support (hover tooltips, definitions, references, implementations, etc.) and is based on the Language Server Protocol standard.
- Sourcegraph supports [searching any revision](../../code_search/explanations/features.md) (not just specific branches) and does not require waiting for periodic reindexing.
- Sourcegraph's [query syntax](../../code_search/reference/queries.md), user interface, and [integrations](../../integration/index.md) are superior and easier to use.
- Sourcegraph's [code intelligence](../../code_intelligence/index.md), has better language support (hover tooltips, definitions, references, implementations, etc.) and is based on the Language Server Protocol standard.
- The [Sourcegraph API](../../api/graphql/index.md) is more powerful, better documented, and easier to use than OpenGrok's API.
- Sourcegraph scales to more repositories/users and supports Kubernetes-based clustered/high-availability deployments better (with the [cluster deployment option](../install/kubernetes/index.md)).
@ -31,9 +31,9 @@ Every organization's needs are different. [Install and use Sourcegraph for free]
For more information about Sourcegraph, see:
- "[What is Sourcegraph?](../../user/index.md#what-is-sourcegraph)"
- "[Code search overview](../../user/search/index.md)"
- Live examples on public code: [Sourcegraph tour](../../user/tour.md)
- "[What is Sourcegraph?](../../getting-started/index.md#what-is-sourcegraph)"
- "[Code search overview](../../code_search/index.md)"
- Live examples on public code: [Sourcegraph tour](../../getting-started/tour.md)
## Migration guide
@ -105,10 +105,10 @@ After you've set Sourcegraph up, it's time to share it with your organization. S
>
> Post feedback at https://github.com/sourcegraph/sourcegraph [change if needed]
- Create an internal document based on the [Sourcegraph tour](../../user/tour.md), substituting links to and names of your organization's code. This explains how Sourcegraph helps developers perform common tasks better.
- Create an internal document based on the [Sourcegraph tour](../../getting-started/tour.md), substituting links to and names of your organization's code. This explains how Sourcegraph helps developers perform common tasks better.
- Encourage installation of the [browser extension](../../integration/browser_extension.md) to get Sourcegraph code intelligence and search in your organization's existing code host.
- Roll out the Chrome extension using [Google Workspace automatic installation](../../integration/google_workspace.md) to everyone in your organization.
- Check the access logs for OpenGrok to see what users search for. Try searching for the same things on Sourcegraph, and ensure that you get the expected results. (Note: Sourcegraph's [search query syntax](../../user/search/reference/queries.md) differs from OpenGrok's.)
- Check the access logs for OpenGrok to see what users search for. Try searching for the same things on Sourcegraph, and ensure that you get the expected results. (Note: Sourcegraph's [search query syntax](../../code_search/reference/queries.md) differs from OpenGrok's.)
- Monitor your Sourcegraph instance's site admin "Analytics" page to see who's using it. Ask them for specific feedback. Also seek feedback from the most frequent users of OpenGrok.
If there are any blockers preventing your organization from switching to Sourcegraph, we'd love to hear from you so we can address them.

View File

@ -21,4 +21,4 @@ You may also choose to disable automatic Git updates entirely and instead [confi
Sourcegraph uses a configurable internal rate limiter for API requests made from Sourcegraph to [GitHub](../external_service/github.md#internal-rate-limits), [GitLab](../external_service/gitlab.md#internal-rate-limits), [Bitucket Server](../external_service/bitbucket_server.md#internal-rate-limits) and [Bitbucket Cloud](../external_service/bitbucket_cloud.md#internal-rate-limits).
**NOTE** Internal rate limiting is currently only enforced for [campaign](../../user/campaigns/index.md) changeset syncing
**NOTE** Internal rate limiting is currently only enforced for [campaign](../../campaigns/index.md) changeset syncing

View File

@ -1,6 +1,6 @@
# Search configuration
See "[Code search overview](../user/search/index.md)" for general information about Sourcegraph's code search.
See "[Code search overview](../code_search/index.md)" for general information about Sourcegraph's code search.
## Indexed search

View File

@ -1,7 +1,7 @@
# Adopting Sourcegraph
- Why should my company use Sourcegraph?
- [Sourcegraph user features](../user/index.md)
- [Sourcegraph user features](../getting-started/index.md)
- [Code search product comparisons](https://about.sourcegraph.com/workflow#other-tools)
- [How to run a Sourcegraph trial](trial/index.md)
1. [Define success](trial/index.md#1-define-trial-success)

View File

@ -57,7 +57,7 @@ on:
A Sourcegraph search query that matches a set of repositories (and branches). Each matched repository branch is added to the list of repositories that the campaign will be run on.
See "[Code search](../search/index.md)" for more information on Sourcegraph search queries.
See "[Code search](../code_search/index.md)" for more information on Sourcegraph search queries.
### Examples

View File

Before

Width:  |  Height:  |  Size: 565 B

After

Width:  |  Height:  |  Size: 565 B

View File

Before

Width:  |  Height:  |  Size: 425 B

After

Width:  |  Height:  |  Size: 425 B

View File

@ -1,6 +1,6 @@
# Refactor Go code using Comby
This campaign uses Sourcegraph's [structural search](../../search/reference/structural.md) and [Comby](https://comby.dev/) to rewrite Go statements from
This campaign uses Sourcegraph's [structural search](../../code_search/reference/structural.md) and [Comby](https://comby.dev/) to rewrite Go statements from
```go
fmt.Sprintf("%d", number)

View File

@ -8,9 +8,9 @@ If you are interested in enabling precise code intelligence for your repository,
[Basic code intelligence](https://github.com/sourcegraph/sourcegraph-basic-code-intel) is able to provide 3 core code intelligence features:
- Jump to definition: it performs a [symbol search](../../search/explanations/features.md#symbol-search)
- Jump to definition: it performs a [symbol search](../../code_search/explanations/features.md#symbol-search)
- Hover documentation: it first finds the definition then extracts documentation from comments near the definition
- Find references: it performs a case-sensitive word-boundary cross-repository [plain text search](../../search/explanations/features.md#powerful-flexible-queries) for the given symbol
- Find references: it performs a case-sensitive word-boundary cross-repository [plain text search](../../code_search/explanations/features.md#powerful-flexible-queries) for the given symbol
Basic code intelligence also filters results by file extension and by imports at the top of the file for some languages.

View File

Before

Width:  |  Height:  |  Size: 871 KiB

After

Width:  |  Height:  |  Size: 871 KiB

View File

Before

Width:  |  Height:  |  Size: 271 KiB

After

Width:  |  Height:  |  Size: 271 KiB

View File

Before

Width:  |  Height:  |  Size: 138 KiB

After

Width:  |  Height:  |  Size: 138 KiB

View File

Before

Width:  |  Height:  |  Size: 495 B

After

Width:  |  Height:  |  Size: 495 B

View File

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 13 KiB

View File

Before

Width:  |  Height:  |  Size: 181 KiB

After

Width:  |  Height:  |  Size: 181 KiB

View File

Before

Width:  |  Height:  |  Size: 91 KiB

After

Width:  |  Height:  |  Size: 91 KiB

View File

Before

Width:  |  Height:  |  Size: 37 KiB

After

Width:  |  Height:  |  Size: 37 KiB

View File

Before

Width:  |  Height:  |  Size: 44 KiB

After

Width:  |  Height:  |  Size: 44 KiB

View File

Before

Width:  |  Height:  |  Size: 425 B

After

Width:  |  Height:  |  Size: 425 B

View File

Before

Width:  |  Height:  |  Size: 1.0 KiB

After

Width:  |  Height:  |  Size: 1.0 KiB

View File

Before

Width:  |  Height:  |  Size: 8.1 KiB

After

Width:  |  Height:  |  Size: 8.1 KiB

View File

Before

Width:  |  Height:  |  Size: 36 KiB

After

Width:  |  Height:  |  Size: 36 KiB

View File

Before

Width:  |  Height:  |  Size: 763 B

After

Width:  |  Height:  |  Size: 763 B

View File

Before

Width:  |  Height:  |  Size: 759 B

After

Width:  |  Height:  |  Size: 759 B

View File

Before

Width:  |  Height:  |  Size: 387 B

After

Width:  |  Height:  |  Size: 387 B

View File

Before

Width:  |  Height:  |  Size: 396 B

After

Width:  |  Height:  |  Size: 396 B

View File

Before

Width:  |  Height:  |  Size: 739 B

After

Width:  |  Height:  |  Size: 739 B

View File

Before

Width:  |  Height:  |  Size: 727 B

After

Width:  |  Height:  |  Size: 727 B

View File

Before

Width:  |  Height:  |  Size: 701 B

After

Width:  |  Height:  |  Size: 701 B

View File

Before

Width:  |  Height:  |  Size: 425 B

After

Width:  |  Height:  |  Size: 425 B

View File

@ -1,6 +1,6 @@
# Campaigns design doc
Why are [campaigns](../../../user/campaigns/index.md) designed the way they are?
Why are [campaigns](../../../campaigns/index.md) designed the way they are?
## Principles
@ -8,7 +8,7 @@ Why are [campaigns](../../../user/campaigns/index.md) designed the way they are?
- **Define a campaign in a file** (not some online API). The source of truth of a campaign's definition is a file that can be stored in version control, reviewed in code review, and re-applied by CI. This is in the same spirit as IaaC (infrastructure as code; e.g., storing your Terraform/Kubernetes/etc. files in Git). We prefer this approach over a (worse) alternative where you define a campaign in a UI with a bunch of text fields, checkboxes, buttons, etc., and need to write a custom API client to import/export the campaign definition.
- **Shareable and portable.** You can share your campaign specs, and it's easy for other people to use them. A campaign spec expresses an intent that's high-level enough to (usually) not be specific to your own particular repositories. You declare and inject configuration and secrets to customize it instead of hard-coding those values.
- **Large-scale.** You can run campaigns across 10,000s of repositories. It might take a while to compute and push everything, and the current implementation might cap out lower than that, but the fundamental design scales well.
- **Accommodates a variety of code hosts and review/merge processes.** Specifically, we don't to limit campaigns to only working for GitHub pull requests. (See [current support list](../../../user/campaigns/index.md#supported-code-hosts-and-changeset-types).)
- **Accommodates a variety of code hosts and review/merge processes.** Specifically, we don't to limit campaigns to only working for GitHub pull requests. (See [current support list](../../../campaigns/index.md#supported-code-hosts-and-changeset-types).)
## Comparison to other distributed systems
@ -106,7 +106,7 @@ changesetTemplate:
<td>The deployment controller (part of the Kubernetes cluster) consults the DeploymentSpec and continuously computes the desired state.</td>
<td>
<p>The <a href="https://github.com/sourcegraph/src-cli">Sourcegraph CLI</a> (running on your local machine, not on the Sourcegraph server) consults the campaign spec and computes the desired state when you invoke <code>src campaign apply</code>.</p>
<p><strong>Difference vs. Kubernetes:</strong> A campaign's desired state is computed locally, not on the server. It requires executing arbitrary commands, which is not yet supported by the Sourcegraph server. See campaigns known issue "<a href="../../../user/campaigns#server-execution">Campaign steps are run locally...</a>".</p>
<p><strong>Difference vs. Kubernetes:</strong> A campaign's desired state is computed locally, not on the server. It requires executing arbitrary commands, which is not yet supported by the Sourcegraph server. See campaigns known issue "<a href="../../../campaigns#server-execution">Campaign steps are run locally...</a>".</p>
</td>
</tr>
<tr>

View File

@ -5,7 +5,7 @@
Before diving into the technical part of campaigns, make sure to read up on what campaigns are, what they're not and what we want them to be.
1. Start by looking at the [campaigns description on about.sourcegraph.com](https://about.sourcegraph.com).
1. Read through the [campaigns documentation](../../../user/campaigns/index.md).
1. Read through the [campaigns documentation](../../../campaigns/index.md).
## [Campaigns design doc](campaigns_design.md)
@ -14,7 +14,7 @@ See "[Campaigns design doc](campaigns_design.md)".
## Starting up your environment
1. Run `./enterprise/dev/start.sh` and wait until all repositories are cloned.
1. Create [your first campaign](../../../user/campaigns/quickstart.md). **Remember:** If you create a campaign, you're opening real PRs on GitHub. Make sure only [testing repositories](#github-testing-account) are affected. If you create a large campaign, it takes a while to preview/create but also helps a lot with finding bugs/errors, etc.
1. Create [your first campaign](../../../campaigns/quickstart.md). **Remember:** If you create a campaign, you're opening real PRs on GitHub. Make sure only [testing repositories](#github-testing-account) are affected. If you create a large campaign, it takes a while to preview/create but also helps a lot with finding bugs/errors, etc.
## Glossary

View File

@ -4,7 +4,7 @@ Definition, reference, and hover providers are invoked from the extension host w
These providers receive the current text document (denoting a repository, commit, and path) and the position the user is hovering (a line and column offset within the file). The providers return results as an asynchronous iterator, which allows additional results to be streamed into the UI as they are received from the backend.
Code intelligence queries are resolved favoring [precise](http://localhost:5080/user/code_intelligence/explanations/precise_code_intelligence) code intelligence, if available, then falling back to [search-based](http://localhost:5080/user/code_intelligence/explanations/basic_code_intelligence).
Code intelligence queries are resolved favoring [precise](http://localhost:5080/code_intelligence/explanations/precise_code_intelligence) code intelligence, if available, then falling back to [search-based](http://localhost:5080/code_intelligence/explanations/basic_code_intelligence).
## Definitions

Some files were not shown because too many files have changed in this diff Show More