From: Joseph Spiros Date: Sun, 9 Oct 2011 02:02:11 +0000 (-0400) Subject: Edited the READMEs and documentation to be cleaner and more consistent. X-Git-Tag: philo-0.9.1^2 X-Git-Url: http://git.ithinksw.org/philo.git/commitdiff_plain/eb82cce559a0c88c386822d0ecb53ae8fa1da1f5?ds=sidebyside;hp=0f5e2e723a7a7e234da74028045f899b0ce8ba4d Edited the READMEs and documentation to be cleaner and more consistent. --- diff --git a/README b/README index 71e8392..630ea76 100644 --- a/README +++ b/README @@ -1,22 +1,19 @@ -Philo is a foundation for developing web content management systems. +Philo is a foundation for developing web content management systems. Prerequisites: * Python 2.5.4+ * Django 1.3+ * django-mptt e734079+ - * (Optional) django-grappelli 2.0+ - * (Optional) south 0.7.2+ - * (philo.contrib.penfield) django-taggit 0.9.3+ - * (philo.contrib.waldo, optional) recaptcha-django r6 + * (optional) django-grappelli 2.0+ + * (optional) south 0.7.2+ + * (philo.contrib.penfield) django-taggit 0.9.3+ + * (philo.contrib.waldo, optional) recaptcha-django r6+ -==== -Using philo -==== -After installing philo and mptt on your python path, make sure to complete the following steps: +After installing philo and mptt on your PYTHONPATH, make sure to complete the following steps: -1. add 'philo.middleware.RequestNodeMiddleware' to settings.MIDDLEWARE_CLASSES. -2. add 'philo' and 'mptt' to settings.INSTALLED_APPS. -3. include 'philo.urls' somewhere in your urls.py file. +1. Add 'philo.middleware.RequestNodeMiddleware' to settings.MIDDLEWARE_CLASSES. +2. Add 'philo' and 'mptt' to settings.INSTALLED_APPS. +3. Include 'philo.urls' somewhere in your urls.py file. 4. Optionally add a root node to your current Site. -Philo should be ready to go! All that's left is to learn more and contribute . +Philo should be ready to go! All that's left is to learn more and contribute . diff --git a/README.markdown b/README.markdown index 5734eb9..77ebb65 100644 --- a/README.markdown +++ b/README.markdown @@ -1,26 +1,20 @@ -Philo is a foundation for developing web content management systems. +[Philo](http://philocms.org/) is a foundation for developing web content management systems. Prerequisites: - * [Python 2.5.4+ <http://www.python.org>](http://www.python.org/) - * [Django 1.3+ <http://www.djangoproject.com/>](http://www.djangoproject.com/) - * [django-mptt e734079+ <https://github.com/django-mptt/django-mptt/>](https://github.com/django-mptt/django-mptt/) - * (Optional) [django-grappelli 2.0+ <http://code.google.com/p/django-grappelli/>](http://code.google.com/p/django-grappelli/) - * (Optional) [south 0.7.2+ <http://south.aeracode.org/)](http://south.aeracode.org/) - * (philo.contrib.penfield) [django-taggit 0.9.3+ <https://github.com/alex/django-taggit>](https://github.com/alex/django-taggit) - * (philo.contrib.waldo, optional) [recaptcha-django r6 <http://code.google.com/p/recaptcha-django/>](http://code.google.com/p/recaptcha-django/) + * [Python 2.5.4+](http://www.python.org/) + * [Django 1.3+](http://www.djangoproject.com/) + * [django-mptt e734079+](https://github.com/django-mptt/django-mptt/) + * (optional) [django-grappelli 2.0+](http://code.google.com/p/django-grappelli/) + * (optional) [south 0.7.2+](http://south.aeracode.org/) + * (philo.contrib.penfield) [django-taggit 0.9.3+](https://github.com/alex/django-taggit/) + * (philo.contrib.waldo, optional) [recaptcha-django r6+](http://code.google.com/p/recaptcha-django/) -To contribute, please visit the [project website](http://project.philocms.org/) and/or make a fork of the git repository on [GitHub](http://github.com/ithinksw/philo) or [Gitorious](http://gitorious -.org/ithinksw/philo). Feel free to join us on IRC at [irc://irc.oftc.net/#philo](irc://irc.oftc.net/#philo). +After installing philo and mptt on your PYTHONPATH, make sure to complete the following steps: -Using philo -=========== - -After installing philo and mptt on your python path, make sure to complete the following steps: - -1. add 'philo.middleware.RequestNodeMiddleware' to settings.MIDDLEWARE_CLASSES. -2. add 'philo' and 'mptt' to settings.INSTALLED_APPS. -3. include 'philo.urls' somewhere in your urls.py file. +1. Add 'philo.middleware.RequestNodeMiddleware' to settings.MIDDLEWARE_CLASSES. +2. Add 'philo' and 'mptt' to settings.INSTALLED_APPS. +3. Include 'philo.urls' somewhere in your urls.py file. 4. Optionally add a root node to your current Site. -Philo should be ready to go! All that's left is to [learn more](http://philo.readthedocs.org) and [contribute](http://philo.readthedocs.org/en/latest/contribute.html). +Philo should be ready to go! All that's left is to [learn more](http://docs.philocms.org/) and [contribute](http://docs.philocms.org/en/latest/contribute.html). diff --git a/docs/cla/ithinksw-ccla.txt b/docs/cla/ithinksw-ccla.txt index b76d6e4..0e6b2ae 100644 --- a/docs/cla/ithinksw-ccla.txt +++ b/docs/cla/ithinksw-ccla.txt @@ -11,8 +11,8 @@ protection of iThink Software and its users; it does not change your rights to use your own Contributions for any other purpose. This version of the Agreement allows an entity (the "Corporation") -to submit Contributions to iThink Software, to authorize Contributions -submitted by its designated employees to iThink Software, and to grant +to submit Contributions to iThink Software, to authorize Contributions +submitted by its designated employees to iThink Software, and to grant copyright and patent licenses thereto. If you have not already done so, please complete and sign, then scan diff --git a/docs/cla/ithinksw-icla.txt b/docs/cla/ithinksw-icla.txt index 9c49363..929452e 100644 --- a/docs/cla/ithinksw-icla.txt +++ b/docs/cla/ithinksw-icla.txt @@ -29,7 +29,7 @@ keep a copy for your records. Facsimile: ______________________________________________________ E-Mail: ______________________________________________________ - + You accept and agree to the following terms and conditions for Your present and future Contributions submitted to iThink Software. Except for the license granted herein to iThink Software and recipients of diff --git a/docs/contributing.rst b/docs/contributing.rst index 8d905b1..4c9fb7d 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -3,14 +3,15 @@ Contributing to Philo So you want to contribute to Philo? That's great! Here's some ways you can get started: -* **Report bugs and request features.** :mod:`philo` uses a Redmine installation located at `http://ithinksw.org/projects/philo/issues `_ for issue tracking. In order to report an issue, you will need to register for an account with the tracker. -* **Contribute code.** Philo uses git to manage its code. You can fork philo's repository either on `GitHub `_ or `Gitorious `_. If you are contributing to Philo, you will need to submit a :ref:`Contributor License Agreement `. -* **Join the discussion** on IRC at `irc://irc.oftc.net/#philo `_ if you have any questions or suggestions or just want to chat about the project. You can also keep in touch via :mod:`philo`'s mailing lists: `philo@ithinksw.org `_ and `philo-devel@ithinksw.org `_. +* **Report bugs and request features** using the issue tracker at the `project site `_. +* **Contribute code** using `git `_. You can fork philo's repository either on `GitHub `_ or `Gitorious `_. If you are contributing to Philo, you will need to submit a :ref:`Contributor License Agreement `. +* **Join the discussion** on IRC at `irc://irc.oftc.net/#philo `_ if you have any questions or suggestions or just want to chat about the project. You can also keep in touch using the project mailing lists: `philo@ithinksw.org `_ and `philo-devel@ithinksw.org `_. Branches and Code Style +++++++++++++++++++++++ -We use `A successful Git branching model`__ with the blessed repository. To make things easier, you probably should too. This means that you should work on and against the develop branch in most cases, and leave it to the release manager to create the commits on the master branch if and when necessary. Regardless of what you do, the release manager will usually merge your changes into the develop branch unless you explicitly note they should be treated otherwise. + +We use `A successful Git branching model`__ with the blessed repository. To make things easier, you probably should too. This means that you should work on and against the develop branch in most cases, and leave it to the release manager to create the commits on the master branch if and when necessary. When pulling changes into the blessed repository at your request, the release manager will usually merge them into the develop branch unless you explicitly note they be treated otherwise. __ http://nvie.com/posts/a-successful-git-branching-model/ @@ -21,7 +22,7 @@ Philo adheres to PEP8 for its code style, with two exceptions: tabs are used rat Licensing and Legal +++++++++++++++++++ -In order for the release manager to merge your changes into the blessed repository, you will need to submit a signed CLA. Our CLAs are based on the Apache Software Foundation's CLAs, which is the same source as the `Django Project's CLAs`_. You might, therefore, find the `Django Project's CLA FAQ`_. helpful. +In order for the release manager to merge your changes into the blessed repository, you will need to have already submitted a signed CLA. Our CLAs are based on the Apache Software Foundation's CLAs, which is the same source as the `Django Project's CLAs`_. You might, therefore, find the `Django Project's CLA FAQ`_. helpful. .. _`Django Project's CLAs`: https://www.djangoproject.com/foundation/cla/ .. _`Django Project's CLA FAQ`: https://www.djangoproject.com/foundation/cla/faq/ diff --git a/docs/index.rst b/docs/index.rst index 26fe771..05422dd 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,13 +12,13 @@ Philo is a foundation for developing web content management systems. Please, rea Prerequisites: -* `Python 2.5.4+ `_ +* `Python 2.5.4+ `_ * `Django 1.3+ `_ * `django-mptt e734079+ `_ -* (Optional) `django-grappelli 2.0+ `_ -* (Optional) `south 0.7.2+ `_ -* (:mod:`philo.contrib.penfield`) `django-taggit 0.9.3+ `_ -* (:mod:`philo.contrib.waldo`, optional) `recaptcha-django r6 `_ +* (optional) `django-grappelli 2.0+ `_ +* (optional) `south 0.7.2+ `_ +* (:mod:`philo.contrib.penfield`) `django-taggit 0.9.3+ `_ +* (:mod:`philo.contrib.waldo`, optional) `recaptcha-django r6+ `_ Contents ++++++++