aboutsummaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAge
* 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>
* docs: Convert development guideStephen Finucane2017-04-18
| | | | Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Convert deployment guideStephen Finucane2017-04-18
| | | | Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Covert usage guideStephen Finucane2017-04-18
| | | | Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Convert README, indexStephen Finucane2017-04-18
| | | | | | | 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>
* docs: Add skeleton for Sphinx docsStephen Finucane2017-04-18
| | | | | | | | 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>
* docs: Add events to usage guideStephen Finucane2017-03-01
| | | | | Signed-off-by: Stephen Finucane <stephen@that.guru> Tested-by: Daniel Axtens <dja@axtens.net>
* docs: Resolve some issues with the 'usage' guideStephen Finucane2017-03-01
| | | | | | | | 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>
* 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>
* Improve documentation of delegation rulesStephen Finucane2017-02-08
| | | | | | | | | | | | | | 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>
* 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: link to deployment/development installation page in indexDenis Laxalde2017-02-06
| | | | | | | | Previous links are broken. Signed-off-by: Denis Laxalde <denis@laxalde.org> Reviewed-by: Daniel Axtens <dja@axtens.net> Reviewed-by: Stephen Finucane <stephen@that.guru>
* docs: Provide overview documentStephen Finucane2017-01-22
| | | | | | | | This details the various top level elements that Patchwork exposes. This could be stored as source code documentation, but then users would need to look at the source. Signed-off-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: Update swagger definitionStephen Finucane2016-12-23
| | | | | | | | | | | | | | | There are a couple of changes needed: - Add the '/users' endpoint - Add PATCH support for the '/projects' endpoint - Add information on authentication - Clean up some documentation - Remove some non-implemented parameters This is still not complete, but it bears a lot closer resemblence to reality now. 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 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>
generated by cgit v1.2.3 (git 2.45.0) at 2024-11-28 07:35:18 +0000