summaryrefslogtreecommitdiff
path: root/docs/index.rst
blob: 11bafb05e152785e68a727f9f0f08fbff846eb75 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
Patchwork
=========

Patchwork is a patch tracking system for community-based projects. It is
intended to make the patch management process easier for both the project's
contributors and maintainers, leaving time for the more important (and more
interesting) stuff.

Patches that have been sent to a mailing list are 'caught' by the system, and
appear on a web page. Any comments posted that reference the patch are appended
to the patch page too. The project's maintainer can then scan through the list
of patches, marking each with a certain state, such as Accepted, Rejected or
Under Review. Old patches can be sent to the archive or deleted.

Currently, Patchwork is being used for a number of open-source projects, mostly
subsystems of the Linux kernel. Although Patchwork has been developed with the
kernel workflow in mind, the aim is to be flexible enough to suit the majority
of community projects.

.. toctree::
   :maxdepth: 2
   :caption: Usage Documentation

   usage/overview
   usage/design
   usage/delegation
   usage/headers
   usage/clients

.. toctree::
   :maxdepth: 2
   :caption: Deployment Documentation

   deployment/installation
   deployment/configuration
   deployment/management
   deployment/upgrading

.. toctree::
   :maxdepth: 2
   :caption: Development Documentation

   development/contributing
   development/installation
   development/releasing
   development/api
   development/assets

.. toctree::
   :maxdepth: 2
   :caption: API Documentation

   api/rest/index
   api/xmlrpc

.. toctree::
   :maxdepth: 2
   :caption: Release Notes

   releases/unreleased
   releases/flannel
   releases/eolienne
   releases/dazzle
   releases/cashmere
   releases/burlap
   releases/alpaca