aboutsummaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAge
* docs: Add getmail documentationStephen Finucane2016-10-22
| | | | | | | | | | It seems a lot of people are having success using tools like fetchmail in combination with IMAP/POP-capable email accounts like Gmail. While fetchmail itself is rather decrepit, the Python-based getmail seems actively supported and pretty easy to configure. Document this process. Signed-off-by: Stephen Finucane <stephen@that.guru> Reviewed-by: Daniel Axtens <dja@axtens.net>
* docs: Add delegation guideStephen Finucane2016-10-11
| | | | | | We do autodelegation - let's tell people all about it. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Add X-Patchwork-* header documentationStephen Finucane2016-10-11
| | | | | | | Avoids sending people to the code to find out about this stuff. Include examples using 'git-send-email', which should cover most folks. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Add basic REST API documentationStephen Finucane2016-10-11
| | | | | | | This is only user-facing for now. Developer focused docs can be added later. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Rework XML-RPC docsStephen Finucane2016-10-11
| | | | | | | | Add a barebones usage guide for pwclient and simplify the existing doc for this API. This entails move the existing doc from the deployment section to development section, which makes more sense given its focus. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Structure docs folder like onlineStephen Finucane2016-10-11
| | | | | | The XML-RPC doc is renamed accordingly. Signed-off-by: Stephen Finucane <stephen@that.guru>
* parsearchive: Convert to a management commandStephen Finucane2016-10-08
| | | | | | | | | | | As with parsemail, parsearchive makes more sense as a management command. Make it so. As with the conversion of the 'parsemail' tool, this removes customisable logging as it's not necessary. Signed-off-by: Stephen Finucane <stephen@that.guru> Closes-bug: #17
* docs: Update readthedocs URLsStephen Finucane2016-09-01
| | | | | | | 'readthedocs.io' is preferred to 'readthedocs.org'. Update all relevant links. Signed-off-by: Stephen Finucane <stephenfinucane@hotmail.com>
* docs: Document SELinux issuesStephen Finucane2016-09-01
| | | | | | | | Initial Docker setup caused me some heartache on Fedora. Briefly document the issues encountered to help other users. Signed-off-by: Stephen Finucane <stephenfinucane@hotmail.com> Reviewed-by: Daniel Axtens <dja@axtens.net>
* docs: Make Docker the recommended install methodStephen Finucane2016-09-01
| | | | | | | | Docker is faster, lighter and "hipper" than Vagrant. Promote this method over the Vagrant approach. Signed-off-by: Stephen Finucane <stephenfinucane@hotmail.com> Reviewed-by: Daniel Axtens <dja@axtens.net>
* docs: Add a paragraph about the django admin consoleFlorian Fainelli2016-09-01
| | | | | | | | | | Provide a few hints about how to get initial access to the django admin console as well as a few essential configuration hints regarding projects and sites setup. Signed-off-by: Florian Fainelli <f.fainelli@gmail.com> Reviewed-by: Daniel Axtens <dja@axtens.net> Reviewed-by: Stephen Finucane <stephenfinucane@hotmail.com>
* docs: Alter heading of development install guideStephen Finucane2016-08-13
| | | | | | | | Divide the document into a Vagrant-based install section, and a manual install section (+ footnotes). Signed-off-by: Stephen Finucane <stephen.finucane@intel.com> Reviewed-by: Andy Doan <andy.doan@linaro.org>
* docs/deployment: Fix systemctl commandsRussell Currey2016-07-15
| | | | | | | | | systemctl takes the name of the operation before the name of the service so that you can do multiple things at once, i.e. "systemctl status nginx postgresql". Fix the ordering of the arguments. Signed-off-by: Russell Currey <ruscur@russell.cc> Reviewed-by: Stephen Finucane <stephen.finucane@intel.com>
* docs: Add prototype API specificationStephen Finucane2016-06-27
| | | | | | | | | | | | | | | | | | | | | | Add specification for a REST API. It documents a number of endpoints for the following objects/models: * Projects * People * Patches * Checks The specification is provided in OpenAPI format [1]. This specification can be used to automatically generate REST client libraries and to validate the implemented API. The API is currently read-only. It is expected that this will expanded upon as the API grows. [1] https://openapis.org/specification Signed-off-by: Stephen Finucane <stephen.finucane@intel.com> Signed-off-by: Andy Doan <andy.doan@linaro.org>
* docs: Fix spelling mistakes and typosEric Engestrom2016-05-09
| | | | | Signed-off-by: Eric Engestrom <eric@engestrom.ch> Reviewed-by: Stephen Finucane <stephen.finucane@intel.com>
* docs: Refer to 'Patchwork' consistentlyStephen Finucane2016-03-29
| | | | | | | The docs referred to both 'patchwork' and 'Patchwork'. Use the title case variant consistently. Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>
* Add support for 'django-debug-toolbar'Stephen Finucane2016-03-15
| | | | | | | | | | | | This tool is exceptionally helpful for debugging issues with Django: install it as part of the 'dev' configuration. This only works on Django > 1.6, due to a lack of support for older versions in the upstream. A note is included to help users avoid the issues seen when running patchwork on a different machine. Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>
* docs: Refer to fixtures by name, not pathStephen Finucane2016-03-13
| | | | | | | It's not necessary to use paths for fixtures, so update the docs and Vagrant install scripts to remove these. Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>
* settings: Don't use 'postgre'Damien Lespiau2016-03-08
| | | | | | | | | | From: https://wiki.postgresql.org/wiki/Postgres#Changing_name_from_PostgreSQL_to_Postgres "Does not encourage weird derivations such as 'Postgre'" Signed-off-by: Damien Lespiau <damien.lespiau@intel.com> Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>
* docs: Release v1.1.0Stephen Finucane2016-03-03
| | | | | | This release is now ready. Update the respective references. Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>
* docs: Add notes for v1.1.0Stephen Finucane2016-02-14
| | | | Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>
* docs: Rewrite deployment guideStephen Finucane2016-02-14
| | | | | | | | | | | | | | The existing deployment could do with a little bit of fleshing out. Do this, adding notes about the possibility of sidestepping much of the process using deployment tools or PaaS solutions. This also drops notes on deploying using MySQL/MariaDB or non-Ubuntu distros. While it would be good to cover all use cases, it simply isn't practical. Do one thing and do it well, providing notes for users who want other options. Signed-off-by: Stephen Finucane <stephen.finucane@intel.com> Suggested-by: Thomas Monjalon <thomas.monjalon@6wind.com>
* docs: Combine MySQL init/reinit instructionsStephen Finucane2016-02-10
| | | | | | | | Apply some learnings for the Vagrant work and combine the commands used to configure a MySQL database for first time use with those used to reset an existing database. This should simplify installation. Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>
* docs: Add note about Vagrant supportStephen Finucane2016-02-10
| | | | Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>
* docs: Reconfigure page structureStephen Finucane2016-02-05
| | | | | | | | | | | | | | There are two distinct types of documentation available: documentation for patchwork developers and documentation for patchwork deployers. Rework the mkdocs configuration such that this hierarchy is established. As part of this change, the installation doc is renamed to deployment. This guide should be used to install patchwork in a production environment and not necessarily a deployment one. The existing name was misleading so fix it. Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>
* docs: Remove remainder of non-GHFM referencesStephen Finucane2016-02-05
| | | | | | | The GitHub Format Markdown style of Markdown links breaks in some Markdown renderers. Change to the style now used in all other files. Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>
* docs: Rework the development guideStephen Finucane2016-02-05
| | | | | | | | | | | | | | | | patchwork has undergone a number of changes recently that can make deployment of a development environment much simpler than it was previously. Unfortunately, these were not illustrated in the documentation. Resolve this oversight by rewriting the developer guide to reflect, for example, the usefulness of the 'parsearchive' script or the fact that environment variables like 'PW_TEST_DB_USER' do not always need to be exported. This includes changes to the provided 'default_projects' fixture: the existing projects weren't chosen for any particular reason and the rewritten guide expects a 'patchwork' project to exist. Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>
* docs: Add an upgrading guideStephen Finucane2016-02-05
| | | | | | | | | | | The guide details the general pitfalls such users may encounter when upgrading a patchwork. Upgrading older deployments of patchwork, particularly those that are pre-1.0, can be a daunting task and this guide should support users in this task. However, it should not replace the UPGRADING document but rather supplement it with more general, non-version specific advice. Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>
* docs: Add a release process guideStephen Finucane2016-02-05
| | | | | | | | This guide serves to illustrate import aspects of patchworks release process: when, why and how. It also serves as a helpful reminder for the maintainers themselves. Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>
* 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>
* py3: Remove all deprecated UnitTest callsStephen Finucane2015-12-03
| | | | | | | | | | | Remove the likes of 'failUnlessEqual' and 'assertEquals', which have been deprecated and cause warnings in Django 1.6 with Python 3.4. https://docs.python.org/2/library/unittest.html#deprecated-aliases This allows us to remove an item from the TODO list. 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: Remove 'apps' from pathsDamien Lespiau2015-11-12
| | | | | | | | The patchwork directory structure has moved away from putting the Django app(s) into 'apps/' Signed-off-by: Damien Lespiau <damien.lespiau@intel.com> Reviewed-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>
* TODO: cleanup deprecated unittest aliasesaldot2015-11-12
| | | | | Signed-off-by: Bernhard Reutner-Fischer <rep.dot.nop@gmail.com> Reviewed-by: Stephen Finucane <stephen.finucane@intel.com>
* tests: Add a couple of Selenium testsDamien Lespiau2015-11-05
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* docs: Add basic API guideStephen Finucane2015-10-26
| | | | | | | | 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>
* docs: Update Git URLs to GitHubStephen Finucane2015-10-26
| | | | | | | | Per move to GitHub: https://lists.ozlabs.org/pipermail/patchwork/2015-October/001873.html Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>
* doc: Add CHANGELOG and UPGRADING docsStephen Finucane2015-10-26
| | | | | | | | | | | | | | | | 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>
* 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>
* tox: Update versions of Django to be testedStephen Finucane2015-09-17
| | | | | | | | | | | | | 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>
* patchwork: Explicitly load states fixturesJeremy Kerr2015-06-05
| | | | | | | | | | | 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>
* cron: Move patchwork-cron script to a management commandJeremy Kerr2015-05-28
| | | | Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* doc: Add NEWS file for recent updatesJeremy Kerr2015-05-28
| | | | | | ... containing a guide to migrating to the recent changes. Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* Add patch tag infrastructureJeremy Kerr2015-05-28
| | | | | | | | | | | | | | | | | | | | | 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>
* docs: Add collectstatic step to installation instructionsJeremy Kerr2015-05-28
| | | | | | | Because we're now using the staticfiles app, we need to run collectstatic on init. Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
generated by cgit v1.2.3 (git 2.45.0) at 2024-11-28 03:08:24 +0000