summaryrefslogtreecommitdiff
path: root/docs/narr
diff options
context:
space:
mode:
authorSteve Piercy <web@stevepiercy.com>2016-12-27 00:35:50 -0800
committerSteve Piercy <web@stevepiercy.com>2016-12-27 00:35:50 -0800
commite2cda93d7422de50d014bcbacc2f4c31b95508bd (patch)
tree896077e0acb565e24ef75401a75b2051480efd04 /docs/narr
parent0a11d04513d38f560d0e147eeb7d0c1d9d4ac261 (diff)
downloadpyramid-e2cda93d7422de50d014bcbacc2f4c31b95508bd.tar.gz
pyramid-e2cda93d7422de50d014bcbacc2f4c31b95508bd.tar.bz2
pyramid-e2cda93d7422de50d014bcbacc2f4c31b95508bd.zip
narr/cookiecutters - revise
Diffstat (limited to 'docs/narr')
-rw-r--r--docs/narr/cookiecutters.rst8
-rw-r--r--docs/narr/project.rst37
2 files changed, 29 insertions, 16 deletions
diff --git a/docs/narr/cookiecutters.rst b/docs/narr/cookiecutters.rst
index bb4c61616..abedb25b9 100644
--- a/docs/narr/cookiecutters.rst
+++ b/docs/narr/cookiecutters.rst
@@ -13,8 +13,10 @@ Pyramid cookiecutters have replaced the now deprecated Pyramid scaffolds, and sh
* `pyramid-cookiecutter-starter <https://github.com/Pylons/pyramid-cookiecutter-starter>`_
* `pyramid-cookiecutter-zodb <https://github.com/Pylons/pyramid-cookiecutter-zodb>`_
-Development of cookiecutters is documented under `Learn the Basics of Cookiecutter by Creating a Cookiecutter <https://cookiecutter.readthedocs.io/en/latest/first_steps.html>`_.
+.. seealso::
-.. seealso:: See also `Cookiecutter Features <https://cookiecutter.readthedocs.io/en/latest/readme.html#features>`_.
+ See also `Cookiecutter Installation <https://cookiecutter.readthedocs.io/en/latest/installation.html>`_ and `Cookiecutter Features <https://cookiecutter.readthedocs.io/en/latest/readme.html#features>`_. Development of cookiecutters is documented under `Learn the Basics of Cookiecutter by Creating a Cookiecutter <https://cookiecutter.readthedocs.io/en/latest/first_steps.html>`_.
-.. seealso:: See also :term:`scaffold`.
+.. seealso::
+
+ See also :term:`scaffold`.
diff --git a/docs/narr/project.rst b/docs/narr/project.rst
index 62c4723df..118a9fa89 100644
--- a/docs/narr/project.rst
+++ b/docs/narr/project.rst
@@ -5,33 +5,44 @@ Creating a :app:`Pyramid` Project
As we saw in :ref:`firstapp_chapter`, it's possible to create a :app:`Pyramid`
application completely manually. However, it's usually more convenient to use
-a :term:`scaffold` to generate a basic :app:`Pyramid` :term:`project`.
+a :term:`cookiecutter` to generate a basic :app:`Pyramid` :term:`project`.
A project is a directory that contains at least one Python :term:`package`.
-You'll use a scaffold to create a project, and you'll create your application
+You'll use a cookiecutter to create a project, and you'll create your application
logic within a package that lives inside the project. Even if your application
is extremely simple, it is useful to place code that drives the application
within a package, because (1) a package is more easily extended with new code,
and (2) an application that lives inside a package can also be distributed more
easily than one which does not live within a package.
-:app:`Pyramid` comes with a variety of scaffolds that you can use to generate a
-project. Each scaffold makes different configuration assumptions about what
+The Pylons Project provides several :app:`Pyramid` cookiecutters that you can use to generate a
+project. Each cookiecutter makes different configuration assumptions about what
type of application you're trying to construct.
-These scaffolds are rendered using the ``pcreate`` command that is installed as
-part of Pyramid.
+These cookiecutters are rendered using the ``cookiecutter`` command that you may install.
+
+.. seealso::
+
+
+
.. index::
- single: scaffolds
- single: starter scaffold
- single: zodb scaffold
- single: alchemy scaffold
+ single: cookiecutters
+ single: pyramid-cookiecutter-starter
+ single: pyramid-cookiecutter-zodb
+ single: pyramid-cookiecutter-alchemy
-.. _additional_paster_scaffolds:
+.. _additional_cookiecutters:
+
+:app:`Pyramid` cookiecutters
+----------------------------
+
+Pyramid cookiecutters released under the Pylons Project include:
+
+* `pyramid-cookiecutter-alchemy <https://github.com/Pylons/pyramid-cookiecutter-alchemy>`_
+* `pyramid-cookiecutter-starter <https://github.com/Pylons/pyramid-cookiecutter-starter>`_
+* `pyramid-cookiecutter-zodb <https://github.com/Pylons/pyramid-cookiecutter-zodb>`_
-Scaffolds Included with :app:`Pyramid`
---------------------------------------
The convenience scaffolds included with :app:`Pyramid` differ from each other
on a number of axes: