aboutsummaryrefslogtreecommitdiff
path: root/docs
Commit message (Expand)AuthorAge
* tests: Add a couple of Selenium tests•••While developing the new series UI, several bug crept in but weren't discovered until later. All because we don't have in-browser tests to go along the lower level tests we already have. In particular, behaviours that need javascript to run cannot be tested outside of a full environment with the pages being served to an actual browser. This commit introduces selenium to the test suite and starts with 2 simple tests to give a taste of what it looks like. test_default_focus: make sure we do focus the username field on the login page test_login: shows how to chain actions to test the full login phase. This is quite similar the lower level test, except it also checks we display the username once logged in. v2: Use LiveServerTestCase for django pre-1.7 v3: Propagate the DISPLAY environment variable to have an X display specified for the browser v4: Log execution of the chrome driver, useful for debugging v5: Rebase on top of upstream v6: Pass environmental variables to tox and ensure PEP8 compliance Signed-off-by: Damien Lespiau <damien.lespiau@intel.com> Signed-off-by: Stephen Finucane <stephen.finucane@intel.com> Damien Lespiau2015-11-05
* docs: Add basic API guide•••Because it is now possible to access the auto-generated XML-RPC documentation, only provide a brief "HOWTO" on using the 'xmlrpclib' library and a note on how to find this autogenerated documentation. Signed-off-by: Stephen Finucane <stephen.finucane@intel.com> Stephen Finucane2015-10-26
* docs: Update Git URLs to GitHub•••Per move to GitHub: https://lists.ozlabs.org/pipermail/patchwork/2015-October/001873.html Signed-off-by: Stephen Finucane <stephen.finucane@intel.com> Stephen Finucane2015-10-26
* doc: Add CHANGELOG and UPGRADING docs•••The CHANGELOG document should describe the high level changes of the project. This will provide a human-readable way for people to evaluate the changes in each release. This file is based on the templates and general changelog "ethos" provided by 'Keep a CHANGELOG': http://keepachangelog.com/ The UPGRADING document provide instruction for system admininstrators managing patchwork deployments. At the moment, this document is a rename and minor reformatting of the existing 'docs/NEWS' document, but going forward documentation will be added for each new release. Signed-off-by: Stephen Finucane <stephen.finucane@intel.com> Stephen Finucane2015-10-26
* 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> Stephen Finucane2015-09-17
* tox: Update versions of Django to be tested•••Since patchwork now supports Django 1.8 and no longer support 1.5, it is necessary to update the tox targets to validate this new subset of supported Django versions. In addition, the paths to the requirements.txt files were not updated as part of a rebase. Correct this oversight. Reviewed-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> Stephen Finucane2015-09-17
* patchwork: Explicitly load states fixtures•••Apps with migrations will no longer load the initial_data fixtures by default. In order to prepare to add migrations to patchwork, rename the initial_data fixture to default_states (to match the default_tags fixture), and explicitly load them in tests that require them. Also, include this step in the INSTALL document. Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Jeremy Kerr2015-06-05
* cron: Move patchwork-cron script to a management command•••Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Jeremy Kerr2015-05-28
* doc: Add NEWS file for recent updates•••... containing a guide to migrating to the recent changes. Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Jeremy Kerr2015-05-28
* Add patch tag infrastructure•••This change add patch 'tags', eg 'Acked-by' / 'Reviewed-by', etc., to patchwork. Tag parsing is implemented in the patch parser's extract_tags function, which returns a Counter object of the tags in a comment. These are stored in the PatchTag (keyed to Tag) objects associated with each patch. We need to ensure that the main patch lists do not cause per-patch queries on the Patch.tags ManyToManyField (this would result in ~500 queries per page), so we introduce a new QuerySet (and Manager) for Patch, adding a with_tag_counts() method to populate the tag counts in a single query. As users may be migrating from previous patchwork versions (ie, with no tag counts in the database), we add a 'retag' management command. Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Jeremy Kerr2015-05-28
* docs: Add collectstatic step to installation instructions•••Because we're now using the staticfiles app, we need to run collectstatic on init. Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Jeremy Kerr2015-05-28
* Update documentation and default settings to suit patchwork deployment model•••We've always allowed configuration without altering any of the version-controlled files. With the recent settings changes, we have an extra level of indirection with the dev/prod settings modules. Since we have to edit a config file anyway, this change moves the prod.py settings file to a template, which is then used directly by mange.py (and the wsgi application). Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Jeremy Kerr2015-05-28
* docs: Fix documentation for new settings infrastructure•••A few tweaks for the INSTALL doc to update to the settings changes from c641660e. Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Jeremy Kerr2015-05-27
* Move to a more recent django project structure•••This change updates patchwor to the newer project struture: we've moved the actual application out of the apps/ directory, and the patchwork-specific templates to under the patchwork application. This gives us the manage.py script in the top-level now. Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Jeremy Kerr2015-05-27
* docs: Use 'prod' and 'dev' requirements files•••Django 1.5 and 1.6 are no longer supported. https://docs.djangoproject.com/en/dev/internals/release-process/ As a result, one should not encourage people to develop and/or deploy against these versions - the latest version of Django supported by patchwork (currently 1.7) should be used for both. In addition, rather than duplicating shared requirements for 'dev' and 'prod' environments, move all shared requirements to a "base" file. Signed-off-by: Stephen Finucane <stephenfinucane@hotmail.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Stephen Finucane2015-05-03
* INSTALL: Fix indentation (whitespace only change) to 4 spaces•••Also, 2 newlines after each section. Signed-off-by: Bryce Harrington <bryce@osg.samsung.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Bryce Harrington2015-03-22
* INSTALL: Fix some minor typos•••Signed-off-by: Bryce Harrington <bryce@osg.samsung.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Bryce Harrington2015-03-22
* INSTALL: fix mysql syntax•••You shouldn't quote ('') the database name. MySQL complains if you do. Signed-off-by: Brian Norris <computersforpeace@gmail.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Brian Norris2015-03-22
* TODO: remove completed items•••IIUC, these items have all been completed. (The 'bundle' part of --signoff is not completed, but that is represented in the previous bullet.) Signed-off-by: Brian Norris <computersforpeace@gmail.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Brian Norris2015-03-22
* docs: Add a note about how to run tests•••Given that hacking on patchwork is spaced in time, I always forget how to do this. So write down a note. Signed-off-by: Damien Lespiau <damien.lespiau@intel.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Damien Lespiau2014-11-10
* docs: Add the Debian package name for virtualenv/mysql•••Signed-off-by: Damien Lespiau <damien.lespiau@intel.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Damien Lespiau2014-11-10
* docs: Add requirements.txt for django 1.7/MySQL•••Note: a lot of tests fail due to the removal of the long deprecated AUTH_PROFILE_MODULE. Signed-off-by: Damien Lespiau <damien.lespiau@intel.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Damien Lespiau2014-09-07
* docs: Add requirements.txt for django 1.6/MySQL•••Signed-off-by: Damien Lespiau <damien.lespiau@intel.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Damien Lespiau2014-09-07
* docs: Add requirements.txt for django 1.5/MySQL•••Signed-off-by: Damien Lespiau <damien.lespiau@intel.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Damien Lespiau2014-09-07
* HACKING: Add some documentation about using virtualenv with patchwork•••virtualenv is super nice to isolate devevelopment from the python packages installed in the sytem. It also allows to have parallel configurations to run tests againsts. Signed-off-by: Damien Lespiau <damien.lespiau@intel.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Damien Lespiau2014-09-07
* INSTALL: Sprinkle a few UTF-8 in the mysql documentation•••When not specifying the charset/collation, I managed to create a latin1 database where all strings were encoded in latin1. That's really not ideal. Adding 'CHARACTER SET utf8' when creating the DB fixes it. Then: $ ./manage.py syncdb will correctly create tables with UTF-8 encoded rows. However, for some reason, when django creates the test tables, that default, DB wide, encoding is not respected and one needs to provide an additional TEST_CHARSET entry in the config dictionary. Signed-off-by: Damien Lespiau <damien.lespiau@intel.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Damien Lespiau2014-09-07
* INSTALL: Update the database configuration instructions•••That's the "new" (django 1.5+) way of defining databases, strictly following the instructions wasn't working. This should save the next user a bit of time. Signed-off-by: Damien Lespiau <damien.lespiau@intel.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Damien Lespiau2014-09-07
* settings.py: use python to find ROOT_DIR•••Signed-off-by: Andreas Bießmann <andreas@biessmann.de> Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Andreas Bießmann2014-07-24
* INSTALL: adopt PYTHONPATH•••Signed-off-by: Andreas Bießmann <andreas@biessmann.de> Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Andreas Bießmann2014-07-24
* docs/INSTALL: Add setup details for patchwork cron script•••Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Jeremy Kerr2014-04-24
* docs: Add a pointer to the git post-receive hook•••I had to stumble upon this feature before I realized it was here inside the tools directory all along. This documentation should make it easier for the next person coming along looking for a patchwork git hook. Signed-off-by: Carl Worth <cworth@cworth.org> Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Carl Worth2014-01-29
* docs: We're targetting django 1.5 now•••Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Jeremy Kerr2013-10-13
* docs: also mention that ROOT_DIR needs to be updated•••When the patchwork installation resides in the non-default location (/srv/patchwork) make sure that local_settings.py also gets updated with a proper ROOT_DIR value otherwise various problems will happen. Signed-off-by: Florian Fainelli <f.fainelli@gmail.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Florian Fainelli2013-10-04
* docs: fix INSTALL instructions regarding Django•••Django is no longer accessible using the old Subversion URL, update that to the Github repository. Besides, the command-line used to perform the "syncdb" operation does not work because we are off by one directory in the filesystem, fix that. Signed-off-by: Florian Fainelli <f.fainelli@gmail.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Florian Fainelli2013-10-04
* docs: update MySQL documentation bits•••The MySQL documentation bits where missing a few important details for installation setup to succeed like: - having proper python-mysqldb support - overriding the DATABASE_ENGINE to "mysql" for django to succeed in the "syncdb" operation Signed-off-by: Florian Fainelli <f.fainelli@gmail.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Florian Fainelli2013-10-04
* js: Add jquery and jquery tablednd plugins•••Based on a change from Andreas Bießmann <andreas@biessmann.de>. Rather than requiring a download of the jquery library + tablednd plugin, commit these to the repository. In doing so, we upgrade to version 1.10.1 of jqeury, and the current stable tablednd. Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Jeremy Kerr2013-06-16
* Merge branch 'notifications'Jeremy Kerr2011-09-19
|\
| * notifications: Add NOTIFICATION_FROM_EMAIL setting•••Allow a separate From: address for notificaton emails. Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Jeremy Kerr2011-04-14
| * registration: use EmailConfimation rather than separate registration app•••Since we have infrastructure for email confirmations, we no longer need the separate registration app. Requires a migration script, which will delete all inactive users, including those newly added and pending confirmation. Use carefully. Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Jeremy Kerr2011-04-14
* | Patchwork now requires Django 1.2, so state that in docs/INSTALL•••Signed-off-by: Guilherme Salgado <guilherme.salgado@linaro.org> Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Guilherme Salgado2011-04-19
|/
* docs: Fix link creation example•••Signed-off-by: Dirk Wallenstein <halsmit@t-online.de> Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Dirk Wallenstein2011-02-11
* docs: fix apache2 references•••Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Jeremy Kerr2010-08-10
* lib/apache2: Add WSGI Handler•••Patchwork/Django can be run directly with WSGI, which is bound to be faster and less complex than FastCGI. This patch provides the necessary Apache configuration and the WSGI handler, as well as an update to the docs. Since python-flup is deprecated and WSGI supersedes FastCGI, it should be(come) the preferred method. Hence I documented it first. For the xmlrpc interface to work with WSGI, the HTTP authorization information needs to be passed to the WSGI handler. This is done by setting WSGIPassAuthorization On in the apache2 config file snippet. Ref: http://www.arnebrodowski.de/blog/508-Django,-mod_wsgi-and-HTTP-Authentication.html Signed-off-by: martin f. krafft <madduck@madduck.net> Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Martin Krafft2010-08-10
* docs: Document password-based pgsql login•••As an alternative to ident-based authentication for PostgreSQL, one can use password-based authentication. This patch adds the alternative to the docs. Signed-off-by: martin f. krafft <madduck@madduck.net> Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Martin Krafft2010-08-10
* docs: reformat INSTALL•••Fix up some tabs. Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Jeremy Kerr2010-08-10
* docs: elaborate on lib/ dirs in INSTALL•••Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Jeremy Kerr2010-08-10
* docs: update INSTALL for commonly-available packages•••We probably don't need to download django or django-registration anymore. Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Jeremy Kerr2010-08-10
* Registration framework maintained on bitbucket•••The django-registration framework is now maintained on bitbucket, which requires some changes to the in-tree symlink and the documentation. Signed-off-by: martin f. krafft <madduck@madduck.net> Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Martin Krafft2010-08-10
* Add TODO item: changing primary email addresses•••Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Jeremy Kerr2010-04-27
* docs: Fix typo in INSTALL•••Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Jeremy Kerr2009-10-23