From 5cf07c453f06af3647fc2175355cf4b1773696eb Mon Sep 17 00:00:00 2001 From: yuvipanda Date: Fri, 3 Aug 2018 14:54:05 -0700 Subject: [PATCH] Fix rst syntax errors - Add sudo wherever required --- docs/howto/share-data.rst | 35 +++++++++++++++++++---------------- 1 file changed, 19 insertions(+), 16 deletions(-) diff --git a/docs/howto/share-data.rst b/docs/howto/share-data.rst index 55b30aa..8e68e88 100644 --- a/docs/howto/share-data.rst +++ b/docs/howto/share-data.rst @@ -16,7 +16,7 @@ contained in the link's target repository is downloaded to the user's home directory. Note that a copy of the dataset will be made for each user. For information on creating and sharing ``nbgitpuller`` links, see -:ref:`_tutorials/nbgitpuller`. +:ref:`tutorials/nbgitpuller`. Distributing data with a read-only shared folder ================================================ @@ -29,31 +29,34 @@ steps: #. Create a terminal session within your JupyterHub interface. #. Create a folder where your data will live: - ``` - mkdir /srv/data/mydatafolder - ``` -#. Download the data into this folder. For example, using `curl` or by running - a `python` script that downloads the data. + .. code-block:: bash + + sudo mkdir /srv/data/mydatafolder + +#. Download the data into this folder. For example, using ``sudo curl`` or by running + a ``python`` script that downloads the data. #. All users now have read access to the data in this folder. Optionally, you may also **create a symbolic link to the data folder** in each -new user's home directory. To do this, you can use the VM's "skeleton" -directory (`/etc/skel`). Anything that is placed in this directory will also +**new user's** home directory. To do this, you can use the server's "user skeleton" +directory (``/etc/skel``). Anything that is placed in this directory will also show up in a new user's home directory. To create a link to the dataset, follow these steps: #. Change into the skeleton directory: - ``` - cd /etc/skel - ``` + .. code-block:: bash + + cd /etc/skel + #. Create a symbolic link to the data folder - ``` - ln -s /src/data/mydatafolder mydatafolder - ``` + .. code-block:: bash + + sudo ln -s /src/data/mydatafolder mydatafolder From now on, when a new user account is created, their home directory will -have this symbolic link (and any other files in `/etc/skel`) in their home -directory. +have this symbolic link (and any other files in ``/etc/skel``) in their home +directory. This will have no effects on the home directories of existing +users.