Add aria-labels to octicons (#55740)
This commit is contained in:
Kevin Heis
@@ -74,7 +74,7 @@ If you want to use Git hooks for your codespace, then you should set up hooks us
|
||||
|
||||
|
||||
|
||||
1. Click the **{% octicon "code" aria-hidden="true" %} Code** button, then click the **Codespaces** tab.
|
||||
1. Click the **{% octicon "code" aria-hidden="true" aria-label="code" %} Code** button, then click the **Codespaces** tab.
|
||||
|
||||
A message is displayed at the bottom of the dialog telling you who will pay for the codespace.
|
||||
|
||||
|
||||
@@ -66,7 +66,7 @@ You can create a codespace from any template repository, then publish your work
|
||||
{% data reusables.codespaces.use-this-template %}
|
||||
|
||||
> [!NOTE]
|
||||
> If you're a maintainer of the template repository, and want to commit changes to the template repository itself, you should create a codespace from the **{% octicon "code" aria-hidden="true" %} Code** dropdown. For more information, see [AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository#creating-a-codespace-for-a-repository).
|
||||
> If you're a maintainer of the template repository, and want to commit changes to the template repository itself, you should create a codespace from the **{% octicon "code" aria-hidden="true" aria-label="code" %} Code** dropdown. For more information, see [AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository#creating-a-codespace-for-a-repository).
|
||||
|
||||
{% data reusables.codespaces.template-codespaces-default-editor %}
|
||||
|
||||
|
||||
@@ -41,7 +41,7 @@ There are costs associated with storing codespaces. You should therefore delete
|
||||
{% webui %}
|
||||
|
||||
{% data reusables.codespaces.your-codespaces-procedure-step %}
|
||||
1. To the right of the codespace you want to delete, click {% octicon "kebab-horizontal" aria-label="Codespace configuration" %}, then click **{% octicon "trash" aria-hidden="true" %} Delete**.
|
||||
1. To the right of the codespace you want to delete, click {% octicon "kebab-horizontal" aria-label="Codespace configuration" %}, then click **{% octicon "trash" aria-hidden="true" aria-label="trash" %} Delete**.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -36,7 +36,7 @@ You can view all your codespaces on the "Your codespaces" page at [github.com/co
|
||||
|
||||
You can quickly resume a codespace when you're viewing a repository on {% data variables.product.github %}.
|
||||
|
||||
1. With the **{% octicon "code" aria-hidden="true" %} Code** tab of your repository displayed on {% data variables.product.github %}, press <kbd>,</kbd> (the comma key).
|
||||
1. With the **{% octicon "code" aria-hidden="true" aria-label="code" %} Code** tab of your repository displayed on {% data variables.product.github %}, press <kbd>,</kbd> (the comma key).
|
||||
|
||||
The "Resume codespace" page is displayed. This allows you to resume your most recently used codespace for the currently selected branch of the repository or, if you were viewing a pull request, for the topic branch of the pull request.
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@ Using a codespace to work on a pull request gives you all the benefits of {% dat
|
||||
{% data reusables.repositories.sidebar-pr %}
|
||||
|
||||
1. In the list of pull requests, click the pull request you'd like to open in {% data variables.product.prodname_codespaces %}.
|
||||
1. On the right-hand side of your screen, click **{% octicon "code" aria-hidden="true" %} Code**.
|
||||
1. On the right-hand side of your screen, click **{% octicon "code" aria-hidden="true" aria-label="code" %} Code**.
|
||||
1. In the {% data variables.product.prodname_codespaces %} tab, click {% octicon "plus" aria-label="Create a codespace on BRANCH" %}.
|
||||
|
||||
|
||||
|
||||
@@ -20,7 +20,7 @@ If it currently takes more than 2 minutes to create a codespace for a repository
|
||||
|
||||
By default, whenever you push changes to your repository, {% data variables.product.prodname_github_codespaces %} uses {% data variables.product.prodname_actions %} to automatically update your prebuilds.
|
||||
|
||||
When prebuilds are available for a particular branch of a repository, a particular dev container configuration file, and for your region, you'll see the "{% octicon "zap" aria-hidden="true" %} Prebuild ready" label in the list of machine type options when you create a codespace. If a prebuild is still being created, you will see the "{% octicon "history" aria-hidden="true" %} Prebuild in progress" label. For more information, see [AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository#creating-a-codespace-for-a-repository).
|
||||
When prebuilds are available for a particular branch of a repository, a particular dev container configuration file, and for your region, you'll see the "{% octicon "zap" aria-hidden="true" aria-label="zap" %} Prebuild ready" label in the list of machine type options when you create a codespace. If a prebuild is still being created, you will see the "{% octicon "history" aria-hidden="true" aria-label="history" %} Prebuild in progress" label. For more information, see [AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository#creating-a-codespace-for-a-repository).
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -59,7 +59,7 @@ Once your codespace is created, the template repository will be automatically cl
|
||||
|
||||
1. Go back to the running application tab in your browser and refresh to see your changes.
|
||||
|
||||
{% octicon "light-bulb" aria-hidden="true" %} If you've closed the browser tab, click the Ports tab in {% data variables.product.prodname_vscode_shortname %}, hover over the **Local Address** value for the running port, and click the **Open in Browser** icon.
|
||||
{% octicon "light-bulb" aria-hidden="true" aria-label="light-bulb" %} If you've closed the browser tab, click the Ports tab in {% data variables.product.prodname_vscode_shortname %}, hover over the **Local Address** value for the running port, and click the **Open in Browser** icon.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -176,7 +176,7 @@ If none of the predefined configurations meets your needs, you can create a cust
|
||||
### Adding a `devcontainer.json` file
|
||||
|
||||
If you don't already have a `devcontainer.json` file in your repository, you can quickly add one from {% data variables.product.github %}.
|
||||
1. Navigate to your repository and click the **{% octicon "code" aria-hidden="true" %} Code** dropdown.
|
||||
1. Navigate to your repository and click the **{% octicon "code" aria-hidden="true" aria-label="code" %} Code** dropdown.
|
||||
1. In the **Codespaces** tab, click the ellipsis (**...**), then select **Configure dev container**.
|
||||
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ topics:
|
||||
|
||||
If a project needs user-specific secrets to be set up, you can prompt people to do this when they create a codespace. You do this by adding a setting to a dev container configuration file for the repository.
|
||||
|
||||
After you specify recommended secrets, if people have not already created those secrets in their personal settings for {% data variables.product.prodname_codespaces %}, they will be prompted to do so when they use the advanced options method of creating a codespace. This is done on {% data variables.product.github %} by clicking the **{% octicon "code" aria-hidden="true" %} Code** button, then clicking the **Codespaces** tab, then selecting {% octicon "kebab-horizontal" aria-label="Codespace repository configuration" %} and clicking **New with options**.
|
||||
After you specify recommended secrets, if people have not already created those secrets in their personal settings for {% data variables.product.prodname_codespaces %}, they will be prompted to do so when they use the advanced options method of creating a codespace. This is done on {% data variables.product.github %} by clicking the **{% octicon "code" aria-hidden="true" aria-label="code" %} Code** button, then clicking the **Codespaces** tab, then selecting {% octicon "kebab-horizontal" aria-label="Codespace repository configuration" %} and clicking **New with options**.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -45,7 +45,7 @@ You can use the "Share a deep link" option to configure more options for the cod
|
||||
|
||||
|
||||
|
||||
1. Click the **{% octicon "code" aria-hidden="true" %} Code** button, then click the **Codespaces** tab.
|
||||
1. Click the **{% octicon "code" aria-hidden="true" aria-label="code" %} Code** button, then click the **Codespaces** tab.
|
||||
1. To open the "Share codespace configuration" window, at the top right of the **Codespaces** tab, select {% octicon "kebab-horizontal" aria-label="Codespace repository configuration" %}, then click **Share a deep link**.
|
||||
|
||||
|
||||
|
||||
@@ -70,11 +70,11 @@ You may have a codespace that you want to keep for longer than the retention per
|
||||
Codespaces incur storage costs, or consume your included storage allowance if the codespace is owned by your personal {% data variables.product.prodname_dotcom %} account. You should therefore be aware of the cost implications of storing codespaces indefinitely. See [AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#about-billing-for-storage-usage).
|
||||
|
||||
{% data reusables.codespaces.your-codespaces-procedure-step %}
|
||||
1. To the right of the codespace you want to exempt from automatic deletion, click {% octicon "kebab-horizontal" aria-label="Codespace configuration" %}, then click **{% octicon "bookmark" aria-hidden="true" %} Keep codespace**.
|
||||
1. To the right of the codespace you want to exempt from automatic deletion, click {% octicon "kebab-horizontal" aria-label="Codespace configuration" %}, then click **{% octicon "bookmark" aria-hidden="true" aria-label="bookmark" %} Keep codespace**.
|
||||
|
||||
|
||||
|
||||
Codespaces that you have exempted from automatic deletion are indicated in your list of codespaces with the bookmark icon ({% octicon "bookmark-fill" aria-hidden="true" %}).
|
||||
Codespaces that you have exempted from automatic deletion are indicated in your list of codespaces with the bookmark icon ({% octicon "bookmark-fill" aria-hidden="true" aria-label="bookmark-fill" %}).
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -27,9 +27,9 @@ You can export your changes in one of several ways, depending on how you created
|
||||
|
||||
The following steps describe how to export your changes to a branch or fork. For information on exporting an unpublished codespace to a new repository, see [AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-from-a-template#publishing-from-githubcom).
|
||||
|
||||
{% data reusables.codespaces.your-codespaces-procedure-step %} Or, for an individual repository, click the **{% octicon "code" aria-hidden="true" %} Code** menu.
|
||||
{% data reusables.codespaces.your-codespaces-procedure-step %} Or, for an individual repository, click the **{% octicon "code" aria-hidden="true" aria-label="code" %} Code** menu.
|
||||
1. Click the ellipsis (**...**) to the right of the codespace you want to export from.
|
||||
1. Select **{% octicon "git-branch" aria-hidden="true" %} Export changes to a branch** or **{% octicon "git-branch" aria-hidden="true" %} Export changes to a fork**.
|
||||
1. Select **{% octicon "git-branch" aria-hidden="true" aria-label="git-branch" %} Export changes to a branch** or **{% octicon "git-branch" aria-hidden="true" aria-label="git-branch" %} Export changes to a fork**.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@ For more information about {% data variables.product.prodname_github_codespaces
|
||||
|
||||
## Checking whether a codespace was created from a prebuild?
|
||||
|
||||
When you create a codespace, you can choose the type of the virtual machine you want to use. If a prebuild is available for the type of virtual machine, "{% octicon "zap" aria-hidden="true" %} Prebuild ready" is shown next to it.
|
||||
When you create a codespace, you can choose the type of the virtual machine you want to use. If a prebuild is available for the type of virtual machine, "{% octicon "zap" aria-hidden="true" aria-label="zap" %} Prebuild ready" is shown next to it.
|
||||
|
||||
|
||||
|
||||
@@ -46,18 +46,18 @@ You can check how much storage space has been consumed by prebuilds in your curr
|
||||
|
||||
## The "Prebuild Ready" label is sometimes missing
|
||||
|
||||
You may notice that sometimes, when you create a new codespace from a prebuild-enabled branch, the "{% octicon "zap" aria-hidden="true" %} Prebuild Ready" label is not displayed in the dialog box for choosing a machine type. This means that prebuilds are not currently available.
|
||||
You may notice that sometimes, when you create a new codespace from a prebuild-enabled branch, the "{% octicon "zap" aria-hidden="true" aria-label="zap" %} Prebuild Ready" label is not displayed in the dialog box for choosing a machine type. This means that prebuilds are not currently available.
|
||||
|
||||
By default, each time you push to a prebuild-enabled branch, the prebuild is updated. If the push involves a change to the dev container configuration then, while the update is in progress, the "{% octicon "zap" aria-hidden="true" %} Prebuild Ready" label is removed from the list of machine types. During this time you can still create codespaces without a prebuild. If required, you can reduce the occasions on which prebuilds are unavailable for a repository by setting the prebuild to be updated only when you make a change to your dev container configuration files, or only on a custom schedule. For more information, see [AUTOTITLE](/codespaces/prebuilding-your-codespaces/configuring-prebuilds#configuring-prebuilds).
|
||||
By default, each time you push to a prebuild-enabled branch, the prebuild is updated. If the push involves a change to the dev container configuration then, while the update is in progress, the "{% octicon "zap" aria-hidden="true" aria-label="zap" %} Prebuild Ready" label is removed from the list of machine types. During this time you can still create codespaces without a prebuild. If required, you can reduce the occasions on which prebuilds are unavailable for a repository by setting the prebuild to be updated only when you make a change to your dev container configuration files, or only on a custom schedule. For more information, see [AUTOTITLE](/codespaces/prebuilding-your-codespaces/configuring-prebuilds#configuring-prebuilds).
|
||||
|
||||
If your branch is not specifically enabled for prebuilds it may still benefit from prebuilds if it was branched from a prebuild-enabled branch. However, if the dev container configuration is changed on your branch, so that it's not the same as the configuration on the base branch, prebuilds will no longer be available on your branch.
|
||||
|
||||
Here are things to check if the "{% octicon "zap" aria-hidden="true" %} Prebuild Ready" label is not displayed for a particular branch:
|
||||
Here are things to check if the "{% octicon "zap" aria-hidden="true" aria-label="zap" %} Prebuild Ready" label is not displayed for a particular branch:
|
||||
|
||||
* Confirm that a prebuild configuration exists for this branch. If you’re not a repository administrator, you'll need to reach out to one to confirm this.
|
||||
* Confirm that the prebuild configuration includes your region.
|
||||
* Check whether a change to the dev container configuration was pushed to the prebuild-enabled branch recently. If so, you will typically have to wait until the prebuild workflow run for this push completes before prebuilds are available again.
|
||||
* If no configuration changes were recently made, go to the **Actions** tab of your repository, click **{% octicon "codespaces" aria-hidden="true" %} {% data variables.product.prodname_codespaces %} Prebuilds** in the workflows list, and check that prebuild workflow runs for the branch are succeeding. If latest runs of a workflow failed, and one or more of these failed runs contained changes to the dev container configuration, then there will be no available prebuilds for the associated branch.
|
||||
* If no configuration changes were recently made, go to the **Actions** tab of your repository, click **{% octicon "codespaces" aria-hidden="true" aria-label="codespaces" %} {% data variables.product.prodname_codespaces %} Prebuilds** in the workflows list, and check that prebuild workflow runs for the branch are succeeding. If latest runs of a workflow failed, and one or more of these failed runs contained changes to the dev container configuration, then there will be no available prebuilds for the associated branch.
|
||||
|
||||
## Some resources cannot be accessed in codespaces created using a prebuild
|
||||
|
||||
|
||||
Reference in New Issue
Block a user