From bfca804fdc9a02bfdcc9dee0399ed4a6c3ac183d Mon Sep 17 00:00:00 2001 From: Jon Massey Date: Fri, 1 Nov 2024 17:32:45 +0000 Subject: [PATCH 1/2] Add deletion warning to "add codespaces" page Adding codespaces to a project seems to be the main landing place to which we direct researchers when introducing them to codespaces. Make the 30d retention policy very clear from the outset by copying the pre-existing warning from the "how to use codespaces" page. --- .../how-to/add-github-codespaces-to-your-project/index.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/getting-started/how-to/add-github-codespaces-to-your-project/index.md b/docs/getting-started/how-to/add-github-codespaces-to-your-project/index.md index 28f73b636..605be3c76 100644 --- a/docs/getting-started/how-to/add-github-codespaces-to-your-project/index.md +++ b/docs/getting-started/how-to/add-github-codespaces-to-your-project/index.md @@ -1,5 +1,10 @@ This page describes how to add GitHub Codespaces to your project. +!!! warning + Codespaces are automatically deleted after a period of inactivity and any changes not pushed to the GitHub repo will be lost. + For the `opensafely` organization, + this period is 30 days. + ## Does your project already have GitHub Codespaces? Newer projects already have GitHub Codespaces. From 6b2bbc7c999bbeaf68441758227dc78e7cb9522e Mon Sep 17 00:00:00 2001 From: Jon Massey Date: Fri, 1 Nov 2024 17:42:06 +0000 Subject: [PATCH 2/2] Explain lack of persistent storage for codespaces Explain that any un-pushed changes in a codespace will be lost upon its deletion. Describe GitHub integration and pushing your work to GitHub as a good remedy for potential data loss. --- .../explanation/understanding-github-codespaces/index.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/getting-started/explanation/understanding-github-codespaces/index.md b/docs/getting-started/explanation/understanding-github-codespaces/index.md index 469196908..dc71a11db 100644 --- a/docs/getting-started/explanation/understanding-github-codespaces/index.md +++ b/docs/getting-started/explanation/understanding-github-codespaces/index.md @@ -28,6 +28,14 @@ to work on OpenSAFELY projects. GitHub provide users with a free monthly quota of Codespaces use. +These cloud-hosted virtual machines have no persistent storage, +which is to say any data on them will be lost when the machine is deleted +if not saved elsewhere. +Codespaces are primarily designed for writing code +(such as an OpenSAFELY study) +and are tightly integrated with GitHub, +making it easy to commit and push your work to GitHub avoiding any data loss. + ## Understanding GitHub Codespaces billing GitHub gives all users a free and decent-sized monthly quota for Codespaces.