Introduction
This wiki has been set up to be the focal point for the documentation of the Pylons project as well as projects from other Python web communities. Please go to town on adding new documentation! These guidelines should help avoid any problems.
Migrating Existing Docs
As part of the launch of this site we need to migrate information from the existing Trac wiki at http://pylonshq.com/project
. The content on the Trac wiki is either in Trac or reStructuredText format and needs to be converted to be used on this wiki. You can see a full guide to the wiki markup here.
We would encourage anyone who is interested to help move the documentation from the old Trac wiki to this new one but there are a few things to bear in mind:
- Please make an effort to find out who wrote the original version of the article and credit them on the new wiki because the new page will show up as being created by you.
- Please think carefully about where the page fits into the wiki hierarchy so that we maintain well-structured docs.
- Please don't migrate any of the "official" documentation from http://pylonshq.com/docs (see next section).
Once you have copied across the existing article please take all the content out of the old one and replace it with a link to the new article so that we avoid having multiple versions of the same article.
Official Pylons Documentation
Ben, Philip and I will continue to maintain the "official" Pylons documentation at http://pylonshq.com/docs/ so please don't transfer that to the wiki just yet because we want to avoid multiple versions. Eventually we will setup an automated process to keep a version on the new wiki too.
Creating New Documentation
Please feel free to create new articles on the wiki.
- Please make sure articles are publicly editable so that others can contribute comments or corrections.
- Please think carefully about where the page fits into the wiki hierarchy so that we maintain well-structured docs.
Markup
Source code can be highlighted via the {code} tag. We use a custom code utilizing Python Pygments: thus it supports any language supported by Pygments.
reStructuredText can also be rendered via the {rst} tag.
Requesting Your Own Space
If you are the maintainer of an open source project that forms part of Pylons or TurboGears or is often used by those communities, please feel free to join the mailing list and request the creation of your own "Space" on the front page of the website where you can administer the documentation efforts of your own project.
