summaryrefslogtreecommitdiff
path: root/doc/integration
diff options
context:
space:
mode:
authorMarcia Ramos <virtua.creative@gmail.com>2018-11-27 16:46:02 +0000
committerMarcia Ramos <virtua.creative@gmail.com>2018-11-27 16:46:02 +0000
commit17acf40dc98f05a476176dbd0b5da813be39b909 (patch)
treeaa2bed8322c7606358f4e0cad10a229150946836 /doc/integration
parent8a6c2c97dfd51d619f884f658a115ef148ee490d (diff)
parent5883c4c4b284e71c61f9a9a85d1b9185101cb7fa (diff)
downloadgitlab-ce-17acf40dc98f05a476176dbd0b5da813be39b909.tar.gz
Merge branch '53248-docs-update-integrate-your-server-with-github-docs' into 'master'
Update GitHub integration docs to mainly follow GitHub updates. Closes #53248 See merge request gitlab-org/gitlab-ce!22643
Diffstat (limited to 'doc/integration')
-rw-r--r--doc/integration/github.md34
-rw-r--r--doc/integration/img/github_app.pngbin29330 -> 128040 bytes
-rw-r--r--doc/integration/img/github_app_entry.pngbin0 -> 83603 bytes
-rw-r--r--doc/integration/img/github_register_app.pngbin0 -> 120981 bytes
4 files changed, 19 insertions, 15 deletions
diff --git a/doc/integration/github.md b/doc/integration/github.md
index 7a83b8e4b35..b8156b2b593 100644
--- a/doc/integration/github.md
+++ b/doc/integration/github.md
@@ -1,28 +1,32 @@
-# Integrate your server with GitHub
+# Integrate your GitLab instance with GitHub
-Import projects from GitHub and login to your GitLab instance with your GitHub account.
+You can integrate your GitLab instance with GitHub.com as well as GitHub Enterprise to enable users to import projects from GitHub and/or to login to your GitLab instance with your GitHub account.
-To enable the GitHub OmniAuth provider you must register your application with GitHub.
-GitHub will generate an application ID and secret key for you to use.
+## Enabling GitHub OAuth
-1. Sign in to GitHub.
+To enable GitHub OmniAuth provider, you must use GitHub's credentials for your GitLab instance.
+To get the credentials (a pair of Client ID and Client Secret), you must register an application as an OAuth App on GitHub.
-1. Navigate to your individual user settings or an organization's settings, depending on how you want the application registered. It does not matter if the application is registered as an individual or an organization - that is entirely up to you.
+1. Sign in to GitHub.
-1. Select "OAuth applications" in the left menu.
+1. Navigate to your individual user or organization settings, depending on how you want the application registered. It does not matter if the application is registered as an individual or an organization - that is entirely up to you.
-1. If you already have applications listed, switch to the "Developer applications" tab.
+ - For individual accounts, select **Developer settings** from the left menu, then select **OAuth Apps**.
+ - For organization accounts, directly select **OAuth Apps** from the left menu.
-1. Select "Register new application".
+1. Select **Register an application** (if you don't have any OAuth App) or **New OAuth App** (if you already have OAuth Apps).
+ ![Register OAuth App](img/github_app_entry.png)
1. Provide the required details.
- Application name: This can be anything. Consider something like `<Organization>'s GitLab` or `<Your Name>'s GitLab` or something else descriptive.
- - Homepage URL: The URL to your GitLab installation. 'https://gitlab.company.com'
+ - Homepage URL: the URL to your GitLab installation. e.g., `https://gitlab.company.com`
- Application description: Fill this in if you wish.
- - Authorization callback URL is 'http(s)://${YOUR_DOMAIN}'. Please make sure the port is included if your GitLab instance is not configured on default port.
-1. Select "Register application".
+ - Authorization callback URL: `http(s)://${YOUR_DOMAIN}`. Please make sure the port is included if your GitLab instance is not configured on default port.
+ ![Register OAuth App](img/github_register_app.png)
+
+1. Select **Register application**.
-1. You should now see a Client ID and Client Secret near the top right of the page (see screenshot).
+1. You should now see a pair of **Client ID** and **Client Secret** near the top right of the page (see screenshot).
Keep this page open as you continue configuration.
![GitHub app](img/github_app.png)
@@ -97,9 +101,9 @@ GitHub will generate an application ID and secret key for you to use.
__Replace `https://github.example.com/` with your GitHub URL.__
-1. Change 'YOUR_APP_ID' to the client ID from the GitHub application page from step 7.
+1. Change `YOUR_APP_ID` to the Client ID from the GitHub application page from step 6.
-1. Change 'YOUR_APP_SECRET' to the client secret from the GitHub application page from step 7.
+1. Change `YOUR_APP_SECRET` to the Client Secret from the GitHub application page from step 6.
1. Save the configuration file.
diff --git a/doc/integration/img/github_app.png b/doc/integration/img/github_app.png
index d6c289a1de1..4a1523d41ac 100644
--- a/doc/integration/img/github_app.png
+++ b/doc/integration/img/github_app.png
Binary files differ
diff --git a/doc/integration/img/github_app_entry.png b/doc/integration/img/github_app_entry.png
new file mode 100644
index 00000000000..9e151f8cdff
--- /dev/null
+++ b/doc/integration/img/github_app_entry.png
Binary files differ
diff --git a/doc/integration/img/github_register_app.png b/doc/integration/img/github_register_app.png
new file mode 100644
index 00000000000..edd3f660f4e
--- /dev/null
+++ b/doc/integration/img/github_register_app.png
Binary files differ