Skip to content

Commit

Permalink
Rework content in admin/interfaces
Browse files Browse the repository at this point in the history
Moved into howto style content. I left out the
bits about 'Last Activity' - it is mostly self-evident,
and I'm not sure I want to encourage instructors looking
at when students last logged-in!
  • Loading branch information
yuvipanda committed Mar 8, 2021
1 parent a3d61f7 commit 986a38d
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 52 deletions.
Original file line number Diff line number Diff line change
@@ -1,18 +1,27 @@
# Access a user's server
# Controlling a user's server

Accessing a user's server is very useful when trying to debug or reproduce an issue they might have. This facility is available to admins via the admin panel.
Hub admins can unilaterally perform actions on user's servers via the
**Administrator's Panel**. These are primarily used to debug user's session
easily.

You can access the admin panel by clicking the 'Admin' button in the top bar
in your hub control panel. Alternatively, you can go to this URL in our
browser: `https://<your-hub-url>/hub/admin`.

1. You can access the admin panel by clicking the 'Admin' button in the top bar
in your hub control panel. Alternatively, you can go to this URL in our
browser: `https://<your-hub-url>/hub/admin`.

2. You can click `access server` to gain control of a user's currently running server. If it isn't running, you can click `start server` first and wait for it to start.
## Access a user's server

Accessing a user's server is very useful when trying to debug or reproduce an issue they might have. This facility is available to admins via the admin panel.

1. In the admin panel, you can click `access server` to gain control of a user's
currently running server. If it isn't running, you can click `start server`
first and wait for it to start.

```{figure} ../../images/access-server.png
Clicking "access server" will allow you to control the user's session.
```

3. This will bring you to the default interface that the user would have seen if they had just logged into the hub. From here, you can navigate to the notebook the user has reported issues with, and help them debug.
2. This will bring you to the default interface that the user would have seen if they had just logged into the hub. From here, you can navigate to the notebook the user has reported issues with, and help them debug.

```{warning}
If you both work on the same notebook at the same time, you will just
Expand All @@ -28,3 +37,12 @@ Accessing a user's server is very useful when trying to debug or reproduce an is
you are taking over their session, and using this feature mostly to understand what the user was trying to do, rather than to make major
changes to their code or notebook outputs.
```
## Stopping & starting a user's server
Sometimes, you need to just turn a user's server on and off. You can
also do this from the admin interface, by hitting the `Stop server`
button, waiting for the server to stop, and the `Start server` button
again. This is particularly useful when their session might have gotten
out of whack by packages they've installed temporarily that screwed up
the default, since a restart will wipe the slate clean.
File renamed without changes.
41 changes: 0 additions & 41 deletions admin/interfaces.md

This file was deleted.

8 changes: 4 additions & 4 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,7 @@ about/projects
:caption: Administrator Guide
:maxdepth: 1
admin/support
admin/environment
admin/interfaces
admin/data
admin/migrate
admin/content
Expand All @@ -39,12 +37,14 @@ admin/configuration/culling
```{toctree}
:caption: Administrator how-to guides
:maxdepth: 1
admin/howto/support
admin/howto/manage-users
admin/howto/access-server
admin/howto/control-user-server
```

```{toctree}
:maxdepth: 1
:caption: User's Guide
users/interface
```
```

0 comments on commit 986a38d

Please sign in to comment.