Merge pull request #3071 from stevepiercy/master

use shortcut for github URL; update RELEASING.txt

8 files changed, 21 insertions, 9 deletions

diff --git a/CHANGES.txt b/CHANGES.txt
index c21508a70..fc1d5ae25 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -9,6 +9,10 @@ unreleased
   resulting source files in tutorials.
   See https://github.com/Pylons/pyramid/issues/2548
 
+- Update RELEASING.txt for updating cookiecutters. Change cookiecutter URLs to
+  use shortcut.
+  See: https://github.com/Pylons/pyramid/issues/3042
+
 1.9a2 (2017-05-09)
 ==================
 
diff --git a/RELEASING.txt b/RELEASING.txt
index f780a607b..29d999522 100644
--- a/RELEASING.txt
+++ b/RELEASING.txt
@@ -38,6 +38,14 @@ Prepare new release branch
 
   $ ./scaffoldtests.sh
 
+- For each ``pyramid-cookiecutter-*``, make a new branch off "master" with the
+  same name to align with the new Pyramid release branch name.
+
+- In the docs, update the ``cookiecutter`` command with the new branch name,
+  for example, ``cookiecutter gh:Pylons/pyramid-cookiecutter-starter --checkout
+  x.y-branch``. A search for ``cookiecutter gh:Pylons/pyramid-cookiecutter-``
+  should return all instances to be updated.
+
 - Ensure all features of the release are documented (audit CHANGES.txt or
   communicate with contributors).
 
diff --git a/docs/narr/project.rst b/docs/narr/project.rst
index a150afc6b..f542eae86 100644
--- a/docs/narr/project.rst
+++ b/docs/narr/project.rst
@@ -85,7 +85,7 @@ On all platforms, generate a project using cookiecutter.
 
 .. code-block:: bash
 
-   $ cookiecutter https://github.com/Pylons/pyramid-cookiecutter-starter
+   $ cookiecutter gh:Pylons/pyramid-cookiecutter-starter --checkout 1.9-branch
 
 If prompted for the first item, accept the default ``yes`` by hitting return.
 
diff --git a/docs/quick_tour.rst b/docs/quick_tour.rst
index 1265012ab..f3a0a27b8 100644
--- a/docs/quick_tour.rst
+++ b/docs/quick_tour.rst
@@ -510,7 +510,7 @@ Let's use the cookiecutter ``pyramid-cookiecutter-starter`` to create a starter
 
 .. code-block:: bash
 
-    $ $VENV/bin/cookiecutter https://github.com/Pylons/pyramid-cookiecutter-starter
+    $ $VENV/bin/cookiecutter gh:Pylons/pyramid-cookiecutter-starter --checkout 1.9-branch
 
 If prompted for the first item, accept the default ``yes`` by hitting return.
 
@@ -866,7 +866,7 @@ Pyramid and SQLAlchemy are great friends. That friendship includes a cookiecutte
 .. code-block:: bash
 
     $ cd ~
-    $ env/bin/cookiecutter https://github.com/Pylons/pyramid-cookiecutter-alchemy
+    $ env/bin/cookiecutter gh:Pylons/pyramid-cookiecutter-alchemy --checkout 1.9-branch
 
 If prompted for the first item, accept the default ``yes`` by hitting return.
 
diff --git a/docs/quick_tutorial/cookiecutters.rst b/docs/quick_tutorial/cookiecutters.rst
index 337a5c535..0f2a24816 100644
--- a/docs/quick_tutorial/cookiecutters.rst
+++ b/docs/quick_tutorial/cookiecutters.rst
@@ -28,7 +28,7 @@ Steps
 
     .. code-block:: bash
 
-        $ $VENV/bin/cookiecutter https://github.com/Pylons/pyramid-cookiecutter-starter
+        $ $VENV/bin/cookiecutter gh:Pylons/pyramid-cookiecutter-starter --checkout 1.9-branch
 
     If prompted for the first item, accept the default ``yes`` by hitting return.
 
diff --git a/docs/tutorials/modwsgi/index.rst b/docs/tutorials/modwsgi/index.rst
index 170f2ebc8..8df432434 100644
--- a/docs/tutorials/modwsgi/index.rst
+++ b/docs/tutorials/modwsgi/index.rst
@@ -39,7 +39,7 @@ specific path information for commands and files.
     .. code-block:: bash
 
        $ cd ~
-       $ cookiecutter https://github.com/Pylons/pyramid-cookiecutter-starter
+       $ cookiecutter gh:Pylons/pyramid-cookiecutter-starter --checkout 1.9-branch
 
     If prompted for the first item, accept the default ``yes`` by hitting return.
 
diff --git a/docs/tutorials/wiki/installation.rst b/docs/tutorials/wiki/installation.rst
index de057b1cc..3e7434bd7 100644
--- a/docs/tutorials/wiki/installation.rst
+++ b/docs/tutorials/wiki/installation.rst
@@ -31,7 +31,7 @@ On UNIX
 .. code-block:: bash
 
     $ cd ~
-    $ cookiecutter https://github.com/Pylons/pyramid-cookiecutter-zodb
+    $ cookiecutter gh:Pylons/pyramid-cookiecutter-zodb --checkout 1.9-branch
 
 On Windows
 ^^^^^^^^^^
@@ -39,7 +39,7 @@ On Windows
 .. code-block:: doscon
 
     c:\> cd \
-    c:\> cookiecutter https://github.com/Pylons/pyramid-cookiecutter-zodb
+    c:\> cookiecutter gh:Pylons/pyramid-cookiecutter-zodb --checkout 1.9-branch
 
 On all operating systems
 ^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/docs/tutorials/wiki2/installation.rst b/docs/tutorials/wiki2/installation.rst
index c61d4360d..56197900c 100644
--- a/docs/tutorials/wiki2/installation.rst
+++ b/docs/tutorials/wiki2/installation.rst
@@ -43,7 +43,7 @@ On UNIX
 .. code-block:: bash
 
     $ cd ~
-    $ cookiecutter https://github.com/Pylons/pyramid-cookiecutter-alchemy
+    $ cookiecutter gh:Pylons/pyramid-cookiecutter-alchemy --checkout 1.9-branch
 
 On Windows
 ^^^^^^^^^^
@@ -51,7 +51,7 @@ On Windows
 .. code-block:: doscon
 
     c:\> cd \
-    c:\> cookiecutter https://github.com/Pylons/pyramid-cookiecutter-alchemy
+    c:\> cookiecutter gh:Pylons/pyramid-cookiecutter-alchemy --checkout 1.9-branch
 
 On all operating systems
 ^^^^^^^^^^^^^^^^^^^^^^^^