aboutsummaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAge
* docs: Fix user's profile urlAli Alnubani2019-02-25
| | | | | Signed-off-by: Ali Alnubani <alialnu@mellanox.com> Reviewed-by: Stephen Finucane <stephen@that.guru>
* docs: Integrate API schema into docsStephen Finucane2019-01-29
| | | | | | | | This takes advantage of the sphinxcontrib-openapi Sphinx extension, which allows us to embed the REST API documentation into our docs quite nicely. Signed-off-by: Stephen Finucane <stephen@that.guru>
* 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: Remove crud from conf.pyStephen Finucane2019-01-29
| | | | | | | | Most of this was removed in a previous release but there is yet more to go. These values are all (a) defaults or (b) never triggered. Remove them. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Detail JSON PATCH requestsStephen Finucane2018-12-25
| | | | | | | | It turns out it is possible to make PATCH requests with JSON bodies rather than form-encoded data - you just need to include a Content-Type header. Document this. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Reformat schemasStephen Finucane2018-12-24
| | | | | | Tested using 'yamllint'. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Add parameter descriptions, typesStephen Finucane2018-12-24
| | | | Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Move 'parameter.schema.description' to 'parameter'Stephen Finucane2018-12-24
| | | | | | | | | As noted in a bug against the spec [1], there is some duplication here. Go with the more obvious path until that confusion is cleared up. [1] https://github.com/OAI/OpenAPI-Specification/issues/1788 Signed-off-by: Stephen Finucane <stephen@that.guru>
* Pin jinja2 to latest version 2.10pyup-bot2018-12-22
|
* docs: Remove old Swagger 2.0 specStephen Finucane2018-12-22
| | | | | | | This was incomplete and wrong in many places. It's since been replaced by the OpenAPI 3.0.0 specs, so we have happily remove this now. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Store versioned OpenAPI schemasStephen Finucane2018-12-22
| | | | Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Make API document versionedStephen Finucane2018-12-22
| | | | | | | | | | | | | | | OpenAPI doesn't appear to support versioning natively, suggesting instead that separate documents are kept. Rather than doing this manually, let's use a templating tool - Jinja2, in this case - to generate these document for us from a single master document. Note that while we can now auto-generate these whenever we need them (and we tend to avoid storing auto-generated assets in VCS), these change so rarely that it's easier to just store them. This also means we can reference the schemas themselves online. We do this in a following change. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Document the '/events' resourceStephen Finucane2018-12-22
| | | | | | | | This is the final resource to document and also the most complicated, on account of the polymorphism of the responses. However, with this done, our first pass at an OpenAPI 3.0 schema is completed. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Document the '/patches/{patch_id}/checks' resourceStephen Finucane2018-12-22
| | | | Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Document the '/patch/{id}/comments' resourceStephen Finucane2018-12-22
| | | | Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Document the '/covers/{id}/comments' resourceStephen Finucane2018-12-22
| | | | | | | Our first nested resource. Nothing too weird here though, save for the raising of a HTTP 404 on a list resource (due to a missing patch). Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Document the '/series' resourceStephen Finucane2018-12-22
| | | | Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Document the '/patches' resourceStephen Finucane2018-12-22
| | | | | | The big one (TM). Nothing too odd here though. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Document the '/covers' resourceStephen Finucane2018-12-22
| | | | | | | Again, we're adding embedded serializers before the main resource but that will come. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Document the '/bundles' resourceStephen Finucane2018-12-22
| | | | | | | | | This one's a little unusual too, in that we provide the embedded serializer for resources we haven't defined the end resource for. That's necessary in general, due to recursive references in the API (series-patch, patch-series etc.) so might as well embrace it early. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Document the '/projects' resourceStephen Finucane2018-12-22
| | | | | | This one's pretty straightforward. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Document the '/people' resourceStephen Finucane2018-12-22
| | | | | | | | This introduces our first use of embedded serializers, which are separate models from the main ones. Other than that, this is pretty standard. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Document the '/users' resourceStephen Finucane2018-12-22
| | | | | | | This introduces our first use of parameters, both in the path and the query. The latter are extracted out as they'll be used by later changes. Signed-off-by: Stephen Finucane <stephen@that.guru>
* docs: Start documenting API using OpenAPIStephen Finucane2018-12-22
| | | | | | | | | | | | | | | When the REST API was first added, we attempted to document it using OpenAPI 2.0 (formerly Swagger). This was mostly never completed because (a) it was really tedious and (b) no one was that bothered. However, as we expand the range of clients for the REST API, having a well documented API becomes more and more of an asset. Start doing this by adding a brand new schema, this time using OpenAPI. This will entirely replace the older schema and, as such, is namespaced separately. We start by documenting '/' (i.e. the index) page and will add additional resources as we go. 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 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: Add 'unreleased' to release notes index pageStephen Finucane2018-10-06
| | | | | | It's already on the main index page. Signed-off-by: Stephen Finucane <stephen@that.guru>
* Update sphinx_rtd_theme from 0.3.0 to 0.4.2pyup-bot2018-10-06
|
* 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: 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>
generated by cgit v1.2.3 (git 2.45.0) at 2024-11-26 22:13:13 +0000