Scannability: Codespaces introductory content (#54688)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: hubwriter <hubwriter@github.com>
This commit is contained in:
@@ -20,7 +20,7 @@ The following features are currently unavailable on {% data variables.enterprise
|
|||||||
|
|
||||||
| Feature | Details | More information |
|
| Feature | Details | More information |
|
||||||
| :- | :- | :- |
|
| :- | :- | :- |
|
||||||
| {% data variables.product.prodname_github_codespaces %} | Currently unavailable. | [AUTOTITLE](/codespaces/overview) |
|
| {% data variables.product.prodname_github_codespaces %} | Currently unavailable. | [AUTOTITLE](/codespaces/quickstart) |
|
||||||
| {% data variables.product.prodname_marketplace %} | Currently, apps from {% data variables.product.prodname_marketplace %} are unavailable. {% data variables.product.prodname_actions %} workflows from {% data variables.product.prodname_marketplace %} may not function as expected. For more information, see [GitHub Actions workflows from GitHub Marketplace](#github-actions-workflows-from-github-marketplace). | [AUTOTITLE](/search-github/searching-on-github/searching-github-marketplace) | [AUTOTITLE](/enterprise-server@latest/admin/configuration/configuring-github-connect/about-github-connect#github-connect-features) in the {% data variables.product.prodname_ghe_server %} documentation |
|
| {% data variables.product.prodname_marketplace %} | Currently, apps from {% data variables.product.prodname_marketplace %} are unavailable. {% data variables.product.prodname_actions %} workflows from {% data variables.product.prodname_marketplace %} may not function as expected. For more information, see [GitHub Actions workflows from GitHub Marketplace](#github-actions-workflows-from-github-marketplace). | [AUTOTITLE](/search-github/searching-on-github/searching-github-marketplace) | [AUTOTITLE](/enterprise-server@latest/admin/configuration/configuring-github-connect/about-github-connect#github-connect-features) in the {% data variables.product.prodname_ghe_server %} documentation |
|
||||||
| macOS runners for {% data variables.product.prodname_actions %} | Currently unavailable. | [AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners) |
|
| macOS runners for {% data variables.product.prodname_actions %} | Currently unavailable. | [AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners) |
|
||||||
| Maven and Gradle support for {% data variables.product.prodname_registry %} | Currently unavailable. | [AUTOTITLE](/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry) |
|
| Maven and Gradle support for {% data variables.product.prodname_registry %} | Currently unavailable. | [AUTOTITLE](/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry) |
|
||||||
|
|||||||
@@ -34,7 +34,7 @@ The events listed in your security log are triggered by your actions. Actions ar
|
|||||||
| ------------- | ----------- |
|
| ------------- | ----------- |
|
||||||
| {% ifversion fpt or ghec %} |
|
| {% ifversion fpt or ghec %} |
|
||||||
| `billing` | Contains all activities related to your billing information. |
|
| `billing` | Contains all activities related to your billing information. |
|
||||||
| `codespaces` | Contains all activities related to {% data variables.product.prodname_github_codespaces %}. For more information, see [AUTOTITLE](/codespaces/overview). |
|
| `codespaces` | Contains all activities related to {% data variables.product.prodname_github_codespaces %}. For more information, see [AUTOTITLE](/codespaces/quickstart). |
|
||||||
| `copilot` | Contains all activities related to {% data variables.product.prodname_copilot_business_short %}. For more information, see [AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot). |
|
| `copilot` | Contains all activities related to {% data variables.product.prodname_copilot_business_short %}. For more information, see [AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot). |
|
||||||
| `marketplace_agreement_signature` | Contains all activities related to signing the {% data variables.product.prodname_marketplace %} Developer Agreement. |
|
| `marketplace_agreement_signature` | Contains all activities related to signing the {% data variables.product.prodname_marketplace %} Developer Agreement. |
|
||||||
| `marketplace_listing`| Contains all activities related to listing apps in {% data variables.product.prodname_marketplace %}. |
|
| `marketplace_listing`| Contains all activities related to listing apps in {% data variables.product.prodname_marketplace %}. |
|
||||||
|
|||||||
47
content/codespaces/about-codespaces/codespaces-features.md
Normal file
47
content/codespaces/about-codespaces/codespaces-features.md
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
---
|
||||||
|
title: GitHub Codespaces features
|
||||||
|
shortTitle: Codespaces features
|
||||||
|
allowTitleToDifferFromFilename: true
|
||||||
|
intro: 'Learn about what GitHub Codespaces offer.'
|
||||||
|
versions:
|
||||||
|
fpt: '*'
|
||||||
|
ghec: '*'
|
||||||
|
type: overview
|
||||||
|
topics:
|
||||||
|
- Codespaces
|
||||||
|
- Developer
|
||||||
|
---
|
||||||
|
|
||||||
|
## {% data variables.product.prodname_github_codespaces %} features
|
||||||
|
|
||||||
|
### Preconfigured development environments
|
||||||
|
|
||||||
|
You can work in a development environment that has been specifically configured for the repository. It will have all of the tools, languages, and configurations you need to work on that project. Everyone who works on that repository in a codespace will have the same environment. This reduces the likelihood of environment-related problems occurring and being difficult to debug. Each repository can have settings that will give contributors a ready-to-use, fit-for-purpose environment, and the environment on your local machine will be unchanged.
|
||||||
|
|
||||||
|
### Access the resources you need
|
||||||
|
|
||||||
|
Your local computer may not have the processing power, or storage space, you need to work on a project. {% data variables.product.prodname_github_codespaces %} allows you to work remotely on a machine with adequate resources.
|
||||||
|
|
||||||
|
### Work anywhere
|
||||||
|
|
||||||
|
All you need is a web browser. You can work in a codespace on your own computer, on a friend's laptop, or on a tablet. Open your codespace and pick up from where you left off on a different device.
|
||||||
|
|
||||||
|
### Choose your editor
|
||||||
|
|
||||||
|
Work in the browser, using the {% data variables.product.prodname_vscode_shortname %} web client or JupyterLab, or in the desktop-based {% data variables.product.prodname_vscode_shortname %} application.
|
||||||
|
|
||||||
|
### Work on multiple projects
|
||||||
|
|
||||||
|
You can use multiple codespaces to work on separate projects, or on different branches of the same repository, compartmentalizing your work to avoid changes made for one piece of work accidentally affecting something else you're working on.
|
||||||
|
|
||||||
|
### Pair program with a teammate
|
||||||
|
|
||||||
|
If you work on a codespace in {% data variables.product.prodname_vscode_shortname %}, you can use Live Share to work collaboratively with other people on your team. See [AUTOTITLE](/codespaces/developing-in-a-codespace/working-collaboratively-in-a-codespace).
|
||||||
|
|
||||||
|
### Publish your web app from a codespace
|
||||||
|
|
||||||
|
Forward a port from your codespace and then share the URL, to allow teammates to try out the changes you've made to the application before you submit those changes in a pull request.
|
||||||
|
|
||||||
|
### Try out a framework
|
||||||
|
|
||||||
|
{% data variables.product.prodname_github_codespaces %} reduces the setup time when you want to learn a new framework. Just create a codespace from one of the [quickstart templates](https://github.com/codespaces/templates).
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
title: 'Deep dive into {% data variables.product.prodname_github_codespaces %}'
|
title: 'Deep dive into {% data variables.product.prodname_github_codespaces %}'
|
||||||
shortTitle: 'Deep dive into {% data variables.product.prodname_codespaces %}'
|
shortTitle: 'Deep dive into {% data variables.product.prodname_codespaces %}'
|
||||||
intro: 'Understand how {% data variables.product.prodname_github_codespaces %} works.'
|
intro: 'Explore more detail about how {% data variables.product.prodname_github_codespaces %} work.'
|
||||||
allowTitleToDifferFromFilename: true
|
allowTitleToDifferFromFilename: true
|
||||||
versions:
|
versions:
|
||||||
fpt: '*'
|
fpt: '*'
|
||||||
@@ -9,6 +9,8 @@ versions:
|
|||||||
type: quick_start
|
type: quick_start
|
||||||
topics:
|
topics:
|
||||||
- Codespaces
|
- Codespaces
|
||||||
|
redirect_from:
|
||||||
|
- /codespaces/getting-started/deep-dive
|
||||||
---
|
---
|
||||||
|
|
||||||
{% data variables.product.prodname_github_codespaces %} is an instant, cloud-based development environment that uses a container to provide you with common languages, tools, and utilities for development. {% data variables.product.prodname_github_codespaces %} is also configurable, allowing you to create a customized development environment for your project. By configuring a custom development environment for your project, you can have a repeatable codespace configuration for all users of your project.
|
{% data variables.product.prodname_github_codespaces %} is an instant, cloud-based development environment that uses a container to provide you with common languages, tools, and utilities for development. {% data variables.product.prodname_github_codespaces %} is also configurable, allowing you to create a customized development environment for your project. By configuring a custom development environment for your project, you can have a repeatable codespace configuration for all users of your project.
|
||||||
@@ -150,4 +152,4 @@ If you want to make changes to your codespace that will be more robust over rebu
|
|||||||
* [AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/enabling-or-disabling-github-codespaces-for-your-organization)
|
* [AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/enabling-or-disabling-github-codespaces-for-your-organization)
|
||||||
* [AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/managing-the-cost-of-github-codespaces-in-your-organization)
|
* [AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/managing-the-cost-of-github-codespaces-in-your-organization)
|
||||||
* [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration)
|
* [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration)
|
||||||
* [AUTOTITLE](/codespaces/getting-started/understanding-the-codespace-lifecycle)
|
* [AUTOTITLE](/codespaces/about-codespaces/understanding-the-codespace-lifecycle)
|
||||||
@@ -7,8 +7,10 @@ versions:
|
|||||||
ghec: '*'
|
ghec: '*'
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /codespaces/getting-started-with-codespaces
|
- /codespaces/getting-started-with-codespaces
|
||||||
|
- /codespaces/getting-started
|
||||||
children:
|
children:
|
||||||
- /quickstart
|
- /what-are-codespaces
|
||||||
|
- /codespaces-features
|
||||||
- /understanding-the-codespace-lifecycle
|
- /understanding-the-codespace-lifecycle
|
||||||
- /deep-dive
|
- /deep-dive
|
||||||
---
|
---
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
title: Understanding the codespace lifecycle
|
title: Understanding the codespace lifecycle
|
||||||
shortTitle: The codespace lifecycle
|
shortTitle: The codespace lifecycle
|
||||||
intro: 'You can develop in a {% data variables.product.prodname_github_codespaces %} environment and maintain your data throughout the entire codespace lifecycle.'
|
intro: 'Learn how to develop in a {% data variables.product.prodname_github_codespaces %} environment, and maintain your data throughout the entire codespace lifecycle.'
|
||||||
versions:
|
versions:
|
||||||
fpt: '*'
|
fpt: '*'
|
||||||
ghec: '*'
|
ghec: '*'
|
||||||
@@ -12,11 +12,12 @@ topics:
|
|||||||
redirect_from:
|
redirect_from:
|
||||||
- /codespaces/developing-in-codespaces/codespaces-lifecycle
|
- /codespaces/developing-in-codespaces/codespaces-lifecycle
|
||||||
- /codespaces/developing-in-codespaces/the-codespace-lifecycle
|
- /codespaces/developing-in-codespaces/the-codespace-lifecycle
|
||||||
- /codespaces/getting-started/the-codespace-lifecycle
|
- /codespaces/about-codespaces/the-codespace-lifecycle
|
||||||
|
- /codespaces/getting-started/understanding-the-codespace-lifecycle
|
||||||
---
|
---
|
||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
> This article explains the stages in the life of a codespace, from creation to deletion. If you have read the [AUTOTITLE](/codespaces/getting-started/quickstart) article and you now want to start using {% data variables.product.prodname_github_codespaces %} for your own work, see the articles under [AUTOTITLE](/codespaces/developing-in-a-codespace).
|
> This article explains the stages in the life of a codespace, from creation to deletion. If you have read the [AUTOTITLE](/codespaces/quickstart) article and you now want to start using {% data variables.product.prodname_github_codespaces %} for your own work, see the articles under [AUTOTITLE](/codespaces/developing-in-a-codespace).
|
||||||
|
|
||||||
## About the lifecycle of a codespace
|
## About the lifecycle of a codespace
|
||||||
|
|
||||||
@@ -1,20 +1,16 @@
|
|||||||
---
|
---
|
||||||
title: GitHub Codespaces overview
|
title: 'What are {% data variables.product.prodname_github_codespaces %}?'
|
||||||
shortTitle: Overview
|
shortTitle: 'What are {% data variables.product.prodname_codespaces %}?'
|
||||||
intro: 'This guide introduces {% data variables.product.prodname_github_codespaces %} and provides details on how it works and how to use it.'
|
intro: 'Learn about what {% data variables.product.prodname_github_codespaces %} are.'
|
||||||
allowTitleToDifferFromFilename: true
|
allowTitleToDifferFromFilename: true
|
||||||
redirect_from:
|
|
||||||
- /codespaces/codespaces-reference/about-codespaces
|
|
||||||
- /github/developing-online-with-github-codespaces/about-github-codespaces
|
|
||||||
- /github/developing-online-with-codespaces/about-codespaces
|
|
||||||
- /codespaces/getting-started-with-codespaces/about-codespaces
|
|
||||||
- /codespaces/about-codespaces
|
|
||||||
versions:
|
versions:
|
||||||
fpt: '*'
|
fpt: '*'
|
||||||
ghec: '*'
|
ghec: '*'
|
||||||
type: overview
|
type: overview
|
||||||
topics:
|
topics:
|
||||||
- Codespaces
|
- Codespaces
|
||||||
|
redirect_from:
|
||||||
|
- /codespaces/overview
|
||||||
---
|
---
|
||||||
|
|
||||||
{% ifversion ghec %}
|
{% ifversion ghec %}
|
||||||
@@ -23,7 +19,7 @@ topics:
|
|||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
## What is a codespace?
|
## Introduction
|
||||||
|
|
||||||
A codespace is a development environment that's hosted in the cloud. You can customize your project for {% data variables.product.prodname_github_codespaces %} by committing configuration files to your repository (often known as Configuration-as-Code), which creates a repeatable codespace configuration for all users of your project. See [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers).
|
A codespace is a development environment that's hosted in the cloud. You can customize your project for {% data variables.product.prodname_github_codespaces %} by committing configuration files to your repository (often known as Configuration-as-Code), which creates a repeatable codespace configuration for all users of your project. See [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers).
|
||||||
|
|
||||||
@@ -35,19 +31,6 @@ You can connect to your codespaces from your browser, from {% data variables.pro
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
## Benefits of {% data variables.product.prodname_github_codespaces %}
|
|
||||||
|
|
||||||
Reasons for choosing to work in a codespace include:
|
|
||||||
|
|
||||||
* **Use a preconfigured development environment** - You can work in a development environment that has been specifically configured for the repository. It will have all of the tools, languages, and configurations you need to work on that project. Everyone who works on that repository in a codespace will have the same environment. This reduces the likelihood of environment-related problems occurring and being difficult to debug. Each repository can have settings that will give contributors a ready-to-use, fit-for-purpose environment, and the environment on your local machine will be unchanged.
|
|
||||||
* **Access the resources you need** - Your local computer may not have the processing power, or storage space, you need to work on a project. {% data variables.product.prodname_github_codespaces %} allows you to work remotely on a machine with adequate resources.
|
|
||||||
* **Work anywhere** - All you need is a web browser. You can work in a codespace on your own computer, on a friend's laptop, or on a tablet. Open your codespace and pick up from where you left off on a different device.
|
|
||||||
* **Choose your editor** - Work in the browser in the {% data variables.product.prodname_vscode_shortname %} web client, or choose from a selection of desktop-based applications.
|
|
||||||
* **Work on multiple projects** - You can use multiple codespaces to work on separate projects, or on different branches of the same repository, compartmentalizing your work to avoid changes made for one piece of work accidentally affecting something else you're working on.
|
|
||||||
* **Pair program with a teammate** - If you work on a codespace in {% data variables.product.prodname_vscode_shortname %}, you can use Live Share to work collaboratively with other people on your team. See [AUTOTITLE](/codespaces/developing-in-a-codespace/working-collaboratively-in-a-codespace).
|
|
||||||
* **Publish your web app from a codespace** - Forward a port from your codespace and then share the URL, to allow teammates to try out the changes you've made to the application before you submit those changes in a pull request.
|
|
||||||
* **Try out a framework** - {% data variables.product.prodname_github_codespaces %} reduces the setup time when you want to learn a new framework. Just create a codespace from one of the [quickstart templates](https://github.com/codespaces/templates).
|
|
||||||
|
|
||||||
## Using {% data variables.product.prodname_github_codespaces %}
|
## Using {% data variables.product.prodname_github_codespaces %}
|
||||||
|
|
||||||
To begin developing using cloud-based compute resources, you can create a codespace from a template or from any branch or commit in a repository. When you create a codespace from a template, you can start from a blank template or choose a template suitable for the work you're doing.
|
To begin developing using cloud-based compute resources, you can create a codespace from a template or from any branch or commit in a repository. When you create a codespace from a template, you can start from a blank template or choose a template suitable for the work you're doing.
|
||||||
@@ -29,7 +29,7 @@ If you don't want to use the default shell, you can open a new terminal session
|
|||||||
|
|
||||||
If you want to use a shell that isn't already installed in the base image or dev container configuration for a codespace, you can install a new shell.
|
If you want to use a shell that isn't already installed in the base image or dev container configuration for a codespace, you can install a new shell.
|
||||||
|
|
||||||
If you're using the default dev container image, look for installation instructions for Ubuntu Linux. If you just want to use a different shell for one session, you can use the command line to install the shell in the codespace you're working in. However, you may lose programs you have installed if you rebuild the container in the codespace. For more information, see [AUTOTITLE](/codespaces/getting-started/deep-dive#about-the-directory-structure-of-a-codespace).
|
If you're using the default dev container image, look for installation instructions for Ubuntu Linux. If you just want to use a different shell for one session, you can use the command line to install the shell in the codespace you're working in. However, you may lose programs you have installed if you rebuild the container in the codespace. For more information, see [AUTOTITLE](/codespaces/about-codespaces/deep-dive#about-the-directory-structure-of-a-codespace).
|
||||||
|
|
||||||
A more robust option for installing new shells is to include the installation commands either in a dotfiles repository, or as a lifecycle command such as `postCreateCommand` in a `devcontainer.json` file. You should use a dotfiles repository to install a shell you want to use in all your own codespaces, and a `devcontainer.json` file for a shell that contributors to a specific repository should have installed. For more information, see [AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#dotfiles) and [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers).
|
A more robust option for installing new shells is to include the installation commands either in a dotfiles repository, or as a lifecycle command such as `postCreateCommand` in a `devcontainer.json` file. You should use a dotfiles repository to install a shell you want to use in all your own codespaces, and a `devcontainer.json` file for a shell that contributors to a specific repository should have installed. For more information, see [AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#dotfiles) and [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers).
|
||||||
|
|
||||||
@@ -119,7 +119,7 @@ When you have connected to the codespace, for most shells, you can use the comma
|
|||||||
|
|
||||||
With most shells, you have the option of using a configuration file, such as `.bashrc`, to configure the shell with your preferred settings. These settings can include things like aliases and environment variables.
|
With most shells, you have the option of using a configuration file, such as `.bashrc`, to configure the shell with your preferred settings. These settings can include things like aliases and environment variables.
|
||||||
|
|
||||||
By default, codespaces contain predefined configuration for the shells that come preinstalled. For example, the home directory in a codespace contains `.bashrc` and `.zshrc` files. You can change the contents of these files then use a command like `source ~/.bashrc` to update your shell configuration. However, you will lose any changes to these files if you rebuild the container in a codespace. For more information, see [AUTOTITLE](/codespaces/getting-started/deep-dive#about-the-directory-structure-of-a-codespace).
|
By default, codespaces contain predefined configuration for the shells that come preinstalled. For example, the home directory in a codespace contains `.bashrc` and `.zshrc` files. You can change the contents of these files then use a command like `source ~/.bashrc` to update your shell configuration. However, you will lose any changes to these files if you rebuild the container in a codespace. For more information, see [AUTOTITLE](/codespaces/about-codespaces/deep-dive#about-the-directory-structure-of-a-codespace).
|
||||||
|
|
||||||
Generally, you should use a dotfiles repository to configure shells with your preferred settings. The setup in your dotfiles applies to all codespaces you create, and persists over rebuilds of the container. For more information, see [AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#dotfiles).
|
Generally, you should use a dotfiles repository to configure shells with your preferred settings. The setup in your dotfiles applies to all codespaces you create, and persists over rebuilds of the container. For more information, see [AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#dotfiles).
|
||||||
|
|
||||||
|
|||||||
@@ -55,9 +55,9 @@ When you create a codespace, a number of steps happen to create and connect you
|
|||||||
* Step 3: You can connect to the codespace.
|
* Step 3: You can connect to the codespace.
|
||||||
* Step 4: Codespace continues with post-creation setup.
|
* 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).
|
For more information on what happens when you create a codespace, see [AUTOTITLE](/codespaces/about-codespaces/deep-dive).
|
||||||
|
|
||||||
For more information on the lifecycle of a codespace, see [AUTOTITLE](/codespaces/getting-started/understanding-the-codespace-lifecycle).
|
For more information on the lifecycle of a codespace, see [AUTOTITLE](/codespaces/about-codespaces/understanding-the-codespace-lifecycle).
|
||||||
|
|
||||||
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 the dev container for your codespace is created after the repository is cloned, any [git template directory](https://git-scm.com/docs/git-init#_template_directory) configured in the dev container image will not apply to your codespace. Hooks must instead be installed after the codespace is created.
|
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 the dev container for your codespace is created after the repository is cloned, any [git template directory](https://git-scm.com/docs/git-init#_template_directory) configured in the dev container image will not apply to your codespace. Hooks must instead be installed after the codespace is created.
|
||||||
|
|
||||||
|
|||||||
@@ -102,5 +102,5 @@ You can publish an unpublished codespace from the "Your codespaces" page on {% d
|
|||||||
## Further reading
|
## Further reading
|
||||||
|
|
||||||
* [AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository)
|
* [AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository)
|
||||||
* [AUTOTITLE](/codespaces/getting-started/understanding-the-codespace-lifecycle)
|
* [AUTOTITLE](/codespaces/about-codespaces/understanding-the-codespace-lifecycle)
|
||||||
* [AUTOTITLE](/codespaces/developing-in-a-codespace/using-source-control-in-your-codespace)
|
* [AUTOTITLE](/codespaces/developing-in-a-codespace/using-source-control-in-your-codespace)
|
||||||
|
|||||||
@@ -141,6 +141,6 @@ You can also use the REST API to delete codespaces for your organization. See [A
|
|||||||
|
|
||||||
## Further reading
|
## Further reading
|
||||||
|
|
||||||
* [AUTOTITLE](/codespaces/getting-started/understanding-the-codespace-lifecycle)
|
* [AUTOTITLE](/codespaces/about-codespaces/understanding-the-codespace-lifecycle)
|
||||||
* [AUTOTITLE](/codespaces/setting-your-user-preferences/configuring-automatic-deletion-of-your-codespaces)
|
* [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/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces)
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ redirect_from:
|
|||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
You can reopen any of your active or stopped codespaces on {% data variables.product.github %}, in {% data variables.product.prodname_vscode %}, or by using {% data variables.product.prodname_cli %}. You can't reopen a codespace that has been deleted. See [AUTOTITLE](/codespaces/getting-started/understanding-the-codespace-lifecycle).
|
You can reopen any of your active or stopped codespaces on {% data variables.product.github %}, in {% data variables.product.prodname_vscode %}, or by using {% data variables.product.prodname_cli %}. You can't reopen a codespace that has been deleted. See [AUTOTITLE](/codespaces/about-codespaces/understanding-the-codespace-lifecycle).
|
||||||
|
|
||||||
You can view all your codespaces on the "Your codespaces" page at [github.com/codespaces](https://github.com/codespaces). From this page, you can:
|
You can view all your codespaces on the "Your codespaces" page at [github.com/codespaces](https://github.com/codespaces). From this page, you can:
|
||||||
|
|
||||||
|
|||||||
@@ -91,4 +91,4 @@ When you restart a codespace you can choose to open it in {% data variables.prod
|
|||||||
|
|
||||||
## Further reading
|
## Further reading
|
||||||
|
|
||||||
* [AUTOTITLE](/codespaces/getting-started/understanding-the-codespace-lifecycle)
|
* [AUTOTITLE](/codespaces/about-codespaces/understanding-the-codespace-lifecycle)
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ redirect_from:
|
|||||||
- /codespaces/developing-in-codespaces/using-github-codespaces-for-pull-requests
|
- /codespaces/developing-in-codespaces/using-github-codespaces-for-pull-requests
|
||||||
---
|
---
|
||||||
|
|
||||||
Using a codespace to work on a pull request gives you all the benefits of {% data variables.product.prodname_github_codespaces %}. For more information, see [AUTOTITLE](/codespaces/overview#benefits-of-github-codespaces).
|
Using a codespace to work on a pull request gives you all the benefits of {% data variables.product.prodname_github_codespaces %}. For more information, see [AUTOTITLE](/codespaces/about-codespaces/codespaces-features).
|
||||||
|
|
||||||
## About pull requests in {% data variables.product.prodname_github_codespaces %}
|
## About pull requests in {% data variables.product.prodname_github_codespaces %}
|
||||||
|
|
||||||
|
|||||||
@@ -109,7 +109,7 @@ For more information, see the [{% data variables.product.prodname_dotcom %} CLI
|
|||||||
gh codespace stop -c CODESPACE-NAME
|
gh codespace stop -c CODESPACE-NAME
|
||||||
```
|
```
|
||||||
|
|
||||||
For more information, see [AUTOTITLE](/codespaces/getting-started/deep-dive#closing-or-stopping-your-codespace).
|
For more information, see [AUTOTITLE](/codespaces/about-codespaces/deep-dive#closing-or-stopping-your-codespace).
|
||||||
|
|
||||||
### Delete a codespace
|
### Delete a codespace
|
||||||
|
|
||||||
|
|||||||
@@ -8,8 +8,8 @@ versions:
|
|||||||
fpt: '*'
|
fpt: '*'
|
||||||
ghec: '*'
|
ghec: '*'
|
||||||
includeGuides:
|
includeGuides:
|
||||||
- /codespaces/getting-started/quickstart
|
- /codespaces/quickstart
|
||||||
- /codespaces/getting-started/deep-dive
|
- /codespaces/about-codespaces/deep-dive
|
||||||
- /codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers
|
- /codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers
|
||||||
- /codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/setting-up-your-nodejs-project-for-codespaces
|
- /codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/setting-up-your-nodejs-project-for-codespaces
|
||||||
- /codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/setting-up-your-python-project-for-codespaces
|
- /codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/setting-up-your-python-project-for-codespaces
|
||||||
|
|||||||
@@ -3,17 +3,17 @@ title: "{% data variables.product.prodname_codespaces %} documentation"
|
|||||||
shortTitle: "{% data variables.product.prodname_codespaces %}"
|
shortTitle: "{% data variables.product.prodname_codespaces %}"
|
||||||
intro: 'Create a codespace to start developing in a secure, configurable, and dedicated development environment that works how and where you want it to.'
|
intro: 'Create a codespace to start developing in a secure, configurable, and dedicated development environment that works how and where you want it to.'
|
||||||
introLinks:
|
introLinks:
|
||||||
overview: /codespaces/overview
|
overview: /codespaces/about-codespaces/what-are-codespaces
|
||||||
quickstart: /codespaces/getting-started/quickstart
|
quickstart: /codespaces/quickstart
|
||||||
featuredLinks:
|
featuredLinks:
|
||||||
startHere:
|
startHere:
|
||||||
- /codespaces/managing-codespaces-for-your-organization/enabling-or-disabling-github-codespaces-for-your-organization
|
- /codespaces/managing-codespaces-for-your-organization/enabling-or-disabling-github-codespaces-for-your-organization
|
||||||
- /codespaces/getting-started/understanding-the-codespace-lifecycle
|
- /codespaces/about-codespaces/understanding-the-codespace-lifecycle
|
||||||
- /codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers
|
- /codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers
|
||||||
- /codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces
|
- /codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces
|
||||||
- /billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces
|
- /billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces
|
||||||
guideCards:
|
guideCards:
|
||||||
- /codespaces/getting-started/deep-dive
|
- /codespaces/about-codespaces/deep-dive
|
||||||
- /codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository
|
- /codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository
|
||||||
- /codespaces/developing-in-a-codespace/creating-a-codespace-from-a-template
|
- /codespaces/developing-in-a-codespace/creating-a-codespace-from-a-template
|
||||||
- /codespaces/developing-in-a-codespace/opening-an-existing-codespace
|
- /codespaces/developing-in-a-codespace/opening-an-existing-codespace
|
||||||
@@ -43,8 +43,8 @@ versions:
|
|||||||
fpt: '*'
|
fpt: '*'
|
||||||
ghec: '*'
|
ghec: '*'
|
||||||
children:
|
children:
|
||||||
- /overview
|
- /quickstart
|
||||||
- /getting-started
|
- /about-codespaces
|
||||||
- /developing-in-a-codespace
|
- /developing-in-a-codespace
|
||||||
- /customizing-your-codespace
|
- /customizing-your-codespace
|
||||||
- /setting-your-user-preferences
|
- /setting-your-user-preferences
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ product: '{% data reusables.gated-features.codespaces-org %}'
|
|||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
When you create a codespace, a development container is automatically created on a remote virtual machine. This dev container is created from a Docker image. The image is effectively a template for Docker containers and it determines many aspects of the resulting environment provided by the codespace. For more information, see [AUTOTITLE](/codespaces/overview#what-is-a-codespace).
|
When you create a codespace, a development container is automatically created on a remote virtual machine. This dev container is created from a Docker image. The image is effectively a template for Docker containers and it determines many aspects of the resulting environment provided by the codespace. For more information, see [AUTOTITLE](/codespaces/quickstart#introduction).
|
||||||
|
|
||||||
You can choose which image you want to use for your codespaces by specifying it in the dev container configuration for a repository. You can do this, for example, by using the `image` property in the `devcontainer.json` file.
|
You can choose which image you want to use for your codespaces by specifying it in the dev container configuration for a repository. You can do this, for example, by using the `image` property in the `devcontainer.json` file.
|
||||||
|
|
||||||
@@ -42,7 +42,7 @@ If the image for a codespace is specified in a Dockerfile, and does not match th
|
|||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
> * The dev container base image should not be confused with the host image. The host image is the image used to build the virtual machine on which the dev container runs. For more information, see [AUTOTITLE](/codespaces/setting-your-user-preferences/choosing-the-stable-or-beta-host-image).
|
> * The dev container base image should not be confused with the host image. The host image is the image used to build the virtual machine on which the dev container runs. For more information, see [AUTOTITLE](/codespaces/setting-your-user-preferences/choosing-the-stable-or-beta-host-image).
|
||||||
> * The base image policy is applied when a codespace is created, and when you perform a full container rebuild. For more information, see [AUTOTITLE](/codespaces/getting-started/understanding-the-codespace-lifecycle#rebuilding-a-codespace).
|
> * The base image policy is applied when a codespace is created, and when you perform a full container rebuild. For more information, see [AUTOTITLE](/codespaces/about-codespaces/understanding-the-codespace-lifecycle#rebuilding-a-codespace).
|
||||||
> * The base image policy does not apply to the default image, or the image that's used to recover a codespace if an error is introduced into a dev container configuration which prevents the container from being rebuilt.
|
> * The base image policy does not apply to the default image, or the image that's used to recover a codespace if an error is introduced into a dev container configuration which prevents the container from being rebuilt.
|
||||||
|
|
||||||
### Setting organization-wide and repository-specific policies
|
### Setting organization-wide and repository-specific policies
|
||||||
|
|||||||
@@ -1,16 +1,19 @@
|
|||||||
---
|
---
|
||||||
title: 'Quickstart for {% data variables.product.prodname_github_codespaces %}'
|
title: Quickstart for GitHub Codespaces
|
||||||
shortTitle: 'Quickstart for {% data variables.product.prodname_codespaces %}'
|
shortTitle: Quickstart
|
||||||
intro: 'Try out {% data variables.product.prodname_github_codespaces %} in 5 minutes.'
|
intro: 'Get started with {% data variables.product.prodname_github_codespaces %} quickly.'
|
||||||
allowTitleToDifferFromFilename: true
|
allowTitleToDifferFromFilename: true
|
||||||
|
redirect_from:
|
||||||
|
- /codespaces/codespaces-reference/about-codespaces
|
||||||
|
- /github/developing-online-with-github-codespaces/about-github-codespaces
|
||||||
|
- /github/developing-online-with-codespaces/about-codespaces
|
||||||
|
- /codespaces/getting-started-with-codespaces/about-codespaces
|
||||||
|
- /codespaces/getting-started/quickstart
|
||||||
versions:
|
versions:
|
||||||
fpt: '*'
|
fpt: '*'
|
||||||
ghec: '*'
|
ghec: '*'
|
||||||
type: quick_start
|
|
||||||
topics:
|
topics:
|
||||||
- Codespaces
|
- Codespaces
|
||||||
redirect_from:
|
|
||||||
- /codespaces/codespaces-quickstart
|
|
||||||
---
|
---
|
||||||
|
|
||||||
{% ifversion ghec %}
|
{% ifversion ghec %}
|
||||||
@@ -25,7 +28,7 @@ In this guide, you'll create a codespace from a template repository and explore
|
|||||||
|
|
||||||
From this quickstart, you'll learn how to create a codespace, connect to a forwarded port to view your running application, publish your codespace to a new repository, and personalize your setup with extensions.
|
From this quickstart, you'll learn how to create a codespace, connect to a forwarded port to view your running application, publish your codespace to a new repository, and personalize your setup with extensions.
|
||||||
|
|
||||||
For more information on exactly how {% data variables.product.prodname_github_codespaces %} works, see the companion guide [AUTOTITLE](/codespaces/getting-started/deep-dive).
|
For more information on exactly how {% data variables.product.prodname_github_codespaces %} works, see the companion guide [AUTOTITLE](/codespaces/about-codespaces/deep-dive).
|
||||||
|
|
||||||
## Creating your codespace
|
## Creating your codespace
|
||||||
|
|
||||||
@@ -110,7 +113,7 @@ You can enable Settings Sync to sync extensions and other settings across device
|
|||||||
|
|
||||||
You've successfully created, personalized, and run your first application within a codespace but there's so much more to explore! Here are some helpful resources for taking your next steps with {% data variables.product.prodname_github_codespaces %}.
|
You've successfully created, personalized, and run your first application within a codespace but there's so much more to explore! Here are some helpful resources for taking your next steps with {% data variables.product.prodname_github_codespaces %}.
|
||||||
|
|
||||||
* [AUTOTITLE](/codespaces/getting-started/deep-dive): This quickstart presented some of the features of {% data variables.product.prodname_github_codespaces %}. The deep dive looks at these areas from a technical standpoint.
|
* [AUTOTITLE](/codespaces/about-codespaces/deep-dive): This quickstart presented some of the features of {% data variables.product.prodname_github_codespaces %}. The deep dive looks at these areas from a technical standpoint.
|
||||||
* [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration): These guides provide information on setting up your repository to use {% data variables.product.prodname_github_codespaces %} with specific languages.
|
* [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration): These guides provide information on setting up your repository to use {% data variables.product.prodname_github_codespaces %} with specific languages.
|
||||||
* [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers): This guide provides details on creating a custom configuration for {% data variables.product.prodname_codespaces %} for your project.
|
* [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers): This guide provides details on creating a custom configuration for {% data variables.product.prodname_codespaces %} for your project.
|
||||||
|
|
||||||
@@ -13,7 +13,7 @@ topics:
|
|||||||
|
|
||||||
## About the virtual machine host image
|
## About the virtual machine host image
|
||||||
|
|
||||||
A {% data variables.product.prodname_dotcom %} codespace is a development environment provided by a Docker container that runs on a virtual machine (VM). For more information about the relationship of the development container and the VM, see [AUTOTITLE](/codespaces/overview#what-is-a-codespace).
|
A {% data variables.product.prodname_dotcom %} codespace is a development environment provided by a Docker container that runs on a virtual machine (VM). For more information about the relationship of the development container and the VM, see [AUTOTITLE](/codespaces/quickstart#introduction).
|
||||||
|
|
||||||
The VM for a codespace is built using a host image that defines the operating system of the VM. The image is periodically upgraded to improve security, functionality, and performance. The upgraded host image is initially made available as a beta release and subsequently becomes the stable release after a period of testing. You can choose, in your personal settings, to use either the stable or beta version of the host image. Any codespace you create or resume after changing this setting will run on a VM built from the specified host image.
|
The VM for a codespace is built using a host image that defines the operating system of the VM. The image is periodically upgraded to improve security, functionality, and performance. The upgraded host image is initially made available as a beta release and subsequently becomes the stable release after a period of testing. You can choose, in your personal settings, to use either the stable or beta version of the host image. Any codespace you create or resume after changing this setting will run on a VM built from the specified host image.
|
||||||
|
|
||||||
|
|||||||
@@ -161,6 +161,6 @@ You can also personalize {% data variables.product.prodname_github_codespaces %}
|
|||||||
## Further reading
|
## Further reading
|
||||||
|
|
||||||
* [AUTOTITLE](/repositories/creating-and-managing-repositories/creating-a-new-repository)
|
* [AUTOTITLE](/repositories/creating-and-managing-repositories/creating-a-new-repository)
|
||||||
* [AUTOTITLE](/codespaces/getting-started/deep-dive#personalizing-your-codespace-with-extensions-or-plugins)
|
* [AUTOTITLE](/codespaces/about-codespaces/deep-dive#personalizing-your-codespace-with-extensions-or-plugins)
|
||||||
* [AUTOTITLE](/codespaces/customizing-your-codespace)
|
* [AUTOTITLE](/codespaces/customizing-your-codespace)
|
||||||
* [AUTOTITLE](/codespaces/managing-your-codespaces)
|
* [AUTOTITLE](/codespaces/managing-your-codespaces)
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ versions:
|
|||||||
|
|
||||||
{% data variables.product.prodname_github_codespaces %} allows you to work in a development environment that's hosted remotely from your machine. You can get started quickly, without needing to set up the working environment or download files to your local computer.
|
{% data variables.product.prodname_github_codespaces %} allows you to work in a development environment that's hosted remotely from your machine. You can get started quickly, without needing to set up the working environment or download files to your local computer.
|
||||||
|
|
||||||
For more information, see [AUTOTITLE](/free-pro-team@latest/codespaces/overview).
|
For more information, see [AUTOTITLE](/free-pro-team@latest/codespaces/quickstart).
|
||||||
|
|
||||||
## Working on documentation in a codespace
|
## Working on documentation in a codespace
|
||||||
|
|
||||||
@@ -26,7 +26,7 @@ The following steps assume you have {% data variables.product.prodname_github_co
|
|||||||
The "Setting up your codespace" page is displayed. After a short time the browser-based version of {% data variables.product.prodname_vscode %} is displayed.
|
The "Setting up your codespace" page is displayed. After a short time the browser-based version of {% data variables.product.prodname_vscode %} is displayed.
|
||||||
1. Use the Explorer to navigate to the markdown file you want to edit. If the file is an article, it will be located in the `content` directory. If the file is reusable content, it will be located in the `data` directory.
|
1. Use the Explorer to navigate to the markdown file you want to edit. If the file is an article, it will be located in the `content` directory. If the file is reusable content, it will be located in the `data` directory.
|
||||||
|
|
||||||
In most cases, the path to an article in the `content` directory matches the path in the URL, minus the `.md` file extension. For example, the source for the article `https://docs.github.com/en/codespaces/getting-started/quickstart` is the markdown file `content/codespaces/getting-started/quickstart.md`.<!-- markdownlint-disable-line search-replace -->
|
In most cases, the path to an article in the `content` directory matches the path in the URL, minus the `.md` file extension. For example, the source for the article `https://docs.github.com/en/codespaces/quickstart` is the markdown file `content/codespaces/quickstart.md`.<!-- markdownlint-disable-line search-replace -->
|
||||||
1. Edit the markdown file as required.
|
1. Edit the markdown file as required.
|
||||||
1. Save your changes.
|
1. Save your changes.
|
||||||
1. Commit and push your changes, either using the Source Control view, or using Git commands from the Terminal. For more information, see [AUTOTITLE](/get-started/using-git/about-git).
|
1. Commit and push your changes, either using the Source Control view, or using Git commands from the Terminal. For more information, see [AUTOTITLE](/get-started/using-git/about-git).
|
||||||
|
|||||||
@@ -233,6 +233,6 @@ When you create a new diagram, add it to the Diagrams project in the Docs Figma
|
|||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
This diagram {% ifversion fpt or ghec %}from [AUTOTITLE](/codespaces/overview){% endif %} effectively uses rectangles within other rectangles to visually explain what parts of a codespace are contained in the cloud, and it uses arrows to show the relationship between a codespace hosted in the cloud and your local editor.
|
This diagram {% ifversion fpt or ghec %}from [AUTOTITLE](/codespaces/quickstart){% endif %} effectively uses rectangles within other rectangles to visually explain what parts of a codespace are contained in the cloud, and it uses arrows to show the relationship between a codespace hosted in the cloud and your local editor.
|
||||||
|
|
||||||

|

|
||||||
|
|||||||
@@ -35,7 +35,7 @@ Once you are a verified {% data variables.product.prodname_global_campus %} stud
|
|||||||
|
|
||||||
{% data variables.product.prodname_global_campus %} students also receive the following {% data variables.product.prodname_dotcom %} benefits.
|
{% data variables.product.prodname_global_campus %} students also receive the following {% data variables.product.prodname_dotcom %} benefits.
|
||||||
* **{% data variables.product.prodname_copilot %}:** Verified students receive a free subscription for {% data variables.product.prodname_copilot %}. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-free-access-to-copilot-as-a-student-teacher-or-maintainer).
|
* **{% data variables.product.prodname_copilot %}:** Verified students receive a free subscription for {% data variables.product.prodname_copilot %}. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-free-access-to-copilot-as-a-student-teacher-or-maintainer).
|
||||||
* **{% data variables.product.prodname_github_codespaces %}:** {% data reusables.education.student-codespaces-benefit %} For more information on getting started with {% data variables.product.prodname_github_codespaces %}, see [AUTOTITLE](/codespaces/overview).
|
* **{% data variables.product.prodname_github_codespaces %}:** {% data reusables.education.student-codespaces-benefit %} For more information on getting started with {% data variables.product.prodname_github_codespaces %}, see [AUTOTITLE](/codespaces/quickstart).
|
||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
> {% data reusables.education.note-on-student-codespaces-usage %} For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom).
|
> {% data reusables.education.note-on-student-codespaces-usage %} For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom).
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ permissions: 'Organization owners who are admins for a classroom can enable {% d
|
|||||||
---
|
---
|
||||||
## About {% data variables.product.prodname_github_codespaces %}
|
## About {% data variables.product.prodname_github_codespaces %}
|
||||||
|
|
||||||
{% data variables.product.prodname_github_codespaces %} is an instant, cloud-based development environment that uses a container to provide you with common languages, tools, and utilities for development. {% data variables.product.prodname_github_codespaces %} is also configurable, allowing you to create a customized development environment that is the same for all users of your project. See [AUTOTITLE](/codespaces/overview).
|
{% data variables.product.prodname_github_codespaces %} is an instant, cloud-based development environment that uses a container to provide you with common languages, tools, and utilities for development. {% data variables.product.prodname_github_codespaces %} is also configurable, allowing you to create a customized development environment that is the same for all users of your project. See [AUTOTITLE](/codespaces/quickstart).
|
||||||
|
|
||||||
Once {% data variables.product.prodname_github_codespaces %} is enabled in an organization or enterprise, users can create a codespace from any branch or commit in an organization or enterprise repository and begin developing using cloud-based compute resources. You can connect to a codespace from the browser or locally using {% data variables.product.prodname_vscode %}.
|
Once {% data variables.product.prodname_github_codespaces %} is enabled in an organization or enterprise, users can create a codespace from any branch or commit in an organization or enterprise repository and begin developing using cloud-based compute resources. You can connect to a codespace from the browser or locally using {% data variables.product.prodname_vscode %}.
|
||||||
|
|
||||||
@@ -80,4 +80,4 @@ Teachers can view each student's codespace for an assignment in the assignment o
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
When you connect to a codespace through a browser, auto-save is enabled automatically. If you want to save changes to the repository, you will need to commit the changes and push them to a remote branch. If you leave your codespace running without interaction for 30 minutes by default, the codespace will timeout and stop running. Your data will be preserved from the last time you made a change. For more information on the lifecycle of a codespace, see [AUTOTITLE](/codespaces/getting-started/the-codespace-lifecycle).
|
When you connect to a codespace through a browser, auto-save is enabled automatically. If you want to save changes to the repository, you will need to commit the changes and push them to a remote branch. If you leave your codespace running without interaction for 30 minutes by default, the codespace will timeout and stop running. Your data will be preserved from the last time you made a change. For more information on the lifecycle of a codespace, see [AUTOTITLE](/codespaces/about-codespaces/the-codespace-lifecycle).
|
||||||
|
|||||||
@@ -40,7 +40,7 @@ For a tutorial to help you get started with making changes in the browser, see [
|
|||||||
Working directly on {% data variables.location.product_location %} is best for small, simple changes, often targeting a single file in a repository. If you want to work in the browser but need to make more complex changes, such as moving content between files, you can choose from the following tools to open a repository in a dedicated editor.
|
Working directly on {% data variables.location.product_location %} is best for small, simple changes, often targeting a single file in a repository. If you want to work in the browser but need to make more complex changes, such as moving content between files, you can choose from the following tools to open a repository in a dedicated editor.
|
||||||
|
|
||||||
* If you want an editor where you can quickly open or create files, you can press the `.` key in any repository to open the github.dev editor. This is a lightweight web-based editor that includes many of the features of {% data variables.product.prodname_vscode %}, such as a search bar and buttons for Git commands. For more information, see [AUTOTITLE](/codespaces/the-githubdev-web-based-editor).
|
* If you want an editor where you can quickly open or create files, you can press the `.` key in any repository to open the github.dev editor. This is a lightweight web-based editor that includes many of the features of {% data variables.product.prodname_vscode %}, such as a search bar and buttons for Git commands. For more information, see [AUTOTITLE](/codespaces/the-githubdev-web-based-editor).
|
||||||
* If you want to stay in the browser but need to do things like run commands, create a test build of your project, or install dependencies, you can open a repository in a codespace. A codespace is a remote development environment with storage and compute power. It includes an editor and integrated terminal, and comes preinstalled with common tools you may need to work with a project, including Git. For more information, see [AUTOTITLE](/codespaces/overview).
|
* If you want to stay in the browser but need to do things like run commands, create a test build of your project, or install dependencies, you can open a repository in a codespace. A codespace is a remote development environment with storage and compute power. It includes an editor and integrated terminal, and comes preinstalled with common tools you may need to work with a project, including Git. For more information, see [AUTOTITLE](/codespaces/quickstart).
|
||||||
|
|
||||||
Alternatively, you can connect to {% data variables.product.github %} from your desktop, and work with a local copy of the repository.{% else %}Working directly in the browser is best for small, simple changes, often targeting a single file in a repository. If you want to make more complex changes, you may need to connect to {% data variables.product.github %} from the desktop, and work with a local copy of the repository.{% endif %}
|
Alternatively, you can connect to {% data variables.product.github %} from your desktop, and work with a local copy of the repository.{% else %}Working directly in the browser is best for small, simple changes, often targeting a single file in a repository. If you want to make more complex changes, you may need to connect to {% data variables.product.github %} from the desktop, and work with a local copy of the repository.{% endif %}
|
||||||
|
|
||||||
@@ -73,7 +73,7 @@ For more information about how to authenticate to {% data variables.product.gith
|
|||||||
| **On {% data variables.location.product_location %}** | You want a visual interface and need to make quick, simple changes, typically involving a single commit. For an introduction, see [AUTOTITLE](/get-started/start-your-journey/hello-world). | Browser |
|
| **On {% data variables.location.product_location %}** | You want a visual interface and need to make quick, simple changes, typically involving a single commit. For an introduction, see [AUTOTITLE](/get-started/start-your-journey/hello-world). | Browser |
|
||||||
| {% ifversion fpt or ghec %} |
|
| {% ifversion fpt or ghec %} |
|
||||||
| **github.dev** | You want to make more complex changes to a repository than is possible on {% data variables.product.prodname_dotcom_the_website %}, but don't need to work with a terminal or tools you have installed on your computer. For more information, see [AUTOTITLE](/codespaces/the-githubdev-web-based-editor#opening-the-githubdev-editor). | Browser |
|
| **github.dev** | You want to make more complex changes to a repository than is possible on {% data variables.product.prodname_dotcom_the_website %}, but don't need to work with a terminal or tools you have installed on your computer. For more information, see [AUTOTITLE](/codespaces/the-githubdev-web-based-editor#opening-the-githubdev-editor). | Browser |
|
||||||
| **{% data variables.product.prodname_github_codespaces %}** | You need the resources of a computer to do things like run scripts, create a test build of your project, or install dependencies, and you want to get started quickly by working in a cloud-based environment. For more information, see [AUTOTITLE](/codespaces/overview). | Browser or desktop |
|
| **{% data variables.product.prodname_github_codespaces %}** | You need the resources of a computer to do things like run scripts, create a test build of your project, or install dependencies, and you want to get started quickly by working in a cloud-based environment. For more information, see [AUTOTITLE](/codespaces/quickstart). | Browser or desktop |
|
||||||
| {% endif %} |
|
| {% endif %} |
|
||||||
| **{% data variables.product.prodname_desktop %}** | You want to work with files locally, and would prefer a visual interface to use Git, visualize changes, and interact with {% data variables.product.github %}. For more information, see [AUTOTITLE](/desktop/overview/about-github-desktop). | Desktop |
|
| **{% data variables.product.prodname_desktop %}** | You want to work with files locally, and would prefer a visual interface to use Git, visualize changes, and interact with {% data variables.product.github %}. For more information, see [AUTOTITLE](/desktop/overview/about-github-desktop). | Desktop |
|
||||||
| **IDE or text editor** | You're working with more complex files and projects and want everything in one place. | Desktop |
|
| **IDE or text editor** | You're working with more complex files and projects and want everything in one place. | Desktop |
|
||||||
|
|||||||
@@ -52,7 +52,7 @@ Before you submit your review, your line comments are _pending_ and only visible
|
|||||||
|
|
||||||
{% codespaces %}
|
{% codespaces %}
|
||||||
|
|
||||||
You can use [{% data variables.product.prodname_github_codespaces %}](/codespaces/overview) to test, run, and review pull requests.
|
You can use [{% data variables.product.prodname_github_codespaces %}](/codespaces/quickstart) to test, run, and review pull requests.
|
||||||
|
|
||||||
1. 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).
|
1. 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).
|
||||||
1. In the Activity Bar, click the **{% data variables.product.github %} Pull Request** view. This view only appears when you open a pull request in a codespace.
|
1. In the Activity Bar, click the **{% data variables.product.github %} Pull Request** view. This view only appears when you open a pull request in a codespace.
|
||||||
|
|||||||
@@ -32,7 +32,7 @@ Power users may want to read more about [debugging the docs application](./debug
|
|||||||
|
|
||||||
### Using GitHub Codespaces
|
### Using GitHub Codespaces
|
||||||
|
|
||||||
As an alternative, you can simply use [GitHub Codespaces](https://docs.github.com/en/codespaces/overview). For more information about using a codespace for working on GitHub documentation, see [Working in a codespace](https://github.com/github/docs/blob/main/contributing/codespace.md).
|
As an alternative, you can simply use [GitHub Codespaces](https://docs.github.com/en/codespaces/quickstart). For more information about using a codespace for working on GitHub documentation, see [Working in a codespace](https://github.com/github/docs/blob/main/contributing/codespace.md).
|
||||||
|
|
||||||
In a matter of minutes, you will be ready to edit, review and test your changes directly from the comfort of your browser.
|
In a matter of minutes, you will be ready to edit, review and test your changes directly from the comfort of your browser.
|
||||||
|
|
||||||
|
|||||||
@@ -1 +1 @@
|
|||||||
To get started with {% data variables.product.prodname_github_codespaces %}, see [AUTOTITLE](/codespaces/getting-started/quickstart). For more information on creating a codespace, see [AUTOTITLE](/codespaces/developing-in-codespaces/creating-a-codespace-for-a-repository) or [AUTOTITLE](/codespaces/developing-in-codespaces/creating-a-codespace-from-a-template). If you want to return to a codespace you've already created, see [AUTOTITLE](/codespaces/developing-in-codespaces/opening-an-existing-codespace). To learn more about how {% data variables.product.prodname_github_codespaces %} works, see [AUTOTITLE](/codespaces/getting-started/deep-dive).
|
To get started with {% data variables.product.prodname_github_codespaces %}, see [AUTOTITLE](/codespaces/quickstart). For more information on creating a codespace, see [AUTOTITLE](/codespaces/developing-in-codespaces/creating-a-codespace-for-a-repository) or [AUTOTITLE](/codespaces/developing-in-codespaces/creating-a-codespace-from-a-template). If you want to return to a codespace you've already created, see [AUTOTITLE](/codespaces/developing-in-codespaces/opening-an-existing-codespace). To learn more about how {% data variables.product.prodname_github_codespaces %} works, see [AUTOTITLE](/codespaces/about-codespaces/deep-dive).
|
||||||
|
|||||||
@@ -1,2 +1,2 @@
|
|||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
> When you rebuild the container in a codespace, changes you have made outside the `/workspaces` directory are cleared. Changes you have made inside the `/workspaces` directory, which includes the clone of the repository or template from which you created the codespace, are preserved over a rebuild. For more information, see [AUTOTITLE](/codespaces/getting-started/deep-dive#about-the-directory-structure-of-a-codespace).
|
> When you rebuild the container in a codespace, changes you have made outside the `/workspaces` directory are cleared. Changes you have made inside the `/workspaces` directory, which includes the clone of the repository or template from which you created the codespace, are preserved over a rebuild. For more information, see [AUTOTITLE](/codespaces/about-codespaces/deep-dive#about-the-directory-structure-of-a-codespace).
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
You can stop a codespace at any time. When you stop a codespace, any running processes are stopped. Any saved changes in your codespace will still be available when you next start it. The terminal history is preserved, but the visible contents of the terminal window are not preserved between codespace sessions.
|
You can stop a codespace at any time. When you stop a codespace, any running processes are stopped. Any saved changes in your codespace will still be available when you next start it. The terminal history is preserved, but the visible contents of the terminal window are not preserved between codespace sessions.
|
||||||
|
|
||||||
If you do not explicitly stop a codespace, it will continue to run until it times out from inactivity. Closing a codespace does not stop the codespace. For example, if you're using a codespace in the {% data variables.product.prodname_vscode_shortname %} web client and you close the browser tab, the codespace remains running on the remote machine. For information about timeouts, see [AUTOTITLE](/codespaces/getting-started/the-codespace-lifecycle#timeouts-for-github-codespaces).
|
If you do not explicitly stop a codespace, it will continue to run until it times out from inactivity. Closing a codespace does not stop the codespace. For example, if you're using a codespace in the {% data variables.product.prodname_vscode_shortname %} web client and you close the browser tab, the codespace remains running on the remote machine. For information about timeouts, see [AUTOTITLE](/codespaces/about-codespaces/the-codespace-lifecycle#timeouts-for-github-codespaces).
|
||||||
|
|
||||||
Only running codespaces incur CPU charges. A stopped codespace incurs only storage costs.
|
Only running codespaces incur CPU charges. A stopped codespace incurs only storage costs.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user