Docs: Add instructions for renaming and managing codespaces (closes #229) #250
Conversation
|
Regarding removing auto- deletion completely ie. having the codespace forever it is not available for organization owned repositories |
|
|
||
| 4. Rename your codespace for easier identification: | ||
|
|
||
| By default, your codespace will have a randomly generated name. Renaming it to |
There was a problem hiding this comment.
From this line onwards the indentation is incorrect. At least the first line of each paragraph and the first line of each bullet point should be indented four spaces so that it aligns to the right of the item number (4.). I recommend to indent all of the lines 4 spaces, to make it clearer in the markdown file that this content is part of listed item, rather than new content after the list.
| @@ -19,3 +19,27 @@ GitHub Codespaces' button and then click the green 'Create Codespace' button. | |||
|
|
|||
| 3. You will be taken to a VSCode editor within your browser. | |||
|  | |||
|
|
|||
| 4. Rename your codespace for easier identification: | |||
There was a problem hiding this comment.
| 4. Rename your codespace for easier identification: | |
| 4. Rename your codespace for easier identification. |
| on makes it much easier to find and manage your codespaces, especially if | ||
| you use several. | ||
|
|
||
| To rename your codespace:** |
There was a problem hiding this comment.
| on makes it much easier to find and manage your codespaces, especially if | |
| you use several. | |
| To rename your codespace:** | |
| on - makes it much easier to manage your codespaces: |
Try to keep the text succinct (so people bother to read it!) and avoid repetition
| - Enter a descriptive new display name (e.g., `r-dev-env-issue-229` or | ||
| `r-dev-env-patch-naming`) and confirm. |
There was a problem hiding this comment.
| - Enter a descriptive new display name (e.g., `r-dev-env-issue-229` or | |
| `r-dev-env-patch-naming`) and confirm. | |
| - Enter a descriptive new display name, e.g., `Bug 7084 - text() recycling problems` or `Ignore deprecated/defunct fns in checkS3methods`, and confirm. |
Remember the container is intended for working on bugs/features in R, not issues with the R dev container. It is not necessary to include r-dev-env in the name, as this is already shown (as you point out in the second bullet point here).
| - Enter a descriptive new display name (e.g., `r-dev-env-issue-229` or | ||
| `r-dev-env-patch-naming`) and confirm. | ||
|
|
||
|  |
There was a problem hiding this comment.
As this screenshot is intended to show how to select 'Rename', it would be good to have the current name be three random words. Also it would be great if you could find a tool that lets you take screenshots that show the cursor, as the change in colour under 'Rename' is not obvious. If this is not possible, perhaps you could post-edit the screenshot to add a red oval around the 'Rename' menu item. It would also be good to switch to light mode as the previous screen shot is in light mode (I fear we are not consistent across the docs, but I think it would be good be consistent on the same page). Finally, while I am a fan of screenshots where you can read the text, this is a bit too zoomed in. Aim for a zoom level where the regular text (like 'Rename') is a similar size to the normal text in the docs.
| > **Tip:** | ||
| > You can rename your codespace at any time. The display name is | ||
| for your convenience and does not affect your code or environment. |
There was a problem hiding this comment.
You should use an admonition block of type "tip" here, see https://squidfunk.github.io/mkdocs-material/reference/admonitions/#+type:tip
When people open the codespace, it is opened under their own account, so their personal settings apply. By default, inactive codespaces are automatically deleted 30 days after the last time they were stopped. Unchecking "Auto-delete codespace" from the three dots menu on https://github.com/codespaces definitely stops this from happening with the R Dev Container, this has been tested by contributors already. A little bookmark symbol appears next to the name for codespaces where auto-delete has been turned off. |
This PR updates the contributor documentation to add a new step for renaming GitHub Codespaces after creation. The new instructions guide users on how to change the codespace display name for easier identification, especially when working on multiple issues or features.
These changes address issue #229.