summaryrefslogtreecommitdiff
path: root/docs/development
Commit message (Collapse)AuthorAge
* docs: Random Python 3 updatesStephen Finucane2021-02-20
| | | | | | | Correct some documentation examples and other things to reflect the new, Python 3-only world. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Remove references to Python 2.7Stephen Finucane2020-04-08
| | | | Signed-off-by: Stephen Finucane <stephen@that.guru>
* Replace references to Django 1.11 docsStephen Finucane2020-04-08
| | | | | | | This is a straight forward swap, thankfully. Django 2.2 is chosen as it's the latest LTS. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Reference current list-idStephen Finucane2020-02-28
| | | | | | | | We've updated our fixtures to use this newer version, meaning we no longer need to pass an explicit '--list-id' argument. Lovely. Signed-off-by: Stephen Finucane <stephen@that.guru> Fixes: 9a0b5992 ("fixtures: Update Patchwork list ID")
* docs: set the GID in the .env filePranav Annam2020-02-17
| | | | | | | | | | | | | | | The .env file needs the UID and GID for a working docker-compose build. If you follow the current instructions, the docker build fails with a clear error message: 'You must define GID in .env' It is still good to update documentation to reduce the burden on new contributors to run into this build failure first. Signed-off-by: Pranav Annam <pranavannam@gmail.com> [simply provide bash command in docs, reworked commit message] Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com> Signed-off-by: Daniel Axtens <dja@axtens.net>
* docs: Fix link to deployment guideAli Alnubani2019-10-29
| | | | | | | | The old format redirects to a nonexistent page when there are multiple versions of the docs. Signed-off-by: Ali Alnubani <alialnu@mellanox.com> Signed-off-by: Daniel Axtens <dja@axtens.net>
* docs: Add documentation for pre-commitStephen Finucane2019-09-27
| | | | | | Explain what it is and why you should use it. Signed-off-by: Stephen Finucane <stephen@that.guru>
* Drop support for Python 3.4, add Python 3.7Stephen Finucane2019-09-08
| | | | | | | It's no longer supported upstream and the *second* last Ubuntu LTS release provides something newer. Time to move on. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Document backport criteriaStephen Finucane2019-05-24
| | | | | | | | | | | | Explain why we don't want to be in the business of backport certain patches, in the long run. It took me a while to put this into words but I was helped by a similar discussion ongoing in the OpenStack community at the moment [1]. [1] http://lists.openstack.org/pipermail/openstack-discuss/2019-May/006220.html Signed-off-by: Stephen Finucane <stephen@that.guru> Acked-by: Daniel Axtens <dja@axtens.net>
* docs: Mention Postgres for Docker development installRussell Currey2019-05-03
| | | | | | | | | | Might as well since it's there, and it gives some clue to anyone trying to use Docker on non-x86. I figured it was best to leave this out of the README since it's incredibly niche. Signed-off-by: Russell Currey <ruscur@russell.cc> Reviewed-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com> Signed-off-by: Daniel Axtens <dja@axtens.net>
* docs: Move REST API guide to subfolderStephen Finucane2019-01-29
| | | | | | | | | | We're going to dramatically expand these docs, so let's set up room to do so. This shouldn't break any links as we're using 'htmldir' output on ReadTheDocs. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Add documentation for django-dbbackupStephen Finucane2018-10-10
| | | | | | | | This replaces the older manual backup steps. The section on 'django-debug-toolbar' is updated to match the new 'django-dbbackup' section. Signed-off-by: Stephen Finucane <stephen@that.guru>
* doc: Cleanup development installation guideStephen Finucane2018-10-10
| | | | | | | | Use literals where possible, don't leave a space between a term and definition, and note that Python 3.4, not 3.3, is now the minimum supported version of Python 3. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Note new requirement to include a SPDX lineStephen Finucane2018-09-19
| | | | | | | | | | Add some wording around the requirement to include this line instead of the license header. Also note the requirement that all code be licensed using the 'GPL-2.0-or-later' license and add a CONTRIBUTING document, which GitHub likes. Signed-off-by: Stephen Finucane <stephen@that.guru> Reviewed-by: Veronika Kabatova <vkabatov@redhat.com>
* 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 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>
* 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>
* 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: 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>
* 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>
* 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/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>
* 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>
* 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: 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: 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: 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: 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>
* docs: Convert development guideStephen Finucane2017-04-18
| | | | Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Clarify docker instructionsStephen Finucane2017-03-01
| | | | | | | | 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>
* docs: fix links to installation pagesDenis Laxalde2017-02-06
| | | | | | Signed-off-by: Denis Laxalde <denis@laxalde.org> Reviewed-by: Daniel Axtens <dja@axtens.net> Reviewed-by: Stephen Finucane <stephen@that.guru>
* docs: fix links to "contributing" pageDenis Laxalde2017-02-06
| | | | | | Signed-off-by: Denis Laxalde <denis@laxalde.org> Reviewed-by: Daniel Axtens <dja@axtens.net> Reviewed-by: Stephen Finucane <stephen@that.guru>
* docs: Bring import of archives up to top-levelStephen Finucane2017-01-22
| | | | | | | This applies whether you're using the Docker-, Vagrant- or manual- based installation methods. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Highlight UID issueStephen Finucane2016-12-23
| | | | | | | This occurs on Fedora 24, Fedora 25. There was a brief mention of it in the docker-compose file but no resolution was offered. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Document how to backport patchesStephen Finucane2016-12-13
| | | | 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>
generated by cgit v1.2.3 (git 2.25.4) at 2024-09-21 09:04:56 +0000