Merge pull request #953 from github/fixes/952-image-descriptions

shana · web-flow · commit 9575950b9a14 · 2017-04-19T18:31:12.000+02:00
Add descriptions to documentation images
diff --git a/README.md b/README.md
@@ -9,6 +9,9 @@ Official builds of this extension are available at [the official website](https:
 
 [![Join the chat at freenode:github-vs](https://img.shields.io/badge/irc-freenode:%20%23github--vs-blue.svg)](http://webchat.freenode.net/?channels=%23github-vs) [![Join the chat at https://gitter.im/github/VisualStudio](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/github/VisualStudio?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
+## Documentation
+Visit the [documentation](https://github.com/github/VisualStudio/tree/master/docs) for details on how to use the features in the GitHub Extension for Visual Studio.
+
 ## Installing beta versions
 
 Older and pre-release/beta/untested versions are available at [the releases page](https://github.com/github/VisualStudio/releases), and also via a custom gallery feed for Visual Studio.
@@ -83,7 +86,6 @@ build.cmd
 Note, attempting to install `IsExperimental=false` builds of the VSIX is not recommended.
 
 ## More information
-
 - Andreia Gaita's [presentation](https://www.youtube.com/watch?v=hz2hCO8e_8w) at Codemania 2016 about this extension.
 
 ## Contributing
diff --git a/docs/contributing/cloning-a-repository-to-visual-studio.md b/docs/contributing/cloning-a-repository-to-visual-studio.md
@@ -5,15 +5,15 @@ After you provide your GitHub or GitHub Enterprise credentials to GitHub for Vis
 1. Open **Team Explorer** by clicking on its tab next to *Solution Explorer*, or via the *View* menu.
 2. Click the **Manage Connections** toolbar button.
 
-![image](images/manage-connections.png)
+![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**.
 
-![image](images/clone-link.png)
+![Clone button in the GitHub section of Team Explorer](images/clone-link.png)
 
 4. In the list of repositories, click the repository you'd like to clone.
 
-![image](images/clone-dialog.png)
+![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.
diff --git a/docs/contributing/creating-a-pull-request.md b/docs/contributing/creating-a-pull-request.md
@@ -2,9 +2,9 @@
 
 1. Open a solution in a GitHub repository.
 2. Open **Team Explorer** and click the **Pull Requests** button to open the **GitHub** pane.
-![Pull Requests](images/pull-requests-button2.png)
+![Location of the pull requests button in the Team Explorer pane](images/pull-requests-button2.png)
 3. Click the **Create New** link above the list of pull requests for the repository.
 4. Select the target branch by clicking the link. If the current repository is a fork, then there will be two sets of branches in the dropdown - to submit a pull request upstream then select a branch with the `owner:` prefix of the upstream repository.
-![](images/pr-create.png)
+![The pull request creation form in the GitHub pane](images/pr-create.png)
 5. Enter a pull request title and an optional description.
 6. Click the **Create Pull Request** button.
diff --git a/docs/contributing/creating-an-empty-repository-from-visual-studio.md b/docs/contributing/creating-an-empty-repository-from-visual-studio.md
@@ -6,15 +6,15 @@
 
 3. Click the **Manage Connections** toolbar button.
 
-   ![image](images/manage-connections.png)
+   ![The manage connections toolbar button in Team Explorer](images/manage-connections.png)
 
 4. Click the **Create** link next to the account you want to create the repository in.
 
-   ![image](images/create-link.png)
+   ![The create link in the Team Explorer pane](images/create-link.png)
 
 5. In the **Create a GitHub Repository** dialog, enter a name, description and local path for the repository.
 
-   ![image](images/create-dialog.png)
+    ![The create a GitHub repository dialog](images/create-dialog.png)
 
 6. Select a license for the repository.
 
@@ -24,4 +24,4 @@
 
 9. When the repository is created, click the **Create a new Project or Solution** link in Team Explorer to create a project or solution in the repository.
 
-![image](images/successful-creation-message.png)
+    ![Successful repository creation message at the top of the Team Explorer pane](images/successful-creation-message.png)
diff --git a/docs/contributing/creating-gists.md b/docs/contributing/creating-gists.md
@@ -10,11 +10,11 @@ GitHub for Visual Studio enables easy creation of gists directly from the Visual
 
 4. Right click and select **Create a GitHub Gist** from the **GitHub** submenu.
 
-   ![image](images/create-gist-menu.png)
+   ![Location of Create A GitHub Gist in the GitHub submenu](images/create-gist-menu.png)
 
 5. In the **Create a GitHub Gist** dialog, check that the filename is correct and optionally add a description.
 
-   ![image](images/create-gist-dialog.png)
+   ![GitHub Gist creation dialog window](images/create-gist-dialog.png)
 
 6. If you want the gist to be private, check the **Private Gist** checkbox.
 
diff --git a/docs/contributing/making-changes-to-a-pull-request.md b/docs/contributing/making-changes-to-a-pull-request.md
@@ -6,7 +6,7 @@ When a topic branch is [checked out](review-a-pull-request-in-visual-studio.md),
 
 If a Pull Request is checked out and the author adds new commits to the branch, then the option will be given to pull the changes locally. This works both for pull requests from the same repository and from a fork.
 
-![](images/pr-pull-changes.png)
+![Pulling changes by clicking the pull link button](images/pr-pull-changes.png)
 
 ## Pushing changes
 
diff --git a/docs/contributing/publishing-an-existing-project-to-github.md b/docs/contributing/publishing-an-existing-project-to-github.md
@@ -2,13 +2,13 @@
 
 1. Open a solution in Visual Studio.
 2. If solution is not already initialized as a Git repository, select **Add to Source Control** from the **File** menu.
-![Add to Source Control](images/add-to-source-control.png)
+![Location of Add to Source Control option in the file menu](images/add-to-source-control.png)
 3. Open **Team Explorer**.
-![Open Team Explorer](images/open-team-explorer.png)
+![Location of Team Explorer option in the view menu](images/open-team-explorer.png)
 4. In Team Explorer, click **Sync**.
-![Sync](images/team-explorer-sync.png)
+![Location of the sync button in the Team Explorer pane](images/team-explorer-sync.png)
 5. Click the **Publish to GitHub** button.
-![Publish to GitHub](images/publish-to-github.png)
+![Location of the Publish to GitHub button in the Team Explorer pane](images/publish-to-github.png)
 6. Enter a name and description for the repository on GitHub.
 7. Check the **Private Repository** box if you want to upload the repository as a private repository on GitHub. You must have a [Developer, Team or Business account](https://github.com/pricing) to create private repositories.
 8. Click the **Publish** button.
diff --git a/docs/contributing/reviewing-a-pull-request-in-visual-studio.md b/docs/contributing/reviewing-a-pull-request-in-visual-studio.md
@@ -6,21 +6,21 @@ GitHub for Visual Studio provides facilities for reviewing a pull request direct
 
 2. Open **Team Explorer** and click the **Pull Requests** button to open the **GitHub** pane.
 
-   ![image](images/pull-requests-button.png)
+   ![Pull Requests button in the Team Explorer pane](images/pull-requests-button.png)
 
 3. Click the title of the pull request to be reviewed.
 
 ## Viewing a pull request
 
 The Pull Request Details view shows the current state of the pull request, including information about who created the pull request, the source and target branch, and the files changed.
 
-![image](images/pr-details.png)
+![The details of a single pull request in the GitHub pane](images/pr-details.png)
 
 ## Checking out a pull request
 
 To check out the pull request branch, click the **Checkout [branch]** link where [branch] is the name of the branch that will be checked out.
 
-![image](images/pr-details-checkout-link.png)
+![Location of the checkout link in the GitHub pull request details page](images/pr-details-checkout-link.png)
 
 If the pull request is from a fork then a remote will be added to the forked repository and the branch checked out locally. This remote will automatically be cleaned up when the local branch is deleted.
 
@@ -30,6 +30,6 @@ If the pull request is from a fork then a remote will be added to the forked rep
 
 To compare the contents of a file in the pull request with its content on the target branch, double click a file in the **Changed Files** tree. This will open the Visual Studio diff viewer. If the pull request has been checked out, the right hand pane will be editable.
 
-![image](images/pr-diff-files.png)
+![Diff of two files in the Visual Studio diff viewer](images/pr-diff-files.png)
 
 If the pull request is checked out, right clicking on a file on the **Changed Files** tree and selecting **Open File** will open the file for editing in Visual Studio.
diff --git a/docs/contributing/using-the-github-toolbar.md b/docs/contributing/using-the-github-toolbar.md
@@ -2,7 +2,7 @@
 
 The GitHub pane toolbar provides a way to navigate between views, refresh views, and open the current view on GitHub.
 
-![Toolbar](images/github-pane-toolbar.png)
+![The GitHub pane toolbar](images/github-pane-toolbar.png)
 
 1. Open a solution in a GitHub repository.
 2. Open **Team Explorer** and click the **Pull Requests** button to open the **GitHub** pane.
diff --git a/docs/contributing/viewing-code-on-github.md b/docs/contributing/viewing-code-on-github.md
@@ -9,7 +9,7 @@ GitHub for Visual Studio enables easy navigation to code that exists on GitHub d
 
 ## Viewing the selected code on GitHub
 1. Right click and select **Open on GitHub** from the **GitHub** submenu.
-![Open on GitHub](images/open-on-github.png)
+![Open on GitHub selection in the GitHub context submenu](images/open-on-github.png)
 2. Your browser will open and navigate to the code on GitHub.
 
 ## Copying the URL of the selected code's location on GitHub
diff --git a/docs/contributing/viewing-the-pull-requests-for-a-repository.md b/docs/contributing/viewing-the-pull-requests-for-a-repository.md
@@ -5,9 +5,9 @@ GitHub for Visual Studio exposes the pull requests for the current repository an
 1. [Sign in](authenticating-to-github) to GitHub.
 2. Open a solution in a GitHub repository.
 3. Open **Team Explorer** and click the **Pull Requests** button to open the **GitHub** pane.
-![Pull Requests](images/pull-requests-button2.png)
+![Pull Requests button in the Team Explorer pane](images/pull-requests-button2.png)
 4. The open pull requests will be displayed.
-![Open Pull Requests](images/pull-request-list.png)
+![Pull requests in the GitHub pane](images/pull-request-list.png)
 5. Change the Open/Closed filter by clicking the **Open** link and selecting the filter you want to use from the dropdown.
 6. Filter pull requests by Assignee by clicking the **Assignee** link and selecting the assignee you want to view from the dropdown.
 7. Filter pull requests by Author by clicking the **Author** link and selecting the author you want to view from the dropdown.
diff --git a/docs/getting-started/authenticating-to-github.md b/docs/getting-started/authenticating-to-github.md
@@ -10,10 +10,10 @@ Before you authenticate, you must already have a GitHub or GitHub Enterprise acc
 > **Note:** If your organization is on the [Business plan](https://help.github.com/articles/organization-billing-plans) and has enabled SAML single sign-on, you must create and authorize a personal access token to access protected content. 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). 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)."
 
 1. In Visual Studio, select **Team Explorer** from the **View** menu.
-![](images/view_team_explorer.png)
+![Team Explorer in the view menu](images/view_team_explorer.png)
 2. In the Team Explorer pane, click the **Manage Connections** toolbar button.
-![](images/manage_connections.png)
+![Manage connections toolbar button in the Team Explorer pane](images/manage_connections.png)
 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**.
-![](images/connect_to_github.png)
+![Connect to GitHub in the manage connections dropdown in the Team Explorer pane](images/connect_to_github.png)
 4. In the **Connect to GitHub dialog** choose **GitHub** or **GitHub Enterprise**, depending on which product you're using.
 5. Type your credentials, then click **Sign In**.
diff --git a/docs/getting-started/configuring-git-in-visual-studio.md b/docs/getting-started/configuring-git-in-visual-studio.md
@@ -8,10 +8,10 @@ The name and email that will be displayed with your commits can be set from Team
 
 2. Click the **Settings** button in Team Explorer.
 
-   ![image](images/settings-button.png)
+   ![The settings button in Team Explorer pane](images/settings-button.png)
 
 3. Click **Global Settings** in the Team Explorer Settings page
 
-   ![image](images/global-settings-link.png)
+   ![The global settings button in the Team Explorer settings page](images/global-settings-link.png)
 
-4. Enter the name and email that you would like to appear in commits.
+4. Enter the name and email that you would like to appear in commits.
diff --git a/docs/getting-started/installing-github-for-visual-studio.md b/docs/getting-started/installing-github-for-visual-studio.md
@@ -24,7 +24,7 @@ If you're currently running Visual Studio 2015 or higher, you can install the ex
 
 4. Select the **GitHub Extension for Visual Studio** entry and click **Download**
 
-   ![image](images/install-from-gallery.png)
+   ![Installing GitHub for Visual Studio in the settings extensions and updates gallery](images/install-from-gallery.png)
 
 5. After installation is completed, restart Visual Studio.
 
@@ -38,7 +38,7 @@ When you install Visual Studio, you can include the GitHub Extension for Visual
 
 1. Start the Visual Studio 2015 installer.
 2. Scroll down to **Common Tools** and check **GitHub Extension for Visual Studio**.
-   ![image](images/vs2015-installer.png)
+   ![GitHub Extension for Visual Studio in the common tools section of the Visual Studio 2015 installer](images/vs2015-installer.png)
 3. Click the **Install** button.
 4. Once installation is complete, run Visual Studio 2015 and [update the extension](#updating-the-extension)
 
@@ -52,7 +52,7 @@ When you install Visual Studio, you can include the GitHub Extension for Visual
 
 3. Scroll down to **Code tools** and check **GitHub Extension for Visual Studio**.
 
-   ![image](images/vs2017-installer.png)
+   ![GitHub Extension for Visual Studio in the code tools section of the Visual Studio 2017 installer](images/vs2017-installer.png)
 
 4. Click the **Modify** button.
 
@@ -67,5 +67,5 @@ Visual Studio 2017 will not run automatic updates until you update the extension
 1. In Visual Studio, open the **Tools** menu and click **Extensions and Updates**
 2. On the left side of the **Extensions and Updates** dialog, select **Updates - Visual Studio gallery**
 3. If there are updates available, an entry titled **GitHub Extension for Visual Studio** will appear on the list. Select it and click **Update**
-   ![image](images/update-from-gallery.png)
+   ![Updating GitHub for Visual Studio in the settings extensions and updates gallery](images/update-from-gallery.png)
 4. After installation is completed, restart Visual Studio.
diff --git a/docs/readme.md b/docs/readme.md
