jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Part 1: First fourth content unordered lists from dash to asterisk (#51094)

Browse Source
This commit is contained in:
Grace Park
2024-06-13 10:39:07 -07:00
committed by GitHub
parent ef824b1e7e
commit 0b94935b77
738 changed files with 6267 additions and 6267 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
content/codespaces/developing-in-a-codespace/connecting-to-a-private-network.md
View File

@@ -20,8 +20,8 @@ By default, your codespaces have access to all resources on the public internet,
## Connecting to resources on a private network
There are currently two methods of accessing resources on a private network within {% data variables.product.prodname_github_codespaces %}.
- Using a {% data variables.product.prodname_cli %} extension to configure your local machine as a gateway to remote resources.
- Using a VPN.
* Using a {% data variables.product.prodname_cli %} extension to configure your local machine as a gateway to remote resources.
* Using a VPN.
### Using the GitHub CLI extension to access remote resources
@@ -43,7 +43,7 @@ There are also a number of third party solutions that, while not explicitly endo
These third party solutions include:
- [Tailscale](https://tailscale.com/kb/1160/github-codespaces/)
* [Tailscale](https://tailscale.com/kb/1160/github-codespaces/)
### Allowlisting private resources for codespaces

28
content/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository.md
View File

@@ -51,10 +51,10 @@ If you create a codespace from a repository, the codespace will be associated wi
When you create a codespace, a number of steps happen to create and connect you to your development environment:
- Step 1: VM and storage are assigned to your codespace.
- Step 2: Container is created and your repository is cloned.
- Step 3: You can connect to the codespace.
- Step 4: Codespace continues with post-creation setup.
* Step 1: VM and storage are assigned to your codespace.
* Step 2: Container is created and your repository is cloned.
* Step 3: You can connect to the codespace.
* Step 4: Codespace continues with post-creation setup.
For more information on what happens when you create a codespace, see "[AUTOTITLE](/codespaces/getting-started/deep-dive)."
@@ -83,11 +83,11 @@ If you want to use Git hooks for your codespace, then you should set up hooks us
1. Create your codespace, either using the default options, or after configuring advanced options:
- **Use the default options**
* **Use the default options**
To create a codespace using the default options, click {% octicon "plus" aria-label="Create a codespace on BRANCH" %}. <br/><br/>
- **Configure advanced options**
* **Configure advanced options**
To configure advanced options for your codespace, such as a different machine type or a particular `devcontainer.json` file:
@@ -105,11 +105,11 @@ If you want to use Git hooks for your codespace, then you should set up hooks us
**Notes**
- You can bookmark the options page to give you a quick way to create a codespace for this repository and branch.
- The [https://github.com/codespaces/new](https://github.com/codespaces/new) page provides a quick way to create a codespace for any repository and branch. You can get to this page quickly by typing `codespace.new` into your browser's address bar.
- For more information about dev container configuration files, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers)."
- For more information about machine types, see "[AUTOTITLE](/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace#about-machine-types)."
- {% data reusables.codespaces.codespaces-machine-type-availability %}
* You can bookmark the options page to give you a quick way to create a codespace for this repository and branch.
* The [https://github.com/codespaces/new](https://github.com/codespaces/new) page provides a quick way to create a codespace for any repository and branch. You can get to this page quickly by typing `codespace.new` into your browser's address bar.
* For more information about dev container configuration files, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers)."
* For more information about machine types, see "[AUTOTITLE](/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace#about-machine-types)."
* {% data reusables.codespaces.codespaces-machine-type-availability %}
{% endnote %}
@@ -167,6 +167,6 @@ For full details of the options for this command, see [the {% data variables.pro
## Further reading
- "[AUTOTITLE](/codespaces/developing-in-a-codespace/opening-an-existing-codespace)"
- "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/setting-up-your-repository/facilitating-quick-creation-and-resumption-of-codespaces)"
- "[AUTOTITLE](/rest/codespaces/organizations)"
* "[AUTOTITLE](/codespaces/developing-in-a-codespace/opening-an-existing-codespace)"
* "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/setting-up-your-repository/facilitating-quick-creation-and-resumption-of-codespaces)"
* "[AUTOTITLE](/rest/codespaces/organizations)"

12
content/codespaces/developing-in-a-codespace/creating-a-codespace-from-a-template.md
View File

@@ -81,9 +81,9 @@ You can create a codespace from any template repository, then publish your work
When a codespace is published, you have access to a greater range of options to customize your {% data variables.product.prodname_github_codespaces %} experience. For example, you can:
- Change the machine type of your codespace to make sure you're using resources appropriate for the work you're doing (see "[AUTOTITLE](/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace)").
- Allow {% data variables.product.prodname_dotcom %} to automatically use GPG to sign commits you make in your codespace (see "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces)").
- Share secrets with your codespace (see "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-your-account-specific-secrets-for-github-codespaces)").
* Change the machine type of your codespace to make sure you're using resources appropriate for the work you're doing (see "[AUTOTITLE](/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace)").
* Allow {% data variables.product.prodname_dotcom %} to automatically use GPG to sign commits you make in your codespace (see "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces)").
* Share secrets with your codespace (see "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-your-account-specific-secrets-for-github-codespaces)").
### Publishing from {% data variables.product.prodname_dotcom_the_website %}
@@ -102,6 +102,6 @@ You can publish an unpublished codespace from the "Your codespaces" page on {% d
## Further reading
- "[AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository)"
- "[AUTOTITLE](/codespaces/getting-started/understanding-the-codespace-lifecycle)"
- "[AUTOTITLE](/codespaces/developing-in-a-codespace/using-source-control-in-your-codespace)"
* "[AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository)"
* "[AUTOTITLE](/codespaces/getting-started/understanding-the-codespace-lifecycle)"
* "[AUTOTITLE](/codespaces/developing-in-a-codespace/using-source-control-in-your-codespace)"

16
content/codespaces/developing-in-a-codespace/deleting-a-codespace.md
View File

@@ -21,9 +21,9 @@ shortTitle: Delete a codespace
{% data reusables.codespaces.automatic-deletion %} For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/configuring-automatic-deletion-of-your-codespaces?tool=webui)."
You can manually delete a codespace in a variety of ways:
- In the terminal by using {% data variables.product.prodname_cli %}
- In {% data variables.product.prodname_vscode %}
- In your web browser
* In the terminal by using {% data variables.product.prodname_cli %}
* In {% data variables.product.prodname_vscode %}
* In your web browser
Use the tabs at the top of this article to display instructions for each of these ways of deleting a codespace.
@@ -133,8 +133,8 @@ For more information, click the "{% data variables.product.prodname_cli %}" tab
{% cli %}
1. Enter one of these commands to display a list of codespaces.
- `gh codespace delete --org ORGANIZATION` - Lists the current codespaces in the specified organization.
- `gh codespace delete --org ORGANIZATION --user USER` - Lists only those codespaces created by the specified user.
* `gh codespace delete --org ORGANIZATION` - Lists the current codespaces in the specified organization.
* `gh codespace delete --org ORGANIZATION --user USER` - Lists only those codespaces created by the specified user.
You must be an owner of the specified organization.
1. In the list of codespaces, navigate to the codespace you want to delete.
1. To delete the selected codespace press <kbd>Enter</kbd>.
@@ -147,6 +147,6 @@ You can also use the REST API to delete codespaces for your organization. For mo
## Further reading
- "[AUTOTITLE](/codespaces/getting-started/understanding-the-codespace-lifecycle)"
- "[AUTOTITLE](/codespaces/setting-your-user-preferences/configuring-automatic-deletion-of-your-codespaces)"
- "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces)"
* "[AUTOTITLE](/codespaces/getting-started/understanding-the-codespace-lifecycle)"
* "[AUTOTITLE](/codespaces/setting-your-user-preferences/configuring-automatic-deletion-of-your-codespaces)"
* "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces)"

20
content/codespaces/developing-in-a-codespace/developing-in-a-codespace.md
View File

@@ -26,10 +26,10 @@ shortTitle: Develop in a codespace
You can develop code in a codespace using your choice of tool:
- A command shell, via an SSH connection initiated using {% data variables.product.prodname_cli %}.
- One of the JetBrains IDEs, via the JetBrains Gateway.
- The {% data variables.product.prodname_vscode %} desktop application.
- A browser-based version of {% data variables.product.prodname_vscode %}.
* A command shell, via an SSH connection initiated using {% data variables.product.prodname_cli %}.
* One of the JetBrains IDEs, via the JetBrains Gateway.
* The {% data variables.product.prodname_vscode %} desktop application.
* A browser-based version of {% data variables.product.prodname_vscode %}.
{% webui %}
@@ -92,9 +92,9 @@ The main components of the user interface are:
1. **Navigation bar** - This displays the path to the currently selected file or directory. Use the buttons to the right of the navigation bar to perform various actions, including building, running, or debugging the project, or running Git commands to commit and push your changes.
1. **Project tool window** - This shows you the structure of your project and allows you to open files in the editor.
1. **{% data variables.product.prodname_github_codespaces %} tool window** - This is displayed by clicking the {% data variables.product.prodname_github_codespaces %} plugin in the bar to the left of the tool window. It displays information about your codespace, including its display name and machine type. The buttons at the top of this tool window allow you to:
- Refresh the details in the tool window for the active codespace
- Display the "Your codespaces" web page
- View the codespace creation logs
* Refresh the details in the tool window for the active codespace
* Display the "Your codespaces" web page
* View the codespace creation logs
1. **Editor** - This is where you edit your files. You can right-click the tab for a file to access options such as moving the tab to a new window.
1. **Terminal** - This is displayed by clicking **Terminal** in the tool window bar at the bottom of the main window (just above the status bar). The integrated terminal allows you to perform command-line tasks without having to switch to a dedicated terminal application.
1. **Status bar** - Hover over the icon at the left of the status bar to see a list of tools. Click the icon to hide or show the tool window bars. The right side of the status bar shows information about the project, including the current Git branch.
@@ -117,9 +117,9 @@ For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/usi
## Further reading
- "[AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide)"
- "[AUTOTITLE](/codespaces/reference/using-the-github-codespaces-plugin-for-jetbrains)"
- "[AUTOTITLE](/codespaces/troubleshooting/troubleshooting-github-codespaces-clients)"
* "[AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide)"
* "[AUTOTITLE](/codespaces/reference/using-the-github-codespaces-plugin-for-jetbrains)"
* "[AUTOTITLE](/codespaces/troubleshooting/troubleshooting-github-codespaces-clients)"
{% endjetbrains_beta %}

32
content/codespaces/developing-in-a-codespace/opening-an-existing-codespace.md
View File

@@ -24,11 +24,11 @@ You can reopen any of your active or stopped codespaces on {% data variables.pro
You can view all your codespaces on the "Your codespaces" page at [github.com/codespaces](https://github.com/codespaces). From this page, you can:
- Open, stop, or delete your codespaces.
- See who owns (and may be billed for) your codespaces: your personal account, or organizations you belong to. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces)."
- See the machine type, size, and status of your codespaces.
- Create a new codespace, either by choosing one of {% data variables.product.company_short %}'s templates or by clicking **New codespace**. For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-from-a-template)" and "[AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository)."
- Prevent automatic deletion of a codespace. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/configuring-automatic-deletion-of-your-codespaces?tool=webui#avoiding-automatic-deletion-of-codespaces)."
* Open, stop, or delete your codespaces.
* See who owns (and may be billed for) your codespaces: your personal account, or organizations you belong to. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces)."
* See the machine type, size, and status of your codespaces.
* Create a new codespace, either by choosing one of {% data variables.product.company_short %}'s templates or by clicking **New codespace**. For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-from-a-template)" and "[AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository)."
* Prevent automatic deletion of a codespace. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/configuring-automatic-deletion-of-your-codespaces?tool=webui#avoiding-automatic-deletion-of-codespaces)."
{% webui %}
@@ -68,10 +68,10 @@ You can bookmark the address of this page if you want to get back to it quickly
![Screenshot of the "Open in" dialog, with "Open in {% data variables.product.prodname_vscode %}" highlighted.](/assets/images/help/codespaces/open-codespace-in-another-editor.png)
You can open the codespace in:
- Your browser
- {% data variables.product.prodname_vscode %}
- JetBrains Gateway
- JupyterLab
* Your browser
* {% data variables.product.prodname_vscode %}
* JetBrains Gateway
* JupyterLab
{% data reusables.codespaces.application-installed-locally %}
@@ -93,8 +93,8 @@ You can bookmark the address of this page if you want to get back to it quickly
1. In the {% data variables.product.prodname_vscode_shortname %} desktop application, open the Command Palette with <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Mac) or <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Windows/Linux).
1. Type "Codespaces" and select one of the following commands.
- To open a codespace in a new window of {% data variables.product.prodname_vscode_shortname %}, select **Codespaces: Open Codespace in New Window**
- To open a codespace in the web editor, select **Codespaces: Open in Browser**
* To open a codespace in a new window of {% data variables.product.prodname_vscode_shortname %}, select **Codespaces: Open Codespace in New Window**
* To open a codespace in the web editor, select **Codespaces: Open in Browser**
1. Click the codespace that you want to open.
![Screenshot of the {% data variables.product.prodname_vscode_shortname %} Command Palette showing a list of codespaces available to connect to.](/assets/images/help/codespaces/open-codespace-from-vscode.png)
@@ -116,7 +116,7 @@ You can also access the commands listed above by navigating to the Remote Explor
{% data reusables.codespaces.using-github-cli %}
1. In a terminal, enter one of the following {% data variables.product.prodname_cli %} commands.
- To open a codespace in {% data variables.product.prodname_vscode_shortname %}, enter:
* To open a codespace in {% data variables.product.prodname_vscode_shortname %}, enter:
```shell copy
gh codespace code
@@ -128,13 +128,13 @@ You can also access the commands listed above by navigating to the Remote Explor
{% endnote %}
- To open a codespace in the browser, enter:
* To open a codespace in the browser, enter:
```shell copy
gh codespace code --web
```
- To open a codespace in JupyterLab, enter:
* To open a codespace in JupyterLab, enter:
```shell copy
gh codespace jupyter
@@ -146,7 +146,7 @@ You can also access the commands listed above by navigating to the Remote Explor
{% endnote %}
- To access a codespace from the command line, over SSH, enter:
* To access a codespace from the command line, over SSH, enter:
```shell copy
gh codespace ssh
@@ -169,4 +169,4 @@ For more information, see [`gh codespace code`](https://cli.github.com/manual/gh
## Further reading
- "[AUTOTITLE](/rest/codespaces/organizations)"
* "[AUTOTITLE](/rest/codespaces/organizations)"

8
content/codespaces/developing-in-a-codespace/persisting-environment-variables-and-temporary-files.md
View File

@@ -30,9 +30,9 @@ After you save the change to this file, the value will be set the next time you
There are three ways that you can set persistent custom environment variables for all codespaces that you create for a repository:
- You can edit the `devcontainer.json` configuration file for the repository
- You can use a custom Dockerfile
- You can use development environment secrets
* You can edit the `devcontainer.json` configuration file for the repository
* You can use a custom Dockerfile
* You can use development environment secrets
#### Edit the `devcontainer.json` configuration file for the repository
@@ -82,4 +82,4 @@ If you have temporary files that you want to be available the next time you star
## Further reading
- "[AUTOTITLE](/codespaces/customizing-your-codespace/changing-the-shell-in-a-codespace)"
* "[AUTOTITLE](/codespaces/customizing-your-codespace/changing-the-shell-in-a-codespace)"

10
content/codespaces/developing-in-a-codespace/rebuilding-the-container-in-a-codespace.md
View File

@@ -18,13 +18,13 @@ redirect_from:
When you work in a codespace, your development environment is a Docker container that runs on a virtual machine. If you make changes to your dev container configuration from within a codespace, and you want to apply those changes to the current codespace, you need to rebuild the container.
By default, when you rebuild the dev container, {% data variables.product.prodname_github_codespaces %} will speed up the build process by reusing cached images from previous builds of the container. This is usually the quickest way to implement changes to your dev container configuration, for the following reasons.
- {% data variables.product.prodname_github_codespaces %} can reuse images in your cache rather than repulling them from container registries.
- The parts of your dev container configuration that define how the container is built, such as dev container features and Dockerfile instructions, may have already been implemented in image layers in your cache, so you won't need to wait for these processes to run again. (However, commands in your configuration that run after the container is built, such as `onCreateCommand`, will run again.)
* {% data variables.product.prodname_github_codespaces %} can reuse images in your cache rather than repulling them from container registries.
* The parts of your dev container configuration that define how the container is built, such as dev container features and Dockerfile instructions, may have already been implemented in image layers in your cache, so you won't need to wait for these processes to run again. (However, commands in your configuration that run after the container is built, such as `onCreateCommand`, will run again.)
Occasionally, you may want to perform a full rebuild of your container. With a full rebuild, {% data variables.product.prodname_github_codespaces %} cleans all Docker containers, images, and volumes from the cache, then rebuilds your container with newly pulled images. All the setup defined in your configuration will run again, generating new image layers. You may want to perform a full rebuild after many iterations of rebuilding your container with cached images, in situations such as the following.
- You want to ensure that the setup defined in your configuration is not dependent on cached images, and will run as required when someone creates a new codespace based on the configuration. For example, a dependency may have been removed from the base image since it was last pulled into your codespace.
- You want to free up the disk space used by your cache, for example if you are low on disk space or want to minimize storage charges. Your image cache might be using a significant amount of disk space if you've changed your base image multiple times, if you've made a large number of iterative changes to your configuration, or if you're running multiple containers with Docker Compose.
* You want to ensure that the setup defined in your configuration is not dependent on cached images, and will run as required when someone creates a new codespace based on the configuration. For example, a dependency may have been removed from the base image since it was last pulled into your codespace.
* You want to free up the disk space used by your cache, for example if you are low on disk space or want to minimize storage charges. Your image cache might be using a significant amount of disk space if you've changed your base image multiple times, if you've made a large number of iterative changes to your configuration, or if you're running multiple containers with Docker Compose.
## Rebuilding a container
@@ -63,4 +63,4 @@ ln -sf $PWD/.devcontainer/config $HOME/config && set +x
## Further reading
- "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers)"
* "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers)"

6
content/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace.md
View File

@@ -79,13 +79,13 @@ You can stop a codespace from the "Your codespaces" page (see [the web browser i
When you restart a codespace you can choose to open it in {% data variables.product.prodname_vscode %} or in your browser.
- To restart a codespace and open it in {% data variables.product.prodname_vscode %}, use the `gh codespace code` subcommand and then choose the codespace you want to restart from the list that's displayed.
* To restart a codespace and open it in {% data variables.product.prodname_vscode %}, use the `gh codespace code` subcommand and then choose the codespace you want to restart from the list that's displayed.
```shell copy
gh codespace code
```
- To restart a codespace and open it in your browser, use the `gh codespace open --web` subcommand and then choose the codespace you want to restart from the list that's displayed.
* To restart a codespace and open it in your browser, use the `gh codespace open --web` subcommand and then choose the codespace you want to restart from the list that's displayed.
```shell copy
gh codespace open --web
@@ -109,4 +109,4 @@ When you restart a codespace you can choose to open it in {% data variables.prod
## Further reading
- "[AUTOTITLE](/codespaces/getting-started/understanding-the-codespace-lifecycle)"
* "[AUTOTITLE](/codespaces/getting-started/understanding-the-codespace-lifecycle)"

6
content/codespaces/developing-in-a-codespace/using-github-codespaces-for-pull-requests.md
View File

@@ -21,9 +21,9 @@ Using a codespace to work on a pull request gives you all the benefits of {% dat
{% data variables.product.prodname_github_codespaces %} provides you with many of the capabilities you might need to work with pull requests:
- [Create a pull request](/codespaces/developing-in-a-codespace/using-source-control-in-your-codespace#raising-a-pull-request) - Using either the Terminal and Git commands or the "Source Control" view, you can create pull requests just as you would on {% data variables.product.prodname_dotcom_the_website %}. If the repository uses a pull request template, you'll be able to use this within the "Source Control" view.
- [Open a pull request](#opening-a-pull-request-in-codespaces) – You can open an existing pull request in a codespace, provided you have codespace access to the branch that is being merged in.
- [Review a pull request](#reviewing-a-pull-request-in-codespaces) - Once you have opened a pull request in a codespace, you can use the "GitHub Pull Request" view to add review comments and approve pull requests. You can also use {% data variables.product.prodname_github_codespaces %} to [view review comments](#view-comments-from-a-review-in-codespaces).
* [Create a pull request](/codespaces/developing-in-a-codespace/using-source-control-in-your-codespace#raising-a-pull-request) - Using either the Terminal and Git commands or the "Source Control" view, you can create pull requests just as you would on {% data variables.product.prodname_dotcom_the_website %}. If the repository uses a pull request template, you'll be able to use this within the "Source Control" view.
* [Open a pull request](#opening-a-pull-request-in-codespaces) – You can open an existing pull request in a codespace, provided you have codespace access to the branch that is being merged in.
* [Review a pull request](#reviewing-a-pull-request-in-codespaces) - Once you have opened a pull request in a codespace, you can use the "GitHub Pull Request" view to add review comments and approve pull requests. You can also use {% data variables.product.prodname_github_codespaces %} to [view review comments](#view-comments-from-a-review-in-codespaces).
## Opening a pull request in {% data variables.product.prodname_codespaces %}

4
content/codespaces/developing-in-a-codespace/using-github-codespaces-in-visual-studio-code.md
View File

@@ -93,5 +93,5 @@ To use {% data variables.product.prodname_github_codespaces %} in the Insiders v
## Further reading
- "[AUTOTITLE](/codespaces/reference/using-the-vs-code-command-palette-in-codespaces)"
- "[AUTOTITLE](/codespaces/reference/using-github-copilot-in-github-codespaces)"
* "[AUTOTITLE](/codespaces/reference/using-the-vs-code-command-palette-in-codespaces)"
* "[AUTOTITLE](/codespaces/reference/using-github-copilot-in-github-codespaces)"

28
content/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide.md
View File

@@ -33,20 +33,20 @@ When you work in a codespace, you use the JetBrains thin client application on y
The basic process behind using a codespace in your JetBrains IDE is as follows.
- In the JetBrains Gateway application you select one of your active or stopped codespaces.
- You then choose which JetBrains IDE you want to use.
- The selected JetBrains IDE is then downloaded to the remote virtual machine that hosts your codespace and source code.
- The JetBrains thin client application is then downloaded to your local machine and started.
- The client application connects to the full backend IDE.
- You can work on your code in the client application in just the same way you would in a local environment.
* In the JetBrains Gateway application you select one of your active or stopped codespaces.
* You then choose which JetBrains IDE you want to use.
* The selected JetBrains IDE is then downloaded to the remote virtual machine that hosts your codespace and source code.
* The JetBrains thin client application is then downloaded to your local machine and started.
* The client application connects to the full backend IDE.
* You can work on your code in the client application in just the same way you would in a local environment.
## Prerequisites
To work in a codespace in a JetBrains IDE you need:
- A valid JetBrains license.
- The JetBrains Gateway application, <!-- expires 2024-06-30 -->versions 2023.3.\* or 2024.1.\*.<!-- end expires 2024-06-30 -->
- An existing codespace running on a virtual machine that has at least 4 cores. The codespace must also be running an SSH server. For more information, see "[Codespace running an SSH server](#codespace-running-an-ssh-server)."
* A valid JetBrains license.
* The JetBrains Gateway application, <!-- expires 2024-06-30 -->versions 2023.3.\* or 2024.1.\*.<!-- end expires 2024-06-30 -->
* An existing codespace running on a virtual machine that has at least 4 cores. The codespace must also be running an SSH server. For more information, see "[Codespace running an SSH server](#codespace-running-an-ssh-server)."
### JetBrains license
@@ -104,8 +104,8 @@ The first time you use JetBrains Gateway for {% data variables.product.prodname_
1. Click the login link, below the login code.
1. If you are not currently signed in to {% data variables.product.prodname_dotcom %}, the sign-in page is displayed.
- Enter your details and click **Sign in**.
- Verify your authentication, for example by entering a two-factor authentication code.
* Enter your details and click **Sign in**.
* Verify your authentication, for example by entering a two-factor authentication code.
1. On the "Device activation" page, paste the copied code and click **Continue**.
1. If you belong to organizations, the "Single sign-on to your organizations" page is displayed. Click **Authorize** beside the organizations you want to authorize the JetBrains Gateway to access, then click **Continue**.
1. On the "Authorize {% data variables.product.prodname_github_codespaces %} for JetBrains" page, click **Authorize {% data variables.product.prodname_dotcom %}**.
@@ -123,6 +123,6 @@ The first time you use JetBrains Gateway for {% data variables.product.prodname_
## Further reading
- "[AUTOTITLE](/codespaces/developing-in-a-codespace/developing-in-a-codespace)"
- "[AUTOTITLE](/codespaces/reference/using-the-github-codespaces-plugin-for-jetbrains)"
- "[AUTOTITLE](/codespaces/troubleshooting/troubleshooting-github-codespaces-clients?tool=jetbrains)"
* "[AUTOTITLE](/codespaces/developing-in-a-codespace/developing-in-a-codespace)"
* "[AUTOTITLE](/codespaces/reference/using-the-github-codespaces-plugin-for-jetbrains)"
* "[AUTOTITLE](/codespaces/troubleshooting/troubleshooting-github-codespaces-clients?tool=jetbrains)"

70
content/codespaces/developing-in-a-codespace/using-github-codespaces-with-github-cli.md
View File

@@ -20,21 +20,21 @@ redirect_from:
{% data reusables.cli.about-cli %} For more information, see "[AUTOTITLE](/github-cli/github-cli/about-github-cli)."
You can work with {% data variables.product.prodname_github_codespaces %} in the {% data variables.product.prodname_cli %} to:
- [List all of your codespaces](#list-all-of-your-codespaces)
- [Create a new codespace](#create-a-new-codespace)
- [View details of a codespace](#view-details-of-a-codespace)
- [Stop a codespace](#stop-a-codespace)
- [Delete a codespace](#delete-a-codespace)
- [Rename a codespace](#rename-a-codespace)
- [Rebuild a codespace](#rebuild-a-codespace)
- [SSH into a codespace](#ssh-into-a-codespace)
- [Open a codespace in {% data variables.product.prodname_vscode %}](#open-a-codespace-in-visual-studio-code)
- [Open a codespace in JupyterLab](#open-a-codespace-in-jupyterlab)
- [Copy a file to/from a codespace](#copy-a-file-tofrom-a-codespace)
- [Modify ports in a codespace](#modify-ports-in-a-codespace)
- [Access codespace logs](#access-codespace-logs)
- [Access remote resources](#access-remote-resources)
- [Change the machine type of a codespace](#change-the-machine-type-of-a-codespace)
* [List all of your codespaces](#list-all-of-your-codespaces)
* [Create a new codespace](#create-a-new-codespace)
* [View details of a codespace](#view-details-of-a-codespace)
* [Stop a codespace](#stop-a-codespace)
* [Delete a codespace](#delete-a-codespace)
* [Rename a codespace](#rename-a-codespace)
* [Rebuild a codespace](#rebuild-a-codespace)
* [SSH into a codespace](#ssh-into-a-codespace)
* [Open a codespace in {% data variables.product.prodname_vscode %}](#open-a-codespace-in-visual-studio-code)
* [Open a codespace in JupyterLab](#open-a-codespace-in-jupyterlab)
* [Copy a file to/from a codespace](#copy-a-file-tofrom-a-codespace)
* [Modify ports in a codespace](#modify-ports-in-a-codespace)
* [Access codespace logs](#access-codespace-logs)
* [Access remote resources](#access-remote-resources)
* [Change the machine type of a codespace](#change-the-machine-type-of-a-codespace)
## Installing {% data variables.product.prodname_cli %}
@@ -48,13 +48,13 @@ To use `gh` to work with {% data variables.product.prodname_github_codespaces %}
As an example of a series of commands you might use to work with {% data variables.product.prodname_github_codespaces %}, you could:
- List your current codespaces, to check whether you have a codespace for a particular repository:<br>
* List your current codespaces, to check whether you have a codespace for a particular repository:<br>
`gh codespace list`
- Create a new codespace for the required repository branch:<br>
* Create a new codespace for the required repository branch:<br>
`gh codespace create -r github/docs -b main`
- SSH into the new codespace:<br>
* SSH into the new codespace:<br>
`gh codespace ssh -c octocat-literate-space-parakeet-7gwrqp9q9jcx4vq`
- Forward a port to your local machine:<br>
* Forward a port to your local machine:<br>
`gh codespace ports forward 8000:8000 -c octocat-literate-space-parakeet-7gwrqp9q9jcx4vq`
## `gh` commands for {% data variables.product.prodname_github_codespaces %}
@@ -94,15 +94,15 @@ gh codespace view
```
After running this command you are prompted to choose one of your existing codespaces. The following information is then displayed:
- Name of the codespace
- State (for example, "Available" or "Shutdown")
- Repository
- Git status
- Path to the dev container configuration file used to create the codespace
- Machine type
- Idle timeout
- Date and time the codespace was created
- Retention period
* Name of the codespace
* State (for example, "Available" or "Shutdown")
* Repository
* Git status
* Path to the dev container configuration file used to create the codespace
* Machine type
* Idle timeout
* Date and time the codespace was created
* Retention period
For more information, see the [{% data variables.product.prodname_dotcom %} CLI reference](https://cli.github.com/manual/gh_codespace_view).
@@ -186,31 +186,31 @@ The location of files and directories on the codespace is relative to the home d
#### Examples
- Copy a file from the local machine to the `$HOME` directory of a codespace:
* Copy a file from the local machine to the `$HOME` directory of a codespace:
`gh codespace cp myfile.txt remote:`
- Copy a file to the directory in which a repository is checked out in a codespace:
* Copy a file to the directory in which a repository is checked out in a codespace:
`gh codespace cp myfile.txt remote:/workspaces/REPOSITORY-NAME`
- Copy a file from a codespace to the current directory on the local machine:
* Copy a file from a codespace to the current directory on the local machine:
`gh codespace cp remote:myfile.txt .`
- Copy three local files to the `$HOME/temp` directory of a codespace:
* Copy three local files to the `$HOME/temp` directory of a codespace:
`gh codespace cp a1.txt a2.txt a3.txt remote:temp`
- Copy three files from a codespace to the current working directory on the local machine:
* Copy three files from a codespace to the current working directory on the local machine:
`gh codespace cp remote:a1.txt remote:a2.txt remote:a3.txt .`
- Copy a local directory into the `$HOME` directory of a codespace:
* Copy a local directory into the `$HOME` directory of a codespace:
`gh codespace cp -r mydir remote:`
- Copy a directory from a codespace to the local machine, changing the directory name:
* Copy a directory from a codespace to the local machine, changing the directory name:
`gh codespace cp -r remote:mydir mydir-localcopy`

22
content/codespaces/developing-in-a-codespace/using-source-control-in-your-codespace.md
View File

@@ -38,11 +38,11 @@ Source control in the {% data variables.product.prodname_vscode %} web client us
A typical workflow for updating a file using {% data variables.product.prodname_github_codespaces %} would be:
- From the default branch of your repository on {% data variables.product.prodname_dotcom %}, create a codespace. See "[AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository)."
- In your codespace, create a new branch to work on.
- Make your changes and save them.
- Commit the change.
- Raise a pull request.
* From the default branch of your repository on {% data variables.product.prodname_dotcom %}, create a codespace. See "[AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository)."
* In your codespace, create a new branch to work on.
* Make your changes and save them.
* Commit the change.
* Raise a pull request.
{% note %}
@@ -64,15 +64,15 @@ If you make a commit from the command line, you will see a prompt asking if you
**Notes:**
- If you delete your fork repository, then any codespaces linked to the fork are deleted, even if you originally created them from the upstream repository.
- If you make a commit from the command line and refuse the new fork by entering `n`, you should push your changes from the command line rather than from {% data variables.product.prodname_vscode_shortname %}'s Source Control view. If you use the Source Control view, {% data variables.product.prodname_vscode_shortname %} will still try to create a fork for you on push.
* If you delete your fork repository, then any codespaces linked to the fork are deleted, even if you originally created them from the upstream repository.
* If you make a commit from the command line and refuse the new fork by entering `n`, you should push your changes from the command line rather than from {% data variables.product.prodname_vscode_shortname %}'s Source Control view. If you use the Source Control view, {% data variables.product.prodname_vscode_shortname %} will still try to create a fork for you on push.
{% endnote %}
When {% data variables.product.prodname_github_codespaces %} creates a fork, or links your codespace to an existing fork, the following things happen.
- The access token associated with your codespace is updated to include `read` and `write` permission to your fork, in addition to `read` permission to the upstream repository.
- In your Git settings, the upstream repository is reassigned to the name `upstream`, and the fork is added as a new remote repository under the name `origin`.
* The access token associated with your codespace is updated to include `read` and `write` permission to your fork, in addition to `read` permission to the upstream repository.
* In your Git settings, the upstream repository is reassigned to the name `upstream`, and the fork is added as a new remote repository under the name `origin`.
By default, source control commands that you access from your editor's user interface, such as the **Sync Changes** button in {% data variables.product.prodname_vscode_shortname %}, target your fork. If you're working from the command line, you can use `origin` to refer to your fork and `upstream` to refer to the upstream repository. For example, you can fetch changes from the upstream repository to ensure your codespace is up to date with the latest changes to the project.
@@ -109,7 +109,7 @@ For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-re
![Screenshot of the status bar, with the tooltip for the branch name displayed. The branch icon and name, "main," are highlighted with a dark orange outline.](/assets/images/help/codespaces/jetbrains-branch-button.png)
1. In the pop-up menu, do one of the following:
- **To create a new branch based on the current branch**, click **New Branch**.
* **To create a new branch based on the current branch**, click **New Branch**.
![Screenshot of the branches pop-up menu with the "New Branch" option selected.](/assets/images/help/codespaces/jetbrains-new-branch-option.png)
@@ -117,7 +117,7 @@ For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-re
![Screenshot of the "Create New Branch" dialog, with "Create" and "Cancel" buttons. "my-branch" has been entered as a branch name.](/assets/images/help/codespaces/jetbrains-create-branch-dialog.png)
- **To check out an existing branch**, start typing the name of the branch you want to check out. Click the branch from the list, then click **Checkout**.
* **To check out an existing branch**, start typing the name of the branch you want to check out. Click the branch from the list, then click **Checkout**.
![Screenshot of the branches pop-up menu with the "origin/templates" branch selected and "Checkout" selected in the submenu.](/assets/images/help/codespaces/jetbrains-checkout-submenu.png)