jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-23 03:44:00 -05:00
Code Issues Projects Releases Wiki Activity

Updates disaster doc with region selector option (#20559)

Browse Source 
Co-authored-by: Sarah Edwards <skedwards88@github.com>
This commit is contained in:
Allison Weins
2021-08-02 14:08:53 -07:00
committed by GitHub
parent df85a1e207
commit d0aa474a19
2 changed files with 21 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
assets/images/help/codespaces/codespaces-region-selector-radio-buttons.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 48 KiB

36
content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md
View File

@@ -19,19 +19,37 @@ The following guidance provides options on how to handle service disruption to t
{% endnote %}
## Option 1: Wait for recovery
## Option 1: Create a new codespace in another region
In the case of a regional outage, we suggest you recreate your codespace in an unaffected region to continue working. This new codespace will have all of the changes as of your last push to {% data variables.product.prodname_dotcom %}.
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.codespaces-tab %}
1. Under "Region", select the "Set manually" option and choose an unaffected region in the dropdown.
![Radio buttons to manage region selection](/assets/images/help/codespaces/codespaces-region-selector-radio-buttons.png)
2. Navigate back to your project's repository, use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu and select **Open with Codespaces**.
![Open with Codespaces button](/assets/images/help/codespaces/open-with-codespaces-button.png)
3. Click {% octicon "plus" aria-label="The plus icon" %} **New codespace** to create a new codespace in the specified region and continue working.
![New codespace button](/assets/images/help/codespaces/new-codespace-button.png)
You can optimize recovery time by configuring a `devcontainer.json` in the project's repository, which allows you to define the tools, runtimes, frameworks, editor settings, extensions, and other configuration necessary to restore the development environment automatically. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)."
## Option 2: Wait for recovery
In this case, no action on your part is required. Know that we are working diligently to restore service availability.
Check our [{% data variables.product.prodname_discussions %} page](https://github.com/github/feedback/discussions/categories/codespaces-feedback) for any updates on service interruptions. Soon, you'll be able to see the current service status on the [Status Dashboard](https://www.githubstatus.com/).
## Option 2: Clone the repository locally or edit in the browser
## Option 3: Clone the repository locally or edit in the browser
While {% data variables.product.prodname_codespaces %} provides the benefit of a pre-configured developer environmnent, your source code should always be accessible through the repository hosted on {% data variables.product.prodname_dotcom_the_website %}. In the event of a {% data variables.product.prodname_codespaces %} outage, you can still clone the repository locally or edit files in the {% data variables.product.company_short %} browser editor. For more information, see [Editing files in your repository](/github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-your-repository).
While this option does not configure a development environment for you, it will allow you to make changes to your source code as needed while you wait for the service disruption to resolve.
## Option 3: Use Remote-Containers and Docker for a local containerized environment
## Option 4: Use Remote-Containers and Docker for a local containerized environment
If your repository has a `devcontainer.json`, consider using the [Remote-Containers extension](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-a-git-repository-or-github-pr-in-an-isolated-container-volume) in Visual Studio Code to build and attach to a local development container for your repository. The setup time for this option will vary depending on your local specifications and the complexity of your dev container setup.
@@ -40,15 +58,3 @@ If your repository has a `devcontainer.json`, consider using the [Remote-Contain
**Note:** Be sure your local setup meets the [minimum requirements](https://code.visualstudio.com/docs/remote/containers#_system-requirements) before attempting this option.
{% endnote %}
## Coming soon: Create a new codespace in another region
{% note %}
**Note:** This option is not yet available in {% data variables.product.prodname_codespaces %}
{% endnote %}
You'll soon be able to specify the region when you create a codespace. When this option becomes available, we suggest you recreate your codespace in an unaffected region to continue working in the case of a regional outage. This new codespace will have all of the changes as of your last push to {% data variables.product.prodname_dotcom %}.
You can optimize recovery time in by configuring a `devcontainer.json` in the project's repository, which allows you to define the tools, runtimes, frameworks, editor settings, extensions, and other configuration necessary to restore the development environment automatically. See [Configuring Codespace for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project).