Skip to content
This repository was archived by the owner on Jun 21, 2023. It is now read-only.

Commit 03fc755

Browse files
authored
Simplifying how to login instructions
Making the images smaller so the text is more readable, adding the other signin options we have, and generally simplifying the instructions
1 parent 36e680e commit 03fc755

File tree

1 file changed

+34
-21
lines changed

1 file changed

+34
-21
lines changed

docs/getting-started/authenticating-to-github.md

Lines changed: 34 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,46 @@
11
# Authenticating to GitHub
22

3-
Add your GitHub.com or GitHub Enterprise account information to GitHub Desktop so you can access your repositories.
3+
## How to login to GitHub or GitHub Enterprise
4+
5+
- In Visual Studio, select **Team Explorer** from the **View** menu.
6+
<a href="images/view_team_explorer.png?raw=true" target="_blank"><div><img src="images/view_team_explorer.png" alt="Team Explorer in the view menu" width="500px"/></div></a>
7+
8+
- In the Team Explorer pane, click the **Manage Connectios** toolbar icon.
9+
<a href="images/manage_connections.png?raw=true" target="_blank"><div><img src="images/manage_connections.png" alt="Manage connections toolbar icon in the Team Explorer pane" width="500px"/></div></a>
10+
11+
- Click the **Connect** link in the GitHub section.
12+
<a href="images/sign-in-to-github-provider.png?raw=true" target="_blank"><div><img src="images/sign-in-to-github-provider.png" alt="Connect to GitHub" width="500px"/></div></a>
13+
14+
- If you're connected to a TFS instance, click on the **Sign in** link instead
15+
<a href="images/sign-in-to-github.png?raw=true" target="_blank"><div><img src="images/sign-in-to-github.png" alt="Sign in to GitHub" width="500px"/></div></a>
16+
17+
- If you are already connected to a GitHub instance and want to connect to another, this link will not be visible; instead click **Manage Connections** and then **Connect to GitHub**.
18+
<a href="images/connect_to_github.png?raw=true" target="_blank"><div><img src="images/connect_to_github.png" alt="Connect to GitHub in the manage connections dropdown in the Team Explorer pane" width="500px"/></div></a>
19+
20+
4. In the **Connect to GitHub dialog** choose **GitHub** or **GitHub Enterprise**, depending on which product you're using.
21+
22+
**GitHub option**:
23+
<a href="images/connect-to-github-dialog.png?raw=true" target="_blank"><div><img src="images/connect-to-github-dialog.png" alt="Connect to GitHub dialog view" height="400px"/></div></a>
24+
25+
- To sign in with credentials, enter either username or email and password.
26+
- To sign in with SSO, select `Sign in with your browser`.
27+
28+
**GitHub Enterprise option**:
29+
<a href="images/connect-to-github-enterprise-dialog.png?raw=true" target="_blank"><div><img src="images/connect-to-github-enterprise-dialog.png" alt="Connect to GitHub Enterprise dialog view" height="400px"/></div></a>
30+
31+
- To sign in with SSO, enter the GitHub Enterprise server address and select `Sign in with your browser`.
32+
- To sign in with credentials, enter the GitHub Enterprise server address.
33+
- If a `Password` field appears, enter your password.
34+
- If a `Token` field appears, enter a valid token. You can create personal access tokens by [following the instructions in the section below](#personal_access_tokens).
435

536
Before you authenticate, you must already have a GitHub or GitHub Enterprise account.
637

738
- For more information on creating a GitHub account, see "[Signing up for a new GitHub account](https://help.github.com/articles/signing-up-for-a-new-github-account/)".
839
- For a GitHub Enterprise account, contact your GitHub Enterprise site administrator.
940

10-
**Note:** If your organization is on the [Business plan](https://help.github.com/articles/organization-billing-plans) and has not enabled SAML single sign-on or login with username and password, you must create and authorize a personal access token to access protected content. In addition, SAML single sign-on is not available for GitHub enterprise versions less than 2.12.2.
41+
### Personal access tokens
1142

12-
### Scopes for personal access tokens
43+
If all signin options above fail, you can manually create a personal access token and use it as your password.
1344

1445
The scopes for the personal access token are: `user`, `repo`, `gist`, and `write:public_key`.
1546
- *user* scope: Grants access to the user profile data. We currently use this to display your avatar and check whether your plans lets you publish private repositories.
@@ -20,21 +51,3 @@ The scopes for the personal access token are: `user`, `repo`, `gist`, and `write
2051
For more information on creating personal access tokens, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line).
2152

2253
For more information on authenticating with SAML single sign-on, see "[About authentication with SAML single sign-on](https://help.github.com/articles/about-authentication-with-saml-single-sign-on)."
23-
24-
1. In Visual Studio, select **Team Explorer** from the **View** menu.
25-
![Team Explorer in the view menu](images/view_team_explorer.png)
26-
2. In the Team Explorer pane, click the **Manage Connections** toolbar button.
27-
![Manage connections toolbar button in the Team Explorer pane](images/manage_connections.png)
28-
3. Click the **Connect** link in the GitHub section. If you are already connected to a GitHub instance and want to connect to another, this link will not be visible; instead click **Manage Connections** and then **Connect to GitHub**.
29-
![Connect to GitHub in the manage connections dropdown in the Team Explorer pane](images/connect_to_github.png)
30-
4. In the **Connect to GitHub dialog** choose **GitHub** or **GitHub Enterprise**, depending on which product you're using.
31-
32-
**GitHub option**:
33-
![Connect to GitHub dialog view](images/connect-to-github-dialog.png)
34-
- To sign in with credentials, enter either username or email and password.
35-
- To sign in with SSO, select `Sign in with your browser`.
36-
37-
**GitHub Enterprise option**:
38-
![Connect to GitHub Enterprise dialog view](images/connect-to-github-enterprise-dialog.png)
39-
- To sign in with credentials, first enter GitHub Enterprise server address. Once a valid server address is entered, a `Token` field appears and a valid token can be entered to sign in.
40-
- To sign in with SSO, first enter the GitHub Enterprise server address. Once a valid server address is entered, select `Sign in with your browser`. Follow the steps to authenticate with your SSO provider.

0 commit comments

Comments
 (0)