From fab0b4202d42337044c896826c0e58e2270e3b04 Mon Sep 17 00:00:00 2001 From: Lucy Bridges Date: Mon, 28 Oct 2024 13:18:16 +0000 Subject: [PATCH] Explaining Codespaces recovery mode 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. --- .../how-to/troubleshoot-common-codespaces-issues/index.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/getting-started/how-to/troubleshoot-common-codespaces-issues/index.md b/docs/getting-started/how-to/troubleshoot-common-codespaces-issues/index.md index 69b67ae4..b91ed79a 100644 --- a/docs/getting-started/how-to/troubleshoot-common-codespaces-issues/index.md +++ b/docs/getting-started/how-to/troubleshoot-common-codespaces-issues/index.md @@ -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: