From 539a5c07f969944bc567a34aabf584ae3636c737 Mon Sep 17 00:00:00 2001 From: Ryan Petrello Date: Fri, 11 Jan 2013 09:44:45 -0500 Subject: [PATCH 1/2] Improve visibility of deployment-related docs. --- docs/source/index.rst | 2 +- docs/source/quick_start.rst | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 7b80851..e964234 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -42,6 +42,7 @@ Narrative Documentation jsonify.rst commands.rst development.rst + deployment.rst logging.rst testing.rst @@ -55,7 +56,6 @@ Cookbook and Common Patterns sessions.rst databases.rst errors.rst - deployment.rst API Documentation diff --git a/docs/source/quick_start.rst b/docs/source/quick_start.rst index c35ce84..8879a05 100644 --- a/docs/source/quick_start.rst +++ b/docs/source/quick_start.rst @@ -278,3 +278,7 @@ add to. To run them:: OK The tests themselves can be found in the ``tests`` module in your project. + +Deploying to a Web Server +------------------------- +Ready to deploy your new Pecan app? Take a look at :ref:`deployment`. From 66707c4082381f8037b9113a6bfb4678cb22c5f4 Mon Sep 17 00:00:00 2001 From: Ryan Petrello Date: Fri, 11 Jan 2013 11:07:16 -0500 Subject: [PATCH 2/2] Add an explicit CONTRIBUTING.rst document. --- CONTRIBUTING.rst | 20 ++++++++++++++++++++ README.rst | 21 --------------------- 2 files changed, 20 insertions(+), 21 deletions(-) create mode 100644 CONTRIBUTING.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..0d0eece --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,20 @@ +Contributing to Pecan +--------------------- +To fix bugs or add features to Pecan, a GitHub account is required. + +The general practice for contributing is to `fork Pecan +`_ and make changes in the ``next`` +branch. When you're finished, `send a pull request +`_ and the developers will review +your patch. + +All contributions must: + + * Include accompanying tests. + * Include narrative and API documentation if new features are added. + * Be (generally) compliant with `PEP8 + `_. + * Not break the test or build. Before issuing a pull request, ``$ pip + install tox && tox`` from your source to ensure that all tests still pass + across multiple versions of Python. + * Add your name to the (bottom of the) AUTHORS file. diff --git a/README.rst b/README.rst index 4492de5..2aab0e1 100644 --- a/README.rst +++ b/README.rst @@ -44,27 +44,6 @@ Viewing Documentation $ cd docs && make man $ man docs/build/man/pecan.1 -Contributing to Pecan ---------------------- -To fix bugs or add features to Pecan, a GitHub account is required. - -The general practice for contributing is to `fork Pecan -`_ and make changes in the ``next`` -branch. When you're finished, `send a pull request -`_ and the developers will review -your patch. - -All contributions must: - - * Include accompanying tests. - * Include narrative and API documentation if new features are added. - * Be (generally) compliant with `PEP8 - `_. - * Not break the test or build. Before issuing a pull request, ``$ pip - install tox && tox`` from your source to ensure that all tests still pass - across multiple versions of Python. - * Add your name to the (bottom of the) AUTHORS file. - Additional Help/Support ----------------------- Most Pecan interaction is done via the #pecanpy channel on `FreeNode