Merge pull request #3390 from mmerickel/whatsnew-1.10

Michael Merickel

2018-10-16 8eed333343e4e9e7f11f3aee67299030d6bf2783

 docs/tutorials/wiki/installation.rst

@@ -31,7 +31,7 @@
.. code-block:: bash

    cd ~
    cookiecutter gh:Pylons/pyramid-cookiecutter-zodb --checkout master
    cookiecutter gh:Pylons/pyramid-cookiecutter-starter --checkout 1.10-branch

On Windows
^^^^^^^^^^
@@ -39,7 +39,7 @@
.. code-block:: doscon

    cd \
    cookiecutter gh:Pylons/pyramid-cookiecutter-zodb --checkout master
    cookiecutter gh:Pylons/pyramid-cookiecutter-starter --checkout 1.10-branch

On all operating systems
^^^^^^^^^^^^^^^^^^^^^^^^
@@ -47,10 +47,20 @@

.. code-block:: text

    You've cloned ~/.cookiecutters/pyramid-cookiecutter-zodb before.
    You've cloned ~/.cookiecutters/pyramid-cookiecutter-theone before.
    Is it okay to delete and re-clone it? [yes]: yes
    project_name [Pyramid Scaffold]: myproj
    repo_name [myproj]: tutorial
    Select template_language:
    1 - jinja2
    2 - chameleon
    3 - mako
    Choose from 1, 2, 3 [1]: 1
    Select backend:
    1 - none
    2 - sqlalchemy
    3 - zodb
    Choose from 1, 2, 3 [1]: 3

Change directory into your newly created project
------------------------------------------------
@@ -195,7 +205,7 @@

After you've installed the project in development mode as well as the testing
requirements, you may run the tests for the project. The following commands
provide options to `pytest` that specify the module for which its tests shall be
provide options to ``pytest`` that specify the module for which its tests shall be
run, and to run ``pytest`` in quiet mode.

On Unix
@@ -275,10 +285,11 @@
Test and coverage cookiecutter defaults
---------------------------------------

Cookiecutters include configuration defaults for ``pytest`` and test coverage.
These configuration files are ``pytest.ini`` and ``.coveragerc``, located at
the root of your package. Without these defaults, we would need to specify the
path to the module on which we want to run tests and coverage.
The Pyramid cookiecutter includes configuration defaults for ``pytest`` and
test coverage.  These configuration files are ``pytest.ini`` and
``.coveragerc``, located at the root of your package. Without these defaults,
we would need to specify the path to the module on which we want to run tests
and coverage.

On Unix
^^^^^^^
@@ -299,7 +310,7 @@
tell ``pytest`` where to find the module on which we want to run tests and
coverage.

.. seealso:: See pytest's documentation for :ref:`pytest:usage` or invoke
.. seealso:: See ``pytest``'s documentation for :ref:`pytest:usage` or invoke
   ``pytest -h`` to see its full set of options.


@@ -354,11 +365,10 @@
application while you develop.


Decisions the ``zodb`` cookiecutter has made for you
----------------------------------------------------
Decisions the cookiecutter backend option ``zodb`` has made for you
-------------------------------------------------------------------

Creating a project using the ``zodb`` cookiecutter makes the following
assumptions:
When creating a project and selecting the backend option of ``zodb``, the cookiecutter makes the following assumptions:

- You are willing to use :term:`ZODB` for persistent storage.

@@ -366,10 +376,6 @@

- You want to use pyramid_zodbconn_, pyramid_tm_, and the transaction_ packages
  to manage connections and transactions with :term:`ZODB`.

- You want to use pyramid_chameleon_ to render your templates. Different
  templating engines can be used, but we had to choose one to make this
  tutorial. See :ref:`available_template_system_bindings` for some options.

.. note::