| Commit message (Expand) | Author | Age |
* | docs: Fix design doc•••These items weren't really headers and shouldn't have been rendered as
such.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2018-10-30 |
* | docs: Add 'local' argument to 'contents'•••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>
| Stephen Finucane | 2018-05-12 |
* | 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 Finucane | 2018-04-24 |
* | 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 Kabatova | 2018-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 Alnubani | 2018-04-05 |
* | 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 Axtens | 2018-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 Axtens | 2018-02-22 |
* | 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 Finucane | 2017-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 Dahl | 2017-11-01 |
* | 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 Finucane | 2017-05-30 |
* | 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 Finucane | 2017-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 Finucane | 2017-04-23 |
* | 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 Finucane | 2017-04-18 |
* | docs: Covert usage guide•••Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2017-04-18 |
* | docs: Add events to usage guide•••Signed-off-by: Stephen Finucane <stephen@that.guru>
Tested-by: Daniel Axtens <dja@axtens.net>
| Stephen Finucane | 2017-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 Finucane | 2017-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 Finucane | 2017-02-08 |
* | docs: Provide overview document•••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>
| Stephen Finucane | 2017-01-22 |
* | docs: Add delegation guide•••We do autodelegation - let's tell people all about it.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2016-10-11 |
* | docs: Add X-Patchwork-* header documentation•••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>
| Stephen Finucane | 2016-10-11 |
* | docs: Add basic REST API documentation•••This is only user-facing for now. Developer focused docs can be added
later.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2016-10-11 |
* | docs: Rework XML-RPC docs•••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>
| Stephen Finucane | 2016-10-11 |