aboutsummaryrefslogtreecommitdiff
path: root/docs
Commit message (Expand)AuthorAge
* docs: Prepare for 2.1.0-rc1•••Patchwork v2.1.0 will be Eolienne. Move the "unreleased" notes to eolienne. We'll add a new 'unreleased' right after tagging the final 2.1.0 Signed-off-by: Daniel Axtens <dja@axtens.net> Daniel Axtens2018-05-08
* docker-compose: Switch to 3.0 syntax•••Ubuntu 18.04 (Bionic Beaver) providers 'docker-compose' 1.17.1 [1] at release which supports the 3.0 syntax [2]. Using this allows some users (me) to resolve a long standing issue caused by a UID that's not 1000. [1] https://packages.ubuntu.com/bionic/docker-compose [2] https://docs.docker.com/compose/compose-file/ Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2018-04-26
* tests: Remove Selenium tests•••These were added quite some time ago in order to allow some level of UI testing. However, I've personally never used them, they're not used by the CI, and no one has shown any desire in extending them in their time here. It is time to bid these tests adieu. Removing these allows us to remove a whole load of wiring that existed just to enable these. Some of this, like the '--quick-tox' option for the Dockerfile, is retained so we don't need to use different commands for various versions of Patchwork, but the majority is just stripped out. Signed-off-by: Stephen Finucane <stephen@that.guru> Cc: Daniel Axtens <dja@axtens.net> Stephen Finucane2018-04-26
* Update sphinx_rtd_theme from 0.2.4 to 0.3.0pyup-bot2018-04-25
* docs: Random fixes•••Remove an unnecessary 'toctree' from the index page and fix some definition lists. Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2018-04-24
* docs: Read version from 'patchwork.VERSION'•••Because this isn't an installable package we need to do some path hackery. Not the end of the world though. Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Daniel Axtens <dja@axtens.net> Stephen Finucane2018-04-14
* docs: Add note on restoring the docker database•••If you back something up, you'd probably want to restore it soon enough too. Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2018-04-09
* docs: Add note on backing up the docker database•••I'm sick of waiting for 'parsearchive' to finish. Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2018-04-07
* docs: Add information on REST API versioning•••This isn't too prescriptive, given that so far we've only dealt with adding new fields. However, it should serve as a guide to alert devs that this stuff exists and should be a concern. Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2018-04-07
* Fix incorrect autodelegation documentation•••The docs suggested to account for git prefixes (a/, b/) using eg. ?/patchwork/views/*. My rules didn't work so I tried bare path (patchwork/views/*) instead. Looking at the code, the prefix really is striped away (filename = '/'.join(filename.split('/')[1:])). Fix the documentation to reflect on what is really happening. Signed-off-by: Veronika Kabatova <vkabatov@redhat.com> [dja: see 7bb0ebd78ff7 ("parser: Add patch_get_filenames()")] Signed-off-by: Daniel Axtens <dja@axtens.net> Veronika Kabatova2018-04-05
* docs: Update reference to kernel documentation•••The referenced url was moved to Documentation/process. Signed-off-by: Ali Alnubani <alialnu@mellanox.com> Signed-off-by: Daniel Axtens <dja@axtens.net> Ali Alnubani2018-04-05
* docs: Fix package name•••Fixed a typo that instructed to install tox instead of reno. Signed-off-by: Ali Alnubani <alialnu@mellanox.com> Signed-off-by: Daniel Axtens <dja@axtens.net> Ali Alnubani2018-04-05
* Avoid timezone confusion•••Patchwork saves patches, comments etc with UTC timezone and reports this time when opening the patch details. However, internally generated processes such as events are reported with the instance's local time. There's nothing wrong with that and making PW timezone-aware would add useless complexity, but in a world-wide collaboration a lot of confusion may arise as the timezone is not reported at all. Instance's local time might be very different from the local time of CI integrating with PW, which is different from the local time of person dealing with it etc. Use UTC everywhere by default instead of UTC for sumbissions and local timezone for internally generated events (which is not reported). Signed-off-by: Veronika Kabatova <vkabatov@redhat.com> [dja: - squash 2 patches: https://patchwork.ozlabs.org/patch/876744/ https://patchwork.ozlabs.org/patch/877815/ - minor changes to both patches - rejig order of migrations and adjust wording: "happened sooner" -> "happened earlier"] Tested-by: Daniel Axtens <dja@axtens.net> Signed-off-by: Daniel Axtens <dja@axtens.net> Veronika Kabatova2018-03-08
* Implement list filtering•••Sometimes, multiple projects reside at the same mailing list. So far, Patchwork only allowed a single project per mailing list, which made it impossible for these projects to use Patchwork (unless they did some dirty hacks). Add a new property `subject_match` to projects and implement filtering on (list_id, subject_match) match instead of solely list_id. Instance admin can specify a regex on a per-project basis when the project is created. Signed-off-by: Veronika Kabatova <vkabatov@redhat.com> Signed-off-by: Stephen Finucane <stephen@that.guru> Veronika Kabatova2018-02-27
* tools: drop vagrant•••It served us well, but it's now outdated (Trusty, Python 3.4, etc) There is no indication that anyone uses it or keeps it up to date. Signed-off-by: Daniel Axtens <dja@axtens.net> Acked-by: Stephen Finucane <stephen@that.guru> Reviewed-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com> Daniel Axtens2018-02-27
* docs: X-Patchwork-Ignore doesn't work, X-Patchwork-Hint: ignore does•••Make this match what is tested for in parser.py Signed-off-by: Daniel Axtens <dja@axtens.net> Daniel Axtens2018-02-24
* Don't aim to have patchwork send email•••Getting things like SPF and DKIM right for this would be nigh-on impossible, plus it would mean sysadmins would have to let patchwork send email, which is a risk to the reputation of their systems. Let's just aim for being a read-only representation of the mailing list for now. Reviewed-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com> Signed-off-by: Daniel Axtens <dja@axtens.net> Daniel Axtens2018-02-22
* docs/development: Fix tox invocation for listing targets•••Signed-off-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com> Reviewed-by: Daniel Axtens <dja@axtens.net> Reviewed-by: Stephen Finucane <stephen@that.guru> Andrew Donnellan2018-01-09
* Remove support for Django 1.6, 1.7•••These versions are massively outdated and the only reason for keeping them was to allow installation on RHEL 7 using the version provided via EPEL. No one's actually using this so just kill it. This also allows us to remove support for django-filter 0.11, which was only retained for use with these older versions of Django. Signed-off-by: Stephen Finucane <stephen@that.guru> Reviewed-by: Daniel Axtens <dja@axtens.net> Stephen Finucane2018-01-04
* doc: Remove references to 'UPGRADING' and 'CHANGELOG'•••These documents have been replaced by release notes. Remove references to them. Signed-off-by: Stephen Finucane <stephen@that.guru> Reviewed-by: Daniel Axtens <dja@axtens.net> Stephen Finucane2018-01-04
* doc: Use RTD theme locally•••This ensures things look the same locally as on readthedocs.org. Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2017-11-02
* docs: Add index pages•••This lets me go to, for example, the following URLs: https://patchwork.readthedocs.io/en/latest/releases/ Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2017-11-02
* doc: Fix wrong example in usage overview•••Looks like a simple copy and paste mistake. Signed-off-by: Alexander Dahl <post@lespocky.de> Alexander Dahl2017-11-01
* docs: Update release process guide•••Provide a little more information about why we do what we do. Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2017-08-28
* docs: Update reno for stable/2.0•••Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2017-08-23
* docs: Document token auth support•••Signed-off-by: Stephen Finucane <stephen@that.guru> Acked-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com> Stephen Finucane2017-06-14
* docs: Document the various htdocs supported•••Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2017-06-14
* docs: Document how to access SQL console•••Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2017-06-14
* docs: Document the various management commands available•••As requested. Signed-off-by: Stephen Finucane <stephen@that.guru> Reported-by: Thomas Monjalon <thomas@monjalon.net> Closes-bug: #77 Stephen Finucane2017-05-30
* docs/api: change POST to PATCH in REST API parameters example•••api/rest.rst gives an example of how to POST parameters to the PatchDetail view at api/patches/<patch_id>. However, the endpoint in question doesn't support POST - you need to use PUT or PATCH. Change it to PATCH. Signed-off-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com> Reviewed-by: Stephen Finucane <stephen@that.guru> Andrew Donnellan2017-05-26
* docs: Don't mention 'default_project' in deployment guide•••The deployment guide currently suggests using the 'default_project' fixture when deploying a production installation of Patchwork. While one _could_ use this, it's generally unnecessary given that most people care about their own projects and not Patchwork. Resolve this by simply removing any references. The references are retained for the development installation guide, as they're likely useful here. Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2017-05-18
* docs: Update installation guide for Ubuntu 16.04•••Use the latest LTS version of Ubuntu. This is mostly a simplification of the guide, which reverts back to single-node configuration and increases the emphasis on installing system packages rather than using 'pip'. There are also a series of corrections, mostly around using the Python 3 variants of packages. Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2017-05-04
* docs: Misc fixes•••Add release note requirement to contributing and fix some issues with the development installation guide. Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2017-04-29
* docs: Emphasise the cron job•••Having talked to a few folks deploying Patchwork, it appears not everyone is aware of/enabling the Patchwork cron job. Emphasise this feature by moving it to its own section. This section is marked as optional, given that it's not truly required but is helpful. Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2017-04-29
* docs: Add a configuration guide•••This should simplify matters for folks that don't have much experience with Django. It also serves to highlight the 'ENABLE_REST_API' option. A release note is also added to capture the rename of DEFAULT_PATCHES_PER_PAGE that has occurred during this cycle. Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2017-04-29
* REST: Allow users to omit version entirely•••This is super handy for debugging/development of Patchwork and Patchwork clients alike. Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2017-04-28
* docs: Split API docs into their own section•••Third time lucky. There are two changes: - Add a new 'clients' section to the usage doc, allowing us to remove a lot of the API nitty gritty stuff from the users guide. This makes more sense as users don't really care what API method they're using - only what application). - Change the API docs from the developers guide into a quick start section, allowing us to greatly expand the REST API docs to include information on pagination, authentication, etc. Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2017-04-26
* docs: Add REST API usage guide•••This details the availability of 'git-pw'. The other API usage and development guides are updated accordingly. Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2017-04-23
* docs: Migrate release notes to rST•••This allows us to remove both UPGRADING and CHANGELOG. Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2017-04-18
* Add reno for release notes management•••An initial patch to add reno and create a base directory for release notes. Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2017-04-18
* docs: Remove old Markdown files•••Everything is now ported to rST/Sphinx meaning we can remove the Markdown versions. Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2017-04-18
* docs: Convert development guide•••Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2017-04-18
* docs: Convert deployment guide•••Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2017-04-18
* docs: Covert usage guide•••Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2017-04-18
* docs: Convert README, index•••We can remove the Markdown README but must keep the index page until all docs are migrated. Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2017-04-18
* docs: Add skeleton for Sphinx docs•••This is mostly the output of 'sphinx-quickstart' with all non-HTML build cruft removed and Sphinx minimum version set to 1.5. A tox target is included and the output of the docs build ignored. Signed-off-by: Stephen Finucane <stephen@that.guru> Stephen Finucane2017-04-18
* docs: Add events to usage guide•••Signed-off-by: Stephen Finucane <stephen@that.guru> Tested-by: Daniel Axtens <dja@axtens.net> Stephen Finucane2017-03-01
* docs: Resolve some issues with the 'usage' guide•••The headings in this file were all over the place. Resolve this. Signed-off-by: Stephen Finucane <stephen@that.guru> Fixes: 86100924 ("docs: Provide overview document") Tested-by: Daniel Axtens <dja@axtens.net> Stephen Finucane2017-03-01
* docs: Clarify docker instructions•••It's possible to run 'manage.py' commands when using the Docker container but this is not documented anywhere. Clarify this. Signed-off-by: Stephen Finucane <stephen@that.guru> Acked-by: Daniel Axtens <dja@axtens.net> Stephen Finucane2017-03-01
* Improve documentation of delegation rules•••Per feedback from FOSDEM, this is still confusing some people. Clarify things. You might think we could just strip of the offending prefixes but that might not always be the thing to do. Other VCSs don't include these prefixes and both 'a' and 'b' are valid folder names. The risk of false positives might be small, but it's enough to discourage us from doing this. Signed-off-by: Stephen Finucane <stephen@that.guru> Reviewed-by: Thomas Monjalon <thomas.monjalon@6wind.com> Stephen Finucane2017-02-08