Skip to content
This repository was archived by the owner on Jun 30, 2024. It is now read-only.

Commit 822ba49

Browse files
committed
Docs: Name the Runestone virtual environment subdirectory rsvenv/.
Misc tweaks to other docs.
1 parent 7eefdc1 commit 822ba49

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

docker/README.rst

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -115,25 +115,25 @@ This download the bootstrap script.
115115
****************************************************
116116
A Python virtual environment ensures that all the Python dependencies installed by this process don't interfere with your global / system Python installation.
117117

118-
#. `Create a Python virtual environment <https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment>`_ named ``runestone``:
118+
#. `Create a Python virtual environment <https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment>`_ named ``rsvenv`` (RuneStone Virtual ENVironment):
119119

120120
.. code-block:: bash
121121
122-
python3 -m venv runestone
122+
python3 -m venv rsvenv
123123
124124
#. `Activate the virtual environment <https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#activating-a-virtual-environment>`_ you just created.
125125

126126
On Windows:
127127

128128
.. code-block:: bash
129129
130-
runestone\Scripts\activate
130+
rsvenv\Scripts\activate
131131
132132
On Linux and OS X:
133133

134134
.. code-block:: bash
135135
136-
. runestone/bin/activate
136+
. rsvenv/bin/activate
137137
138138
4. Run the bootstrap script
139139
***************************
@@ -205,7 +205,7 @@ The build will take a **long** time (5-10 minutes in many cases). When this comp
205205

206206
#. **Reboot your computer** to update your group membership.
207207
#. Run the Docker Desktop if using WSL on Windows or using OS X.
208-
#. Open a terminal then ``cd runestone``.
208+
#. Open a terminal then ``cd rsvenv``.
209209
#. Activate your virtual environment -- see the second step of `create a virtual environment <Create then activate a Python virtual environment>`_.
210210
#. ``cd RunestoneServer``.
211211

@@ -374,7 +374,7 @@ Once you have logged in as an instructor, you can bulk add students through the
374374
It is also possible to use a csv file to add multiple instructors or students as you start
375375
up the server. However, this process is brittle (any error loading the information results
376376
in the server entering a restart loop as it fails to load). To do so, make a file named either
377-
`instructors.csv` or `students.csv` in a folder called `configs` in the RunestoneServer folder.
377+
`instructors.csv` or `students.csv` in a folder called `configs` in the ``RunestoneServer/`` folder.
378378
The format of the csv files is to have one person per line with the format of each line as follows:
379379

380380
username,email,first_name,last_name,pw,course
@@ -389,7 +389,7 @@ The containerized application is configured to automatically start as soon as Do
389389

390390
Before using ``docker-tools`` or ``rsmanage``:
391391

392-
#. Open a terminal then ``cd runestone``.
392+
#. Open a terminal then ``cd rsvenv``.
393393
#. Activate your virtual environment -- see the second step of `create a virtual environment <Create then activate a Python virtual environment>`_.
394394
#. ``cd RunestoneServer``.
395395

@@ -423,14 +423,13 @@ Shelling Inside
423423
**********************************
424424

425425
You can shell into the container to look around, or otherwise test. When you enter,
426-
you'll be in the web2py folder, where runestone is an application under applications. From
427-
the RunestoneServer directory do:
426+
you'll be in the web2py folder, where ``runestone/`` is an application under ``applications/``. From the ``RunestoneServer/`` directory do:
428427

429428
.. code-block:: bash
430429
431430
docker-tools shell
432431
433-
Remember that the folder under web2py applications/runestone is bound to your host,
432+
Remember that the folder under ``web2py/applications/runestone`` is bound to your host,
434433
so **do not edit files from inside the container** otherwise they will have a change
435434
in permissions on the host.
436435

0 commit comments

Comments
 (0)