aboutsummaryrefslogtreecommitdiff
path: root/docs/development.md
Commit message (Collapse)AuthorAge
* docs: Add a contributors guideStephen Finucane2016-02-05
| | | | | | | | | This guide details the steps one should follow to submit patches for patchwork. It's nothing onerous but rather common sense. This requires moving the testing section from the development guide to this new document. Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>
* docs: Document all the 'PW_' environment variablesStephen Finucane2015-11-21
| | | | | | | These are found in multiple places across the code. It would be helpful to document them for the user. Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>
* Move requirements into base directoryStephen Finucane2015-11-21
| | | | | | | | These are documentation and therefore don't belong in the documentation directory. The base directory is the usual location for these files, so move them there. Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>
* docs: Fix a few code blocksDamien Lespiau2015-11-12
| | | | | Signed-off-by: Damien Lespiau <damien.lespiau@intel.com> Reviwed-by: Stephen Finucane <stephen.finucane@intel.com>
* docs: Remove unhelpful commandDamien Lespiau2015-11-12
| | | | | | | That doesn't provide much value and can be removed. Signed-off-by: Damien Lespiau <damien.lespiau@intel.com> Reviewed-by: Stephen Finucane <stephen.finucane@intel.com>
* docs: Fix a missing 3rd person 's'Damien Lespiau2015-11-12
| | | | | Signed-off-by: Damien Lespiau <damien.lespiau@intel.com> Reviewed-by: Stephen Finucane <stephen.finucane@intel.com>
* docs: Remove duplicated 'the'Damien Lespiau2015-11-12
| | | | | Signed-off-by: Damien Lespiau <damien.lespiau@intel.com> Reviewed-by: Stephen Finucane <stephen.finucane@intel.com>
* docs: Rewrite documentationStephen Finucane2015-09-17
The INSTALL and HACKING documents are an important guide for new patchwork users and developers and should be as informative as possible. A number of changes were needed to these documents owing to the out-of-date or incomplete information they contained. These changes include: * Removing references to the dead mod_python/flup projects * Adding references to Gunicorn+nginx, which a credible modern alternative to Apache+mod_wsgi * Providing explanatory links to concepts/tools like ident-based authentication and tox * Referencing the newer tools available to developers, like tox and the 'requirements.txt' files * Integration with mkdocs, with eye on eventual publishing of documentation to ReadTheDocs or equivalent. These changes result in a significant rewrite which should hopefully lower the barrier to entry for people wishing to use or develop patchwork. Acked-by: Damien Lespiau <damien.lespiau@intel.com> Signed-off-by: Stephen Finucane <stephen.finucane@intel.com> Signed-off-by: Damien Lespiau <damien.lespiau@intel.com>