artin/sourcegraph
1
0
Fork 0
mirror of https://github.com/sourcegraph/sourcegraph.git synced 2026-02-06 19:21:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs/admin: update steps of adding repositories (#8293)

Browse Source 
* docs/admin: update steps of adding repositories

* Address feedback
This commit is contained in:
ᴜɴᴋɴᴡᴏɴ 2020-02-07 14:39:02 +08:00 committed by GitHub
parent f0901a3a08
commit a249d9f4ae
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 40 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/admin/external_service/aws_codecommit.md
View File

@ -2,15 +2,12 @@
Site admins can sync Git repositories hosted on [AWS CodeCommit](https://aws.amazon.com/codecommit/) with Sourcegraph so that users can search and navigate the repositories.
To set this up, add AWS CodeCommit as an external service to Sourcegraph:
To connect AWS CodeCommit to Sourcegraph:
1. Go to **User menu > Site admin**.
1. Open the **External services** page.
1. Press **+ Add external service**.
1. Enter a **Display name** (using "AWS CodeCommit" is OK if you only have one AWS CodeCommit connection).
1. In the **Kind** menu, select **AWS CodeCommit**.
1. Configure the connection to AWS CodeCommit in the JSON editor. Use Cmd/Ctrl+Space for completion, and [see configuration documentation below](aws_codecommit.md#configuration).
1. Press **Add external service**.
1. Go to **Site admin > Manage repositories > Add repositories**
1. Select **AWS CodeCommit repositories**.
1. Configure the connection to AWS CodeCommit using the action buttons above the text field, and additional fields can be added using <kbd>Cmd/Ctrl+Space</kbd> for auto-completion. See the [configuration documentation below](#configuration).
1. Press **Add repositories**.
## AWS CodeCommit Git credentials

13
doc/admin/external_service/bitbucket_cloud.md
View File

@ -2,15 +2,12 @@
Site admins can sync Git repositories hosted on [Bitbucket Cloud](https://bitbucket.org) with Sourcegraph so that users can search and navigate the repositories.
To set this up, add Bitbucket Cloud as an external service to Sourcegraph:
To connect Bitbucket Cloud to Sourcegraph:
1. Go to **User menu > Site admin**.
1. Open the **External services** page.
1. Press **+ Add external service**.
1. In the list, select **Bitbucket.org repositories**.
1. Enter a **Display name** (using "Bitbucket Cloud" is OK).
1. Configure the connection to Bitbucket Cloud in the JSON editor. Use Cmd/Ctrl+Space for completion, and [see configuration documentation below](#configuration).
1. Press **Add external service**.
1. Go to **Site admin > Manage repositories > Add repositories**
1. Select **Bitbucket.org**.
1. Configure the connection to Bitbucket Cloud using the action buttons above the text field, and additional fields can be added using <kbd>Cmd/Ctrl+Space</kbd> for auto-completion. See the [configuration documentation below](#configuration).
1. Press **Add repositories**.
## Repository syncing

13
doc/admin/external_service/bitbucket_server.md
View File

@ -2,15 +2,12 @@
Site admins can sync Git repositories hosted on [Bitbucket Server](https://www.atlassian.com/software/bitbucket/server) (and the [Bitbucket Data Center](https://www.atlassian.com/enterprise/data-center/bitbucket) deployment option) with Sourcegraph so that users can search and navigate the repositories.
To set this up, add Bitbucket Server as an external service to Sourcegraph:
To connect Bitbucket Server to Sourcegraph:
1. Go to **User menu > Site admin**.
1. Open the **External services** page.
1. Press **+ Add external service**.
1. Enter a **Display name** (using "Bitbucket Server" is OK if you only have one Bitbucket Server instance).
1. In the **Kind** menu, select **Bitbucket Server**.
1. Configure the connection to Bitbucket Server in the JSON editor. Use Cmd/Ctrl+Space for completion, and [see configuration documentation below](#configuration).
1. Press **Add external service**.
1. Go to **Site admin > Manage repositories > Add repositories**
1. Select **Bitbucket Server**.
1. Configure the connection to Bitbucket Server using the action buttons above the text field, and additional fields can be added using <kbd>Cmd/Ctrl+Space</kbd> for auto-completion. See the [configuration documentation below](#configuration).
1. Press **Add repositories**.
## Repository syncing

13
doc/admin/external_service/github.md
View File

@ -2,15 +2,12 @@
Site admins can sync Git repositories hosted on [GitHub.com](https://github.com) and [GitHub Enterprise](https://enterprise.github.com) with Sourcegraph so that users can search and navigate the repositories.
To set this up, add GitHub as an external service to Sourcegraph:
To connect GitHub to Sourcegraph:
1. Go to **User menu > Site admin**.
1. Open the **External services** page.
1. Press **+ Add external service**.
1. Enter a **Display name** (using "GitHub" is OK if you only have one GitHub instance).
1. In the **Kind** menu, select **GitHub**.
1. Configure the connection to GitHub in the JSON editor. Use Cmd/Ctrl+Space for completion, and [see configuration documentation below](#configuration).
1. Press **Add external service**.
1. Go to **Site admin > Manage repositories > Add repositories**
1. Select **GitHub**.
1. Configure the connection to GitHub using the action buttons above the text field, and additional fields can be added using <kbd>Cmd/Ctrl+Space</kbd> for auto-completion. See the [configuration documentation below](#configuration).
1. Press **Add repositories**.
## Supported versions

13
doc/admin/external_service/gitlab.md
View File

@ -2,15 +2,12 @@
Site admins can sync Git repositories hosted on [GitLab](https://gitlab.com) (GitLab.com and GitLab CE/EE) with Sourcegraph so that users can search and navigate the repositories.
To set this up, add GitLab as an external service to Sourcegraph:
To connect GitLab to Sourcegraph:
1. Go to **User menu > Site admin**.
1. Open the **External services** page.
1. Press **+ Add external service**.
1. Enter a **Display name** (using "GitLab" is OK if you only have one GitLab instance).
1. In the **Kind** menu, select **GitLab**.
1. Configure the connection to GitLab in the JSON editor. Use Cmd/Ctrl+Space for completion, and [see configuration documentation below](#configuration).
1. Press **Add external service**.
1. Go to **Site admin > Manage repositories > Add repositories**
1. Select **GitLab**.
1. Configure the connection to GitLab using the action buttons above the text field, and additional fields can be added using <kbd>Cmd/Ctrl+Space</kbd> for auto-completion. See the [configuration documentation below](#configuration).
1. Press **Add repositories**.
## Supported versions

13
doc/admin/external_service/gitolite.md
View File

@ -2,16 +2,13 @@
Site admins can link and sync Git repositories on [Gitolite](https://gitolite.com) with Sourcegraph so that users can search and navigate the repositories.
To set this up, add Gitolite as an external service to Sourcegraph:
To connect Gitolite to Sourcegraph:
1. Set up [git SSH authentication](../repo/auth.md) for your gitolite server.
1. Go to **User menu > Site admin**.
1. Open the **External services** page.
1. Press **+ Add external service**.
1. Enter a **Display name** (using "Gitolite" is OK if you only have one Gitolite instance).
1. In the **Kind** menu, select **Gitolite**.
1. Configure the connection to Gitolite in the JSON editor. Use Cmd/Ctrl+Space for completion, and [see configuration documentation below](#configuration).
1. Press **Add external service**.
1. Go to **Site admin > Manage repositories > Add repositories**
1. Select **Gitolite**.
1. Configure the connection to Gitolite using the action buttons above the text field, and additional fields can be added using <kbd>Cmd/Ctrl+Space</kbd> for auto-completion. See the [configuration documentation below](#configuration).
1. Press **Add repositories**.
## Configuration

13
doc/admin/external_service/other.md
View File

@ -2,15 +2,12 @@
Site admins can sync Git repositories on any Git repository host (by Git clone URL) with Sourcegraph so that users can search and navigate the repositories. Use this method only when your repository host is not named as a supported [external service](index.md).
To add Git repositories from any Git repository host:
To connect generic Git host to Sourcegraph:
1. Go to **User menu > Site admin**.
1. Open the **External services** page.
1. Press **+ Add external service**.
1. Press **Single Git repositories**.
1. Enter a **Display name** (such as the human-readable name of the repository host).
1. Set the `url` and `repos` fields in the JSON editor. Use Cmd/Ctrl+Space for completion, and [see configuration documentation below](#configuration).
1. Press **Add external service**.
1. Go to **Site admin > Manage repositories > Add repositories**
1. Select **Generic Git host**.
1. Configure the connection to generic Git host the action buttons above the text field, and additional fields can be added using <kbd>Cmd/Ctrl+Space</kbd> for auto-completion. See the [configuration documentation below](#configuration).
1. Press **Add repositories**.
## Constructing the `url` for SSH access

13
doc/admin/external_service/phabricator.md
View File

@ -4,15 +4,12 @@ Site admins can associate Git repositories on [Phabricator](https://phabricator.
> NOTE: Sourcegraph does not support mirroring Phabricator repositories (as it does for repositories on other code hosts).
To set this up, add Phabricator as an external service to Sourcegraph:
To connect Phabricator to Sourcegraph:
1. Go to **User menu > Site admin**.
1. Open the **External services** page.
1. Press **+ Add external service**.
1. Enter a **Display name** (using "Phabricator" is OK if you only have one Phabricator instance).
1. In the **Kind** menu, select **Phabricator**.
1. Configure the connection to Phabricator in the JSON editor. Use Cmd/Ctrl+Space for completion, and [see configuration documentation below](#configuration).
1. Press **Add external service**.
1. Go to **Site admin > Manage repositories > Add repositories**
1. Select **Phabricator**.
1. Configure the connection to Phabricator using the action buttons above the text field, and additional fields can be added using <kbd>Cmd/Ctrl+Space</kbd> for auto-completion. See the [configuration documentation below](#configuration).
1. Press **Add repositories**.
## Repository association