Adding a "How to Authenticate" document #827
Conversation
|
|
||
| <img src="images/github-authenticate.png" alt="GitHub menu item in the Window menu" width="350px"/> | ||
|
|
||
| If your account requires Two Factor Authencation. You will be prompted for your auth code. |
There was a problem hiding this comment.
Authentication is mispelled, and if the phrase starts with an If, then it should have a comma, not a period.
|
|
||
| <img src="images/github-two-factor.png" alt="GitHub menu item in the Window menu" width="350px"/> | ||
|
|
||
| Before you authenticate, you must already have a GitHub account. |
There was a problem hiding this comment.
This sounds a bit forceful. Perhaps "You will need to create a GitHub account before you can sign in, if you don't have one already"?
There was a problem hiding this comment.
Sure. I copied a lot of content from the Visual Studio docs.
| @@ -0,0 +1,35 @@ | |||
| # Authenticating to GitHub | |||
|
|
|||
| ## How to login to GitHub | |||
There was a problem hiding this comment.
The action is sign in, so all our docs should use the same action name and not mix login and sign in
|
|
||
| ## How to login to GitHub | ||
|
|
||
| 1. In Unity find the **GitHub** window. If you can't find it, you can switch to it by choosing **GitHub** from the **Window** menu. |
There was a problem hiding this comment.
This is not as straightforward as it could be. Just saying "Open the GitHub window by going to the top level Window menu and selecting GitHub, as shown below" might work better.
|
|
||
| ### Personal access tokens | ||
|
|
||
| If all signin options above fail, you can manually create a personal access token and use it as your password. |
There was a problem hiding this comment.
There's only one sign in option available, so "if all signin options above fail" is misleading.
|
|
||
| The scopes for the personal access token are: `user`, `repo`. | ||
| - *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. | ||
| - *repo* scope: Grants read/write access to code, commit statuses, invitations, collaborators, adding team memberships, and deployment statuses for public and private repositories and organizations. This is needed for all git network operations (push, pull, fetch), and for getting information about the repository you're currently working on. |
There was a problem hiding this comment.
We should note that some versions ask for gist and write:public_key, because that's what the asset store version asks for and we haven't shipped any releases that don't
No description provided.