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

Documentation updates #1943

Merged
merged 20 commits into from
Oct 1, 2018
Merged

Documentation updates #1943

merged 20 commits into from
Oct 1, 2018

Conversation

meaghanlewis
Copy link
Contributor

@meaghanlewis meaghanlewis commented Sep 20, 2018

This PR updates some outdated documentation with new images and descriptions of features that have changed.

structure change:

  • change contributing/ to using/ because all the documentation here describes how to use features

docs changes:

@meaghanlewis meaghanlewis changed the title WIP: Documentation updates Documentation updates Sep 25, 2018
Copy link
Contributor

@grokys grokys left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Much better! Just a few suggestions.


![List of GitHub repositories that can be cloned inside a dialog](images/clone-dialog.png)

5. If desired, change the local path where the repository will be cloned into, or leave the default as-is. Click **Clone**.
6. In Team Explorer, under the list of repositories, locate the repository and double-click to open the project in Visual Studio.
In addition to using the list of repositories, you can use the URL tab to clone a repository by it's URL or using the repository owner and name.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"by it's URL" -> "by its URL"


![List of GitHub repositories that can be cloned inside a dialog](images/clone-url-dialog.png)

5. If desired, change the local path where the repository will be cloned into, or leave the default as-is.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"where the repository will be cloned into" doesn't sound right to me. Maybe "change the local path that the repository will be cloned into"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. I think that works better here.

Existing comments left by you or other reviewers will also show up in this margin. Click the icon to open an inline conversation view from which you can review and reply to comments:
To just comment on this one line, select **Add a single comment**. This will add the comment immediately.

To start a review of the Pull Request and all it's changes, select **Start a review**. This will add this comment as pending, and the comment will be submitted once the review is complete.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"it's" -> "its"

![Pull requests status dropdown filter](images/pull-request-list-filter.png)
6. Filter pull requests by assignable user by clicking the person symbol and selecting the user you want to view from the dropdown. You can also search for users from the dropdown.
![Pull requests assignable user dropdown filter](images/pull-request-assignable-user.png)
7. Click on a pull request title to [view the pull request details and review the pull request](reviewing-a-pull-request-in-visual-studio.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You actually need to double-click (anywhere on the PR item) now, rather than click on the title.

@@ -0,0 +1,26 @@
# Creating gists

GitHub for Visual Studio enables easy creation of gists directly from the Visual Studio Editor.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "easy" here doesn't sound quite right to me. Maybe remove the "easy" or change to "With GitHub for Visual Studio you can easily create gists directly from the editor" or something?

grokys and others added 2 commits September 27, 2018 11:59
- Add `collaborator` repositories to the types that appear in the list
- Mention that the URL tab can be used to clone a public repositories
- The user now needs to double-click on a solution not a repository

![Location of the manage connections toolbar button in Team Explorer](images/manage-connections.png)

3. Next to the account you want to clone from, click **Clone**.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alternatively user can click the GitHub button on the Start Page (Visual Studio 2017) or the File > Open > Open From GitHub... button (when #1919 lands).

![Pull requests in the GitHub pane](images/pull-request-list-view.png)
5. Change the pull requests listed by clicking the **Open** link and selecting the filter you want to use from the dropdown with the options *Open/Closed/All*.
![Pull requests status dropdown filter](images/pull-request-list-filter.png)
6. Filter pull requests by assignable user by clicking the person symbol and selecting the user you want to view from the dropdown. You can also search for users from the dropdown.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is filter by Owner rather than Assignable user. IIRC the list is populated by assignable users, but the filter is by owner. Assignable users was used because there isn't a handy list of all PR owners for a repository. Maybe @grokys can chip in here?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yes, this filter is for Author (there's technically no such thing as a PR owner). Good catch!

Copy link
Collaborator

@jcansdale jcansdale left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good. 👍

@meaghanlewis meaghanlewis merged commit 1f239cd into master Oct 1, 2018
@meaghanlewis meaghanlewis deleted the docs-changes branch October 1, 2018 14:19
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants