1
0
mirror of synced 2025-12-22 03:16:52 -05:00

Accessibility: Replace Codespaces screenshots and rewrite alt text - batch 2 (#35128)

Co-authored-by: Laura Coursen <lecoursen@github.com>
Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com>
This commit is contained in:
hubwriter
2023-03-06 09:29:21 +00:00
committed by GitHub
parent 077f7cd7c1
commit ce594b4b0f
69 changed files with 141 additions and 154 deletions

View File

@@ -46,9 +46,7 @@ Templates maintained by {% data variables.product.company_short %}, including th
![Screenshot of the "Explore quick start templates" section, with "React" highlighted](/assets/images/help/codespaces/react-template-name.png)
1. Under the template you want to launch, click **Use this template**.
![Screenshot of the quick start templates, with the "Use this template" button highlighted under the React template](/assets/images/help/codespaces/react-template-button.png)
1. Under the name of the template you want to launch, click **Use this template**.
{% data reusables.codespaces.template-codespaces-default-editor %}
@@ -88,10 +86,12 @@ You can publish an unpublished codespace from the "Your codespaces" page on {% d
{% data reusables.codespaces.your-codespaces-procedure-step %}
1. Next to the unpublished codespace, click the ellipsis (**...**), then select **Publish to a new repository**.
![Screenshot of the "Publish to a new repository" button](/assets/images/help/codespaces/publish-to-new-repository.png)
![Screenshot of the dropdown menu for a codespace, showing the "Publish to a new repository" option.](/assets/images/help/codespaces/publish-to-new-repository.png)
1. Choose a name for your new repository, set it as **Public** or **Private**, and click **Create repository**.
![Screenshot of the "Publish to a new repository" dropdown](/assets/images/help/codespaces/template-new-repository-settings.png)
![Screenshot of the "Publish to a new repository" dropdown, with the "Name" field, "Public" and "Private" options, and "Create repository" button.](/assets/images/help/codespaces/template-new-repository-settings.png)
1. Optionally, to view the new repository, click **See repository**.
## Further reading

View File

@@ -30,29 +30,41 @@ redirect_from:
1. On the right-hand side of your screen, click **{% octicon "code" aria-label="The code icon" %} Code**.
1. In the {% data variables.product.prodname_codespaces %} tab, click the plus sign ({% octicon "plus" aria-label="The plus icon" %})
![Option to open PR in a codespace](/assets/images/help/codespaces/open-with-codespaces-pr.png)
![Screenshot of the "Code" dropdown with the "{% data variables.product.prodname_codespaces %}" tab selected. The message "No codespaces" is displayed. The plus button is highlighted.](/assets/images/help/codespaces/open-with-codespaces-pr.png)
A codespace is created for the pull request branch and is opened in your default editor for {% data variables.product.prodname_github_codespaces %}.
## Reviewing a pull request in {% data variables.product.prodname_codespaces %}
1. With your default editor set to either {% data variables.product.prodname_vscode %} or {% data variables.product.prodname_vscode %} for Web, open the pull request in a codespace, as described in "[AUTOTITLE](/codespaces/developing-in-codespaces/using-github-codespaces-for-pull-requests#opening-a-pull-request-in-codespaces)" above.
2. In the Activity Bar, click the **GitHub Pull Request** view. This view only appears when you open a pull request in a codespace.
![Option to open PR in a codespace](/assets/images/help/codespaces/github-pr-view.png)
3. To review a specific file, click the **Open File** icon in the sidebar.
![Option to open PR in a codespace](/assets/images/help/codespaces/changes-in-files.png)
4. To add review comments, click the **+** icon next to the line number. Type your review comment and then click **Start Review**.
![Option to open PR in a codespace](/assets/images/help/codespaces/start-review.png)
5. When you are finished adding review comments, from the sidebar you can choose to either submit the comments, approve the changes, or request changes.
![Option to open PR in a codespace](/assets/images/help/codespaces/submit-review.png)
1. With your default editor set to either {% data variables.product.prodname_vscode %} or {% data variables.product.prodname_vscode %} for Web, open the pull request in a codespace, as described in "[Opening a pull request in {% data variables.product.prodname_codespaces %}](#opening-a-pull-request-in-codespaces)" previously in this article.
1. In the Activity Bar, click the Git pull request icon to display the "{% data variables.product.prodname_dotcom %} Pull Request" sidebar. This icon is only displayed in the Activity Bar when you open a pull request in a codespace.
![Screenshot of the {% data variables.product.prodname_vscode_shortname %} Activity Bar. The mouse pointer is hovering over an icon displaying the tooltip "{% data variables.product.prodname_dotcom %} Pull Request."](/assets/images/help/codespaces/github-pr-view.png)
If you opened a pull request in a codespace and the pull request icon is not displayed in the Activity Bar, make sure you are signed in to {% data variables.product.prodname_dotcom %}. Click the {% data variables.product.prodname_dotcom %} icon in the Activity Bar then click **Sign in**.
![Screenshot of the {% data variables.product.prodname_dotcom %} sidebar showing the "Sign in" button. The {% data variables.product.prodname_dotcom %} icon in the Activity Bar is highlighted with an orange outline.](/assets/images/help/codespaces/sign-in-to-github.png)
1. To review the changes that have been made to a specific file, click the file's name in the "{% data variables.product.prodname_dotcom %} Pull Request" sidebar.
![Screenshot of the "{% data variables.product.prodname_dotcom %} Pull Request" sidebar. A file name is highlighted with a dark orange outline.](/assets/images/help/codespaces/changes-in-files.png)
This displays a diff view in the editor, with the version of the file from the base branch on the left, and the new version of the file, from the head branch of the pull request, on the right.
1. To add a review comment, click the **+** sign next to the line number in the file displayed on the right side of the editor.
![Screenshot of the diff view. In the head version of the file, on the right side of the editor, the plus sign next to a line is highlighted.](/assets/images/help/codespaces/create-review-comment.png)
1. Type your review comment and then click **Start Review**.
![Screenshot of a comment being added, reading "Yes, I agree, this is clearer." The "Start Review" button is shown below the comment.](/assets/images/help/codespaces/start-review.png)
1. When you are finished adding review comments, you can add a summary comment for your pull request review in the "{% data variables.product.prodname_dotcom %} Pull Request" sidebar. You can then click **Comment and Submit**, or click the dropdown arrow and select **Approve and Submit** or **Request Changes and Submit**.
![Screenshot of the sidebar showing the dropdown options "Comment and Submit," "Approve and Submit," and "Request Changes and Submit."](/assets/images/help/codespaces/submit-review.png)
For more information on reviewing a pull request, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)."
## View comments from a review in {% data variables.product.prodname_codespaces %}
Once you have received feedback on a pull request, you can [open it in a codespace](#opening-a-pull-request-in-codespaces) in your web browser, or in {% data variables.product.prodname_vscode_shortname %}, to see the [review comments](#reviewing-a-pull-request-in-codespaces). From there you can respond to comments, add reactions, or dismiss the review.
![Option to open PR in a codespace](/assets/images/help/codespaces/incorporating-codespaces.png)

View File

@@ -31,34 +31,15 @@ To develop in a codespace directly in {% data variables.product.prodname_vscode_
Use the {% data variables.product.prodname_vscode_marketplace %} to install the [{% data variables.product.prodname_github_codespaces %}](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) extension. For more information, see [Extension Marketplace](https://code.visualstudio.com/docs/editor/extension-gallery) in the {% data variables.product.prodname_vscode_shortname %} documentation.
{% mac %}
{% data reusables.codespaces.click-remote-explorer-icon-vscode %}
1. Click **Sign in to {% data variables.product.prodname_dotcom %}...**.
1. Select "{% data variables.product.prodname_github_codespaces %}" from the dropdown at the top of the "Remote Explorer" sidebar, if it is not already selected.
1. Click **Sign in to {% data variables.product.prodname_dotcom %}**.
![Signing in to {% data variables.product.prodname_github_codespaces %}](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode-mac.png)
![Screenshot of the "Remote Explorer" sidebar for "{% data variables.product.prodname_github_codespaces %}" with the "Sign in to {% data variables.product.prodname_dotcom %}" button displayed.](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode.png)
2. To authorize {% data variables.product.prodname_vscode_shortname %} to access your account on {% data variables.product.product_name %}, click **Allow**.
3. Sign in to {% data variables.product.product_name %} to approve the extension.
{% endmac %}
{% windows %}
{% data reusables.codespaces.click-remote-explorer-icon-vscode %}
1. Use the "REMOTE EXPLORER" drop-down, then click **{% data variables.product.prodname_github_codespaces %}**.
![The {% data variables.product.prodname_github_codespaces %} header](/assets/images/help/codespaces/codespaces-header-vscode.png)
1. Click **Sign in to view {% data variables.product.prodname_codespaces %}**.
![Signing in to view {% data variables.product.prodname_github_codespaces %}](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode.png)
1. To authorize {% data variables.product.prodname_vscode_shortname %} to access your account on {% data variables.product.product_name %}, click **Allow**.
1. Sign in to {% data variables.product.product_name %} to approve the extension.
{% endwindows %}
1. If you are not currently signed in to {% data variables.product.prodname_dotcom %} you'll be prompted to do so. Go ahead and sign in.
1. When you're prompted to specify what you want to authorize, click the **Authorize** button for "{% data variables.product.prodname_dotcom %}."
1. If the authorization page is displayed, click **Authorize Visual-Studio-Code**.
## Creating a codespace in {% data variables.product.prodname_vscode_shortname %}
@@ -67,10 +48,10 @@ Use the {% data variables.product.prodname_vscode_marketplace %} to install the
## Opening a codespace in {% data variables.product.prodname_vscode_shortname %}
{% data reusables.codespaces.click-remote-explorer-icon-vscode %}
1. Under "Codespaces", click the codespace you want to develop in.
1. Click the Connect to Codespace icon.
1. Under "{% data variables.product.prodname_github_codespaces %}", hover over the codespace you want to develop in.
1. Click the connection icon (a plug symbol).
![The Connect to Codespace icon in {% data variables.product.prodname_vscode_shortname %}](/assets/images/help/codespaces/click-connect-to-codespace-icon-vscode.png)
![Screenshot of the "Remote Explorer" sidebar. The connection icon for a codespace (a plug symbol) is highlighted with a dark orange outline.](/assets/images/help/codespaces/click-connect-to-codespace-icon-vscode.png)
## Changing the machine type in {% data variables.product.prodname_vscode_shortname %}
@@ -90,16 +71,20 @@ Use the {% data variables.product.prodname_vscode_marketplace %} to install the
{% data reusables.codespaces.deleting-a-codespace-in-vscode %}
## Switching to the Insiders build of {% data variables.product.prodname_vscode_shortname %}
## Switching to {% data variables.product.prodname_vscode_shortname %} Insiders in the web client
You can use the [Insiders Build of {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/docs/setup/setup-overview#_insiders-nightly-build) within {% data variables.product.prodname_github_codespaces %}.
If you are using the {% data variables.product.prodname_vscode_shortname %} web client, you can switch to the Insiders version of the application. For more information about this version of {% data variables.product.prodname_vscode_shortname %}, see [Introducing the Insiders Build](https://code.visualstudio.com/blogs/2016/02/01/introducing_insiders_build) in the {% data variables.product.prodname_vscode_shortname %} blog.
1. In bottom left of your {% data variables.product.prodname_github_codespaces %} window, select **{% octicon "gear" aria-label="The settings icon" %} Settings**.
2. From the list, select "Switch to Insiders Version".
After you switch versions in a codespace, the web client will continue to use the Insiders version if you stop and restart the codespace. New codespaces that you create and open in the {% data variables.product.prodname_vscode_shortname %} web client will also use the Insiders version.
![Clicking on "Insiders Build" in {% data variables.product.prodname_github_codespaces %}](/assets/images/help/codespaces/codespaces-insiders-vscode.png)
1. In bottom left of the browser window that's displaying a codespace, click **{% octicon "gear" aria-label="The settings icon" %}**.
2. In the menu, select "Switch to Insiders Version."
3. Once selected, {% data variables.product.prodname_github_codespaces %} will continue to open in Insiders Version.
![Screenshot of the {% data variables.product.prodname_vscode_shortname %} web client. A gear icon is highlighted with an orange outline. "Switch to Insiders Version" is shown in the menu.](/assets/images/help/codespaces/codespaces-insiders-vscode.png)
3. Click **Reload**.
To switch back to the Stable version of {% data variables.product.prodname_vscode_shortname %}, repeat the process but choose **Switch to Stable Version**. After you switch back, the codespace will continue to use the Stable version if you stop and restart the codespace. New codespaces that you create and open in the {% data variables.product.prodname_vscode_shortname %} web client will also use the Stable version.
## Further reading

View File

@@ -22,24 +22,22 @@ For more information about Live Share, see "[What is {% data variables.product.p
1. In the Activity Bar, click the Extensions icon.
1. In the search box, type `Live Share`.
![Screenshot of searching for the Live Share extension](/assets/images/help/codespaces/live-share-search-extensions.png)
![Screenshot of the "Extensions: Marketplace" sidebar with "live share" entered in the search box. "Live Share" is the first in the list of extensions.](/assets/images/help/codespaces/live-share-search-extensions.png)
1. If the **Install** button is displayed beside the extension, click it to install the extension in the codespace.
1. If the extension is shown grayed out in the list, right-click it and click **Enable**.
![Screenshot of the 'Enable' right-click menu option](/assets/images/help/codespaces/live-share-enable-rightclick.png)
![Screenshot of the "Enable" right-click menu option.](/assets/images/help/codespaces/live-share-enable-rightclick.png)
1. In the Activity Bar, click the Live Share icon.
![Screenshot of clicking the Live Share icon](/assets/images/help/codespaces/live-share-click-icon.png)
![Screenshot of the Activity Bar. The Live Share icon (an arrow above a circle) is highlighted with a dark orange outline.](/assets/images/help/codespaces/live-share-click-icon.png)
1. Click **Share**.
![Screenshot of the 'Share' button](/assets/images/help/codespaces/live-share-click-share.png)
A "toast" notification message is displayed at the bottom right corner of {% data variables.product.prodname_vscode_shortname %}, telling you that a link to your codespace has been copied to the clipboard. You can click **Make read-only** if you want to prevent guests from making changes to the files you share with them.
![Screenshot of the Live Share session 'toast' message](/assets/images/help/codespaces/live-share-link-copied-clipboard.png)
![Screenshot of a popup message: "Invitation link copied to clipboard!" There are three buttons: "Make read-only," "More info," and "Copy again."](/assets/images/help/codespaces/live-share-link-copied-clipboard.png)
1. Send the link in your clipboard to anyone you want to join you in your Live Share session.
@@ -53,7 +51,7 @@ For more information about Live Share, see "[What is {% data variables.product.p
To stop sharing your codespace, click the stop icon in the Live Share panel.
![Screenshot of the stop icon in the Live Share panel](/assets/images/help/codespaces/live-share-stop-collaboration.png)
![Screenshot of the stop icon to the right of "Session Details" in the "Live Share" side bar. The icon is a circle with a diagonal line through it.](/assets/images/help/codespaces/live-share-stop-collaboration.png)
If you, as the person who started the Live Share session, close the codespace the sharing session ends, even if the codespace remains active on the remote host.