Skip to content

Commit 13362be

Browse files
committed
Add docs deploy instructions
1 parent d5b6219 commit 13362be

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

docs/contributing/index.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -303,20 +303,20 @@ Updating Tutorial Documentation
303303
-------------------------------
304304

305305
From time to time, the documentation for the tutorial will need to be updated. You can work directly in
306-
the tutorial site by loading the fixture file for its database (read more at :ref:`load-data`).
306+
the tutorial site by loading the fixture file for its database (read more at :ref:`load-data`).
307307

308308
However, once you have worked in the tutorial site and gotten new screenshots for the **Getting Started** documentation,
309-
you will also need to update the fixture file, which is located in ``tutorial > mysite > website > fixtures``.
309+
you will also need to update the fixture file, which is located in ``tutorial > mysite > website > fixtures``.
310310

311311
**These are the steps for updating the fixture:**
312312

313313
1. From the command line, type ``python manage.py dumpdata --natural-foreign --natural-primary -e contenttypes -e auth.Permission --indent 4 > dumpdata.json``
314314

315315
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.
316316

317-
3. Move the ``database.json`` file into the ``fixtures`` folder.
317+
3. Move the ``database.json`` file into the ``fixtures`` folder.
318318

319-
4. For testing ``loaddata``, please review the steps at :ref:`load-data`.
319+
4. For testing ``loaddata``, please review the steps at :ref:`load-data`.
320320

321321

322322
Publishing a New Release
@@ -349,10 +349,11 @@ Finally build and update docs:
349349
350350
$ ./ci/make-docs.ps1
351351
352-
If updating docs for an existing major version release:
352+
Copy the contents of ``docs/_build/html/`` to the CodeRed docs server under the existing version directory. Using the ``cr`` tool:
353353

354-
#. Copy the contents of ``docs/_build/html/`` to the CodeRed docs server under
355-
the existing version directory.
354+
.. code-block:: console
355+
356+
$ cr upload --path ./docs/_build/html/ --remote /www/wagtail-crx/ docs
356357
357358
Note that we do not release separate documentation versions for minor or
358359
maintenance releases. Update the existing major version docs with release notes

0 commit comments

Comments
 (0)