Skip to content

Commit

Permalink
Explaining Codespaces recovery mode
Browse files Browse the repository at this point in the history
Provide researchers with information about what to do if their Codespace is in
recovery mode and what that means.

In response to opensafely-core/research-template-docker#74 and
opensafely-core/research-template-docker#75.
  • Loading branch information
lucyb committed Oct 28, 2024
1 parent f6841b7 commit fab0b42
Showing 1 changed file with 6 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ This is perfectly normal and is a result of how we have configured Codespaces to
If you plan to use Stata in your project, then you will need to click the "Authorize and continue" button.
If you do not plan to use Stata, then you may click either button.

## My Codespace says it's in "recovery mode"

Occasionally when creating a Codespace something goes wrong. In these instances, GitHub will boot the Codespace into a "recovery mode". This provides you with a very basic environment in which to debug the problem. If this happens, either delete it and try again or contact tech support. If you contact tech support, then don't delete the Codespace, as it's likely you'll be asked for the creation logs so the problem can be investigated.

In recovery mode, you will not be able to access any of the usual tools or VS Code plugins. Some basic functionality, like copy and paste, may not work as expected either. So you should not attempt you use it for any work. GitHub provide some more information about Codespace recovery mode in their [documentation](https://docs.github.com/en/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces#codespace-creation-fails).

## R Session Error

After restarting a stopped Codespace in which you were using RStudio, you may see the following error:
Expand Down

0 comments on commit fab0b42

Please sign in to comment.