From 6675c3188b37e34c823de2bdd19ae66d8dfbadf0 Mon Sep 17 00:00:00 2001 From: Jonathan Cooper Date: Fri, 5 Apr 2024 14:05:29 +0100 Subject: [PATCH] added RStudio how-to page to content page of Docs ed-17 --- docs/src/SUMMARY.md | 1 + .../rstudio-single-user-explanation/README.md | 21 +++++++++++-------- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index e262bc512..b34a2bc64 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -68,6 +68,7 @@ * [How to...](howto/README.md) * [Use the Asset Repo](howto/use-the-asset-repo/README.md) * [Suspend and Restart Resources](howto/suspend-and-restart-resources/README.md) + * [Collaborate on an RStudio notebook](howto/rstudio-single-user-explanation/README.md) * [Managing packages within R](r-libs/README.md) * [Packrat on Spark](r-libs/packrat_on_spark.md) * [Packrat within RStudio](r-libs/packrat_within_rstudio.md) diff --git a/docs/src/howto/rstudio-single-user-explanation/README.md b/docs/src/howto/rstudio-single-user-explanation/README.md index 3d728bb59..d11a027a1 100644 --- a/docs/src/howto/rstudio-single-user-explanation/README.md +++ b/docs/src/howto/rstudio-single-user-explanation/README.md @@ -1,14 +1,17 @@ -# Single use of a project's RStudio notebook # +# Single user restriction of an RStudio notebook # -## Why is this warning displayed? ## +An RStudio notebook can only be opened by one user at a time. This means that +multiple users in a project cannot work on the same notebook simultaneously. +The consequence of opening an RStudio notebook that someone else is currently +using is to end their session. -Currently, an Rstudio notebook in DataLabs does not support being opened in multiple -instances. This warning is displayed if the notebook you are about to open may be -in use by another user. If the notebook has been opened recently (eg within the last -8 hours) then this warning is shown. This is important because if you proceed -to open the notebook then the current user will have their instance closed, causing -some disruption to them. +## How will I know if a notebook is in use ## + +The link to an RStudio notebook will display a warning if it has been opened recently +(eg within the last 8 hours). This indicates that it may be in use by another user. +This is important because if you proceed to open the notebook then the current user will +have their instance closed, causing some disruption to them. ## What does this warning look like ## @@ -19,4 +22,4 @@ Here is an example of what this warning looks like. ## What should I do? ## If you are aware of a colleague who may be using the notebook, it would be prudent to -discuss using it with them. +discuss the best way to work together on it.