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

Commit cf29f3a

Browse files
committed
Docs: Point to PreTeXt author resources.
Clean up text a bit.
1 parent af9bae0 commit cf29f3a

File tree

1 file changed

+7
-15
lines changed

1 file changed

+7
-15
lines changed

docker/README.rst

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -254,11 +254,11 @@ No books are installed by default; you must add books using the following proces
254254
255255
rsmanage build --course thinkcspy --clone https://github.com/RunestoneInteractive/thinkcspy.git
256256
257+
After cloning a book, you may need to add it to the database. Most of the standard books are already there, but you can use ``rsmanage addcourse`` to add it if needed.
257258

258259
.. note::
259260

260-
TODO: Edit/improve the docs from this point forward.
261-
261+
PreTeXt authors, see `Publishing to Runestone Academy <https://pretextbook.org/doc/guide/html/sec-publishing-to-runestone-academy.html>`_. The following information applies only *authoring* books using the Runestone.
262262

263263
.. warning::
264264

@@ -268,8 +268,6 @@ No books are installed by default; you must add books using the following proces
268268
If there is a mismatch, you will want to rename the folder you cloned the code into so that it
269269
matches the ``project_name``.
270270

271-
After cloning a book, you may need to add it to the database. Most of the standard books are already there, but you can use ``rsmanage addcourse`` to add it if needed.
272-
273271
.. note::
274272

275273
Most Runestone books set ``master_url`` to ``get_master_url()`` in their ``pavement.py`` file. However, if the book
@@ -349,7 +347,7 @@ trying to load the same records and entering a restart loop because the records
349347

350348
Operation
351349
---------
352-
The containerized application is configured to automatically start as soon as Docker / the Docker Desktop is started. Therefore, on OS X or Windows (when using WSL2): after a reboot or after manually shutting down the Docker Desktop, remember to start the Docker Desktop application.
350+
The containerized application is configured to automatically start as soon as Docker / the Docker Desktop is started. Therefore, on OS X or Windows (when using WSL2): after a reboot or after manually shutting down the Docker Desktop, **remember to start the Docker Desktop application**.
353351

354352

355353
Other Tips & Tricks
@@ -441,23 +439,17 @@ container enough privileges to do your work.
441439
Writing Your Own Book
442440
**********************************
443441

442+
.. note::
443+
444+
PreTeXt authors, see `Publishing to Runestone Academy <https://pretextbook.org/doc/guide/html/sec-publishing-to-runestone-academy.html>`_. The following information applies only *authoring* books using the Runestone.
445+
444446
If you are writing your own book you will want to get that book set up properly in the Runestone
445447
system. You need to do the following:
446448

447449
#. Run the command ``rsmanage addcourse``. Use the project name you configured in ``pavement.py`` as the name of BOTH the course and the basecourse when it asks.
448450

449451
#. Now that your course is registered, rebuild it using the command ``rsmanage build --course <book_name>`` command.
450452

451-
#. If this book is a PreTeXt book you will need to navigate to the directory that contains the ``runestone-manifest.xml`` file and run the command:
452-
453-
.. code-block:: bash
454-
455-
runestone process-manifest --course <yourcourse> --manifest runestone-manifest.xml
456-
457-
.. note::
458-
459-
If you are missing ``runestone-manifest.xml`` then you need to rebuild your PreTeXt
460-
book with ``runestone`` as the publisher. See the PreTeXt docs for how do do this.
461453

462454
Changing dependencies
463455
*********************

0 commit comments

Comments
 (0)