aboutsummaryrefslogtreecommitdiff
path: root/docs/usage
Commit message (Collapse)AuthorAge
* REST: Add 'actor' field to '/events' modelJohan Herland2019-12-01
| | | | | | | | Signed-off-by: Johan Herland <johan@herland.net> Reviewed-by: Stephen Finucane <stephen@that.guru> Acked-by: Daniel Axtens <dja@axtens.net> Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Closes: #73
* docs: document snowpatch as an API clientDaniel Axtens2019-10-18
| | | | | | | | Snowpatch is one of the few publically visible API clients. Document it in the clients list. Signed-off-by: Daniel Axtens <dja@axtens.net> Reviewed-by: Stephen Finucane <stephen@that.guru>
* Remove pwclientStephen Finucane2019-06-17
| | | | | | | | | Let's start managing this via a separate project, which will allow the client to evolve separately from the server. No redirect is added for the old '/pwclient' URL as it seems wiser to return a HTTP 404 error code. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Fix design docStephen Finucane2018-10-30
| | | | | | | These items weren't really headers and shouldn't have been rendered as such. Signed-off-by: Stephen Finucane <stephen@that.guru>
* 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: 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>
* 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: 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: 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: 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: 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: Covert usage guideStephen Finucane2017-04-18
| | | | 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>
* 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: 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: 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>
generated by cgit v1.2.3 (git 2.45.0) at 2024-11-22 00:17:12 +0000