Add a troubleshooting article for Codespaces included usage (#34093) · github/docs@0e5b5d6 · GitHub
Skip to content

Commit 0e5b5d6

Browse files
hubwritergithub-actionsisaacmbrown
authored
Add a troubleshooting article for Codespaces included usage (#34093)
Co-authored-by: github-actions <github-actions@github.com> Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com>
1 parent c9c6ca0 commit 0e5b5d6

27 files changed

Lines changed: 186 additions & 56 deletions
43 KB
Loading
-27.9 KB
Binary file not shown.
31.9 KB
Loading
5.96 KB
Loading
101 KB
Loading

‎content/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces.md‎

Lines changed: 11 additions & 5 deletions

‎content/billing/managing-billing-for-github-codespaces/viewing-your-github-codespaces-usage.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,17 @@ You can see how much of the usage included in your personal account you have use
2323

2424
![Screenshot of the initial view of personal usage](/assets/images/help/codespaces/view-personal-usage-collapsed.png)
2525

26-
For information about "core hours" and "GB-months," see "[About billing for {% data variables.product.prodname_github_codespaces %}](/enterprise-cloud@latest/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces)."
26+
For information about "core hours" and "GB-months," see "[About billing for {% data variables.product.prodname_github_codespaces %}](/free-pro-team@latest/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces)."
2727

2828
1. Optionally, click **Usage hours** and **Storage** to see more details.
2929

3030
![Screenshot of the expanded view of personal usage](/assets/images/help/codespaces/view-personal-usage-expanded.png)
3131

3232
The **Included** column shows how many of the core hours of compute usage, or GB-months of storage, included free with your account, you have used so far this month. The **Paid** column shows how many billed core hours of usage, or GB-months of storage, you have used. The figures are updated once every hour.
3333

34-
In the screenshot above, the entire quota of included storage for the month has been used. When you've used all of either the included compute usage or storage (whichever is reached first), you must set up a payment method and a spending limit to continue using {% data variables.product.prodname_github_codespaces %} during the current billing month. For more information, see "[Adding or editing a payment method](/enterprise-cloud@latest/billing/managing-your-github-billing-settings/adding-or-editing-a-payment-method)" and "[Managing spending limits for {% data variables.product.prodname_github_codespaces %}](/billing/managing-billing-for-github-codespaces/managing-the-spending-limit-for-github-codespaces#managing-the-github-codespaces-spending-limit-for-your-personal-account)."
34+
In the screenshot above, the entire quota of included storage for the month has been used. When you've used all of either the included compute usage or storage (whichever is reached first), you must set up a payment method and a spending limit to continue using {% data variables.product.prodname_github_codespaces %} during the current billing month. For more information, see "[Adding or editing a payment method](/billing/managing-your-github-billing-settings/adding-or-editing-a-payment-method)" and "[Managing spending limits for {% data variables.product.prodname_github_codespaces %}](/billing/managing-billing-for-github-codespaces/managing-the-spending-limit-for-github-codespaces#managing-the-github-codespaces-spending-limit-for-your-personal-account)."
35+
36+
{% data reusables.codespaces.tips-included-usage %}
3537

3638
{% data reusables.codespaces.usage-report-download %}
3739

@@ -48,7 +50,7 @@ Organization owners and billing managers can view {% data variables.product.prod
4850

4951
{% note %}
5052

51-
**Notes**:
53+
**Notes**:
5254
* The costs shown here are the cumulative costs within the current monthly billing period. The metered costs for {% data variables.product.prodname_github_codespaces %} shown on this page are reset to zero at the start of each monthly billing period. Outstanding costs from previous months are not shown.
5355
* The figures on this page are updated every hour.
5456

‎content/codespaces/customizing-your-codespace/renaming-a-codespace.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,31 +20,31 @@ To find the display name of a codespace:
2020

2121
- On {% data variables.product.product_name %}, view your list of codespaces at https://github.com/codespaces.
2222

23-
![Screenshot of the list of codespaces in GitHub](/assets/images/help/codespaces/codespaces-list-display-name.png)
23+
![Screenshot of the list of codespaces in GitHub](/assets/images/help/codespaces/click-name-codespace.png)
2424

2525
- In the {% data variables.product.prodname_vscode %} desktop application, or the {% data variables.product.prodname_vscode_shortname %} web client, click the Remote Explorer. The display name is the second item in the list. For example: `symmetrical space telegram` in the screenshot below.
2626

2727
![Screenshot of the Remote Explorer in VS Code](/assets/images/help/codespaces/codespaces-remote-explorer.png)
2828

2929
{% indented_data_reference reusables.codespaces.remote-explorer spaces=2 %}
30-
- In a terminal window on your local machine, use this {% data variables.product.prodname_cli %} command: `gh codespace list`.
30+
- In a terminal window on your local machine, use this {% data variables.product.prodname_cli %} command: `gh codespace list`.
3131

3232
### Permanent codespace names
3333

3434
In addition to the display name, when you create a codespace, a permanent name is also assigned to the codespace. The name is a combination of your {% data variables.product.company_short %} handle, and the auto-generated display name. For example: `octocat-literate-space-parakeet-mld5`. You can't change the permanent name.
3535

3636
To find the permanent name of a codespace:
3737

38-
* On {% data variables.product.product_name %}, the permanent name is shown in a pop-up when you hover over the display name of a codespace on https://github.com/codespaces.
38+
* On {% data variables.product.product_name %}, the permanent name is shown in a pop-up when you hover over the display name of a codespace on https://github.com/codespaces.
3939

4040
![Screenshot of the codespace name shown on hover over](/assets/images/help/codespaces/find-codespace-name-github.png)
41-
41+
4242
* In a codespace, use this command in the terminal: `echo $CODESPACE_NAME`.
4343
* In a terminal window on your local machine, use this {% data variables.product.prodname_cli %} command: `gh codespace list`.
4444

4545
## Renaming a codespace
4646

47-
Changing the display name of a codespace can be useful if you have multiple codespaces that you will be using for an extended period. An appropriate name helps you identify a codespace that you use for a particular purpose.
47+
Changing the display name of a codespace can be useful if you have multiple codespaces that you will be using for an extended period. An appropriate name helps you identify a codespace that you use for a particular purpose.
4848

4949
{% cli %}
5050

‎content/codespaces/developing-in-codespaces/creating-a-codespace-for-a-repository.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ For more information on what happens when you create a codespace, see "[Deep Div
5151

5252
For more information on the lifecycle of a codespace, see "[The codespace lifecycle](/codespaces/getting-started/the-codespace-lifecycle)."
5353

54-
If you want to use Git hooks for your codespace, then you should set up hooks using the [`devcontainer.json` lifecycle scripts](https://code.visualstudio.com/docs/remote/devcontainerjson-reference#_lifecycle-scripts), such as `postCreateCommand`, during step 4. Since your codespace container is created after the repository is cloned, any [git template directory](https://git-scm.com/docs/git-init#_template_directory) configured in the container image will not apply to your codespace. Hooks must instead be installed after the codespace is created. For more information on using `postCreateCommand`, see the [`devcontainer.json` reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference#_devcontainerjson-properties) in the {% data variables.product.prodname_vscode_shortname %} documentation.
54+
If you want to use Git hooks for your codespace, then you should set up hooks using the `devcontainer.json` lifecycle scripts, such as `postCreateCommand`. These get executed during step 4, above. For information about the lifecycle scripts, see the [dev containers specification](https://containers.dev/implementors/json_reference/#lifecycle-scripts) on the Development Containers website. Since your codespace container is created after the repository is cloned, any [git template directory](https://git-scm.com/docs/git-init#_template_directory) configured in the container image will not apply to your codespace. Hooks must instead be installed after the codespace is created.
5555

5656
{% data reusables.codespaces.use-visual-studio-features %}
5757

‎content/codespaces/developing-in-codespaces/creating-a-codespace-from-a-template.md‎

Lines changed: 1 addition & 1 deletion

0 commit comments

Comments
 (0)