]> git.ozlabs.org Git - patchwork/commit
docs: Rewrite documentation
authorStephen Finucane <stephen.finucane@intel.com>
Fri, 21 Aug 2015 14:32:07 +0000 (15:32 +0100)
committerDamien Lespiau <damien.lespiau@intel.com>
Thu, 17 Sep 2015 16:40:09 +0000 (17:40 +0100)
commit808904d8a80c2b41234f2de9827ebcf67edcf227
tree305840c6400c02d14e4e1cc3fdd3e7f37678aa76
parentc1c3f73c0a98996e1347353864e9367ac69edf33
docs: Rewrite documentation

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>
docs/HACKING [deleted file]
docs/INSTALL [deleted file]
docs/development.md [new file with mode: 0644]
docs/index.md [new file with mode: 0644]
docs/installation.md [new file with mode: 0644]
mkdocs.yml [new file with mode: 0644]
patchwork/settings/production.example.py