Skip to content

Docs: Add instructions for renaming and managing codespaces (closes #229) #257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: devel
Choose a base branch
from
Open

Docs: Add instructions for renaming and managing codespaces (closes #229) #257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/assets/rdev3_5.png
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From the screenshot, it is a bit hard to work out what's going on. I think it would help to highlight the ellipsis, mark that as "A" or "1", then highlight "Rename" as you have done, but mark that "B" or "2", to show the sequence of events.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 25 additions & 0 deletions docs/container_setup/github_codespace/creating_codespace.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,28 @@ GitHub Codespaces' button and then click the green 'Create Codespace' button.

3. You will be taken to a VS Code editor within your browser.
![codespace](../../assets/rdev3.png)

4. Rename your codespace for easier identification:

By default, your codespace will have a randomly generated name. Renaming it to
something descriptive — such as referencing the issue or feature you’re working
on makes it much easier to find and manage your codespaces:

**To Rename your codespace:**
Comment on lines +28 to +30
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As previously suggested (do not need line 30 here as it duplicates what is on line 24)

Suggested change
on makes it much easier to find and manage your codespaces:
**To Rename your codespace:**
on makes it much easier to manage your codespaces:


- Open your [GitHub Codespaces dashboard](https://github.com/codespaces) in
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's useful for people to know the url - I often get people to type it in directly.

Suggested change
- Open your [GitHub Codespaces dashboard](https://github.com/codespaces) in
- Open your [GitHub Codespaces dashboard](https://github.com/codespaces) (https://github.com/codespaces) in

your browser.
- Find the codespace you just created (it will show the repository name and
the current random display name).
- Click the ellipsis (**...**) next to your codespace to open the options menu.
- Select **Rename** from the dropdown.
- Enter a descriptive new display name, e.g.,
`Bug 7084 - text() recycling problems` or
`Ignore deprecated/defunct fns in checkS3methods`, and confirm.

![rename codespace](../../assets/rdev3_5.png)

!!! Tip

You can rename your codespace at any time. The display name is
for your convenience and **does not** affect your code or environment.