|
|
@@ -303,10 +303,10 @@ Updating Tutorial Documentation
|
|
|
-------------------------------
|
|
|
|
|
|
From time to time, the documentation for the tutorial will need to be updated. You can work directly in
|
|
|
-the tutorial site by loading the fixture file for its database (read more at :ref:`load-data`).
|
|
|
+the tutorial site by loading the fixture file for its database (read more at :ref:`load-data`).
|
|
|
|
|
|
However, once you have worked in the tutorial site and gotten new screenshots for the **Getting Started** documentation,
|
|
|
-you will also need to update the fixture file, which is located in ``tutorial > mysite > website > fixtures``.
|
|
|
+you will also need to update the fixture file, which is located in ``tutorial > mysite > website > fixtures``.
|
|
|
|
|
|
**These are the steps for updating the fixture:**
|
|
|
|
|
|
@@ -314,9 +314,9 @@ you will also need to update the fixture file, which is located in ``tutorial >
|
|
|
|
|
|
2. The dumped data file will show up in the ``website`` folder. Open it and copy/paste its contents into a new file called ``database.json``. This will fix the encoding issue you would run into otherwise. Save the new fixture file and delete the one that was dumped. Also delete the one that is currently in the ``fixtures`` folder.
|
|
|
|
|
|
-3. Move the ``database.json`` file into the ``fixtures`` folder.
|
|
|
+3. Move the ``database.json`` file into the ``fixtures`` folder.
|
|
|
|
|
|
-4. For testing ``loaddata``, please review the steps at :ref:`load-data`.
|
|
|
+4. For testing ``loaddata``, please review the steps at :ref:`load-data`.
|
|
|
|
|
|
|
|
|
Publishing a New Release
|
|
|
@@ -349,10 +349,11 @@ Finally build and update docs:
|
|
|
|
|
|
$ ./ci/make-docs.ps1
|
|
|
|
|
|
-If updating docs for an existing major version release:
|
|
|
+Copy the contents of ``docs/_build/html/`` to the CodeRed docs server under the existing version directory. Using the ``cr`` tool:
|
|
|
|
|
|
-#. Copy the contents of ``docs/_build/html/`` to the CodeRed docs server under
|
|
|
- the existing version directory.
|
|
|
+.. code-block:: console
|
|
|
+
|
|
|
+ $ cr upload --path ./docs/_build/html/ --remote /www/wagtail-crx/ docs
|
|
|
|
|
|
Note that we do not release separate documentation versions for minor or
|
|
|
maintenance releases. Update the existing major version docs with release notes
|
Vince Salvino