Browse Source

Add `clone` and `reset` documentation.

Afshin Darian 6 years ago
parent
commit
1895b0d7ee
1 changed files with 34 additions and 2 deletions
  1. 34 2
      docs/source/user/interface.rst

+ 34 - 2
docs/source/user/interface.rst

@@ -184,7 +184,7 @@ menu:
 .. _urls:
 
 URLs (``/tree``, ``/workspaces``, etc.)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. _url-tree:
 
@@ -193,7 +193,7 @@ open a specific notebook or file. Additionally, JupyterLab URLs are an advanced
 part of the user interface that allows for managing workspaces. These two
 functions -- file paths and workspaces -- can be combined in URLs that open a
 specific file in a specific workspace. JupyterLab's file navigation URLS adopts
-the nomenclature of the classic notebook; these URLs are ``/tree/`` URLs:
+the nomenclature of the classic notebook; these URLs are ``/tree`` URLs:
 
 .. code-block:: none
 
@@ -224,3 +224,35 @@ Unlike the default (``/lab``) workspace, which only saves its state on the
 user's local browser, named workspaces save their state on the server, so a
 named workspace URL can be shared between multiple users (or browsers) as long
 as they have access to the same server.
+
+.. _url-clone:
+
+One useful feature of workspaces is the ability to ``clone`` the contents of a
+workspace into a new workspace.
+
+* To copy the contents of the workspace ``foo`` into the workspace ``bar``:
+  ``/lab/workspaces/bar?clone=foo``
+* To copy the contents of the default workspace into the workspace ``foo``:
+  ``/lab/workspaces/foo?clone``
+* To copy the contents of the workspace ``foo`` into the default workspace:
+  ``/lab?clone=foo``
+
+.. _url-reset:
+
+If something goes wrong with a workspace, or if simply needs to be cleared of
+its contents, it can be ``reset``.
+
+* To reset the contents of the workspace ``foo`` :
+  ``/lab/workspaces/foo?reset``
+* To reset the contents of the default workspace:
+  ``/lab?reset``
+
+These URL functions can be used separately as above, or in combination, *e.g.*:
+
+* To reset the workspace ``foo`` and to load a specific notebook afterward:
+  ``/lab/workspaces/foo/tree/path/to/notebook.ipynb?reset``
+* To clone the contents of the workspace ``bar`` into the workspace ``foo`` and
+  to load a notebook afterward:
+  ``/lab/workspaces/foo/tree/path/to/notebook.ipynb?clone=bar``
+* To reset the contents of the default workspace and to load a notebook:
+  ``/lab/tree/path/to/notebook.ipynb?reset``