diff options
| author | Stephen Finucane <stephen@that.guru> | 2017-03-22 23:17:16 +0000 |
|---|---|---|
| committer | Stephen Finucane <stephen@that.guru> | 2017-04-18 22:08:32 +0100 |
| commit | 06378101d9cfc0d4aec78980ae4c7eaf66a187ab (patch) | |
| tree | e9b77c12c64ad0cfb6275eec72f3c54ecde46cf0 /docs/index.rst | |
| parent | ea9514e09bc7608c5a9c9d16a0c2794661aaab2f (diff) | |
| download | patchwork-06378101d9cfc0d4aec78980ae4c7eaf66a187ab.tar patchwork-06378101d9cfc0d4aec78980ae4c7eaf66a187ab.tar.gz | |
docs: Covert usage guide
Signed-off-by: Stephen Finucane <stephen@that.guru>
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 72 |
1 files changed, 11 insertions, 61 deletions
diff --git a/docs/index.rst b/docs/index.rst index 7a9ce09..b7fb8d9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,10 +1,6 @@ Patchwork ========= -.. toctree:: - :maxdepth: 2 - :caption: Contents: - 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 @@ -21,61 +17,15 @@ 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. -Download --------- - -The latest version of Patchwork is available with git. To download: - -.. code-block:: shell - - $ git clone git://github.com/getpatchwork/patchwork - -Patchwork is distributed under the `GNU General Public License (v2)`__. - -__ http://www.gnu.org/licenses/gpl-2.0.html - -Design ------- - -Patchwork should supplement mailing lists, not replace them -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Patchwork isn't intended to replace a community mailing list; that's why you -can't comment on a patch in Patchwork. If this were the case, then there would -be two forums of discussion on patches, which fragments the patch review -process. Developers who don't use Patchwork would get left out of the -discussion. - -However, a future development item for Patchwork is to facilitate on-list -commenting, by providing a "send a reply to the list" feature for logged-in -users. +.. _user-docs: -Don't pollute the project's changelogs with Patchwork poop -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -A project's changelogs are valuable - we don't want to add Patchwork-specific -metadata. - -Patchwork users shouldn't require a specific version control system -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Not everyone uses git for kernel development, and not everyone uses git for -Patchwork-tracked projects. - -It's still possible to hook other programs into Patchwork, using the pwclient -command-line client for Patchwork, or directly to the XML RPC interface. - -Getting Started ---------------- - -You should check out the `deployment/installation` and -`development/installation` guides for information on how to configure -Patchwork for production and development environments, respectively. - -Support -------- - -All questions and contributions should be sent to the -`Patchwork mailing list`__ - -__ https://ozlabs.org/mailman/listinfo/patchwork +.. toctree:: + :maxdepth: 2 + :caption: User Documentation + + usage/overview + usage/design + usage/delegation + usage/headers + usage/rest + usage/xmlrpc |