summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAge
* docs: Fix documentation of REST_RESULTS_PER_PAGE settingAndrew Donnellan2018-08-26
| | | | | | | | | | In 8fe11180a1a5 ("REST: Add new setting for maximum API page size") I accidentally deleted the versionadded information for REST_RESULTS_PER_PAGE. Restore it. Fixes: 8fe11180a1a5 ("REST: Add new setting for maximum API page size") Signed-off-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com> Signed-off-by: Daniel Axtens <dja@axtens.net>
* REST: Add new setting for maximum API page sizeAndrew Donnellan2018-08-26
| | | | | | | | | | | | | | | | | | In 41790caf59ad ("REST: Limit max page size") we limited the maximum page size to the default page size in the settings. This turns out to be rather restrictive, as we usually want to keep the default page size low, but an administrator may want to allow API clients to fetch more than that per request. Add a new setting, MAX_REST_RESULTS_PER_PAGE, to set the maximum page size. Closes: #202 ("Separate max API page size and default API page size into different settings") Suggested-by: Stewart Smith <stewart@linux.ibm.com> Suggested-by: Joel Stanley <joel@jms.id.au> Signed-off-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com> [dja: set to 250 as per mailing list discussion] Signed-off-by: Daniel Axtens <dja@axtens.net>
* docs: Update reno for stable/2.1Stephen Finucane2018-06-19
| | | | Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Update deployment installation guide for v2.1Stephen Finucane2018-06-02
| | | | | | | | | | | | There are no actual changes needed from the Patchwork side so this is mostly a cleanup. - Use Ubuntu 18.04 (including package names) - Resolve some minor issues with commands - Remove use of "trust" authentication for PostgreSQL - Minor style changes Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Update copyright and remove dead codeStephen Finucane2018-05-21
| | | | | | | | We're firmly in 2018 now and we're also using sphinx_rtd_theme 0.3.0. This means we can bump the copyright and remove what is now dead code. Signed-off-by: Stephen Finucane <stephen@that.guru> Acked-by: Daniel Axtens <dja@axtens.net>
* docs: Update release, contributing guidesStephen Finucane2018-05-21
| | | | | | | | Document the requirement to send an email to the list upon a release and to always send patches via email. Signed-off-by: Stephen Finucane <stephen@that.guru> Acked-by: Daniel Axtens <dja@axtens.net>
* docs: Add 'local' argument to 'contents'Stephen Finucane2018-05-12
| | | | | | | | | This means the page title won't be included in the table of contents, which makes sense. I'm not really sure why this isn't the default, to be honest. Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Daniel Axtens <dja@axtens.net>
* docs: Add additional information about API versionsStephen Finucane2018-05-12
| | | | | | | | | As we're soon going to be supporting a v1.1 API, we should document what versions are available and whether they're supported still (hint: we support both v1.0 and v1.1 at present). Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Daniel Axtens <dja@axtens.net>
* docs: Bump API version in docs to 1.1Stephen Finucane2018-05-09
| | | | | | | Signed-off-by: Stephen Finucane <stephen@that.guru> Fixes: 81e6f8e4 ("docs: Prepare for 2.1.0-rc1") Cc: Daniel Axtens <dja@axtens.net> Signed-off-by: Daniel Axtens <dja@axtens.net>
* docs: Prepare for 2.1.0-rc1Daniel Axtens2018-05-08
| | | | | | | | | 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>
* docker-compose: Switch to 3.0 syntaxStephen Finucane2018-04-26
| | | | | | | | | | | 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>
* tests: Remove Selenium testsStephen Finucane2018-04-26
| | | | | | | | | | | | | | | | 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>
* Update sphinx_rtd_theme from 0.2.4 to 0.3.0pyup-bot2018-04-25
|
* docs: Random fixesStephen Finucane2018-04-24
| | | | | | | Remove an unnecessary 'toctree' from the index page and fix some definition lists. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Read version from 'patchwork.VERSION'Stephen Finucane2018-04-14
| | | | | | | | 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>
* docs: Add note on restoring the docker databaseStephen Finucane2018-04-09
| | | | | | | If you back something up, you'd probably want to restore it soon enough too. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Add note on backing up the docker databaseStephen Finucane2018-04-07
| | | | | | I'm sick of waiting for 'parsearchive' to finish. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Add information on REST API versioningStephen Finucane2018-04-07
| | | | | | | | 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>
* Fix incorrect autodelegation documentationVeronika Kabatova2018-04-05
| | | | | | | | | | | | 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>
* docs: Update reference to kernel documentationAli Alnubani2018-04-05
| | | | | | | The referenced url was moved to Documentation/process. Signed-off-by: Ali Alnubani <alialnu@mellanox.com> Signed-off-by: Daniel Axtens <dja@axtens.net>
* docs: Fix package nameAli Alnubani2018-04-05
| | | | | | | | 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>
* Avoid timezone confusionVeronika Kabatova2018-03-08
| | | | | | | | | | | | | | | | | | | | | | | 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>
* Implement list filteringVeronika Kabatova2018-02-27
| | | | | | | | | | | | | | | 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>
* tools: drop vagrantDaniel Axtens2018-02-27
| | | | | | | | | 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>
* docs: X-Patchwork-Ignore doesn't work, X-Patchwork-Hint: ignore doesDaniel Axtens2018-02-24
| | | | | | Make this match what is tested for in parser.py Signed-off-by: Daniel Axtens <dja@axtens.net>
* Don't aim to have patchwork send emailDaniel Axtens2018-02-22
| | | | | | | | | | | | 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>
* docs/development: Fix tox invocation for listing targetsAndrew Donnellan2018-01-09
| | | | | | Signed-off-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com> Reviewed-by: Daniel Axtens <dja@axtens.net> Reviewed-by: Stephen Finucane <stephen@that.guru>
* Remove support for Django 1.6, 1.7Stephen Finucane2018-01-04
| | | | | | | | | | | | 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>
* doc: Remove references to 'UPGRADING' and 'CHANGELOG'Stephen Finucane2018-01-04
| | | | | | | | 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>
* doc: Use RTD theme locallyStephen Finucane2017-11-02
| | | | | | This ensures things look the same locally as on readthedocs.org. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Add index pagesStephen Finucane2017-11-02
| | | | | | | | 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>
* doc: Fix wrong example in usage overviewAlexander Dahl2017-11-01
| | | | | | Looks like a simple copy and paste mistake. Signed-off-by: Alexander Dahl <post@lespocky.de>
* docs: Update release process guideStephen Finucane2017-08-28
| | | | | | Provide a little more information about why we do what we do. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Update reno for stable/2.0Stephen Finucane2017-08-23
| | | | Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Document token auth supportStephen Finucane2017-06-14
| | | | | Signed-off-by: Stephen Finucane <stephen@that.guru> Acked-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com>
* docs: Document the various htdocs supportedStephen Finucane2017-06-14
| | | | Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Document how to access SQL consoleStephen Finucane2017-06-14
| | | | Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Document the various management commands availableStephen Finucane2017-05-30
| | | | | | | | As requested. Signed-off-by: Stephen Finucane <stephen@that.guru> Reported-by: Thomas Monjalon <thomas@monjalon.net> Closes-bug: #77
* docs/api: change POST to PATCH in REST API parameters exampleAndrew Donnellan2017-05-26
| | | | | | | | | 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>
* docs: Don't mention 'default_project' in deployment guideStephen Finucane2017-05-18
| | | | | | | | | | | | | 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>
* docs: Update installation guide for Ubuntu 16.04Stephen Finucane2017-05-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>
* docs: Misc fixesStephen Finucane2017-04-29
| | | | | | | Add release note requirement to contributing and fix some issues with the development installation guide. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Emphasise the cron jobStephen Finucane2017-04-29
| | | | | | | | | 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>
* docs: Add a configuration guideStephen Finucane2017-04-29
| | | | | | | | | | 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>
* REST: Allow users to omit version entirelyStephen Finucane2017-04-28
| | | | | | | This is super handy for debugging/development of Patchwork and Patchwork clients alike. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Split API docs into their own sectionStephen Finucane2017-04-26
| | | | | | | | | | | | | | | 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>
* docs: Add REST API usage guideStephen Finucane2017-04-23
| | | | | | | 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>
* docs: Migrate release notes to rSTStephen Finucane2017-04-18
| | | | | | This allows us to remove both UPGRADING and CHANGELOG. Signed-off-by: Stephen Finucane <stephen@that.guru>
* Add reno for release notes managementStephen Finucane2017-04-18
| | | | | | | An initial patch to add reno and create a base directory for release notes. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Remove old Markdown filesStephen Finucane2017-04-18
| | | | | | | Everything is now ported to rST/Sphinx meaning we can remove the Markdown versions. Signed-off-by: Stephen Finucane <stephen@that.guru>
generated by cgit v1.2.3 (git 2.25.4) at 2024-11-01 07:33:16 +0000