diff options
| author | Bryn M. Reeves <bmr@redhat.com> | 2014-08-03 20:21:04 +0100 |
|---|---|---|
| committer | Bryn M. Reeves <bmr@redhat.com> | 2014-08-03 20:21:04 +0100 |
| commit | d80b7721293be9052cdc330d032755cba2689676 (patch) | |
| tree | 791ca8bee1a9d5affec1bd27dd433166c8245de6 | |
| parent | 9cb5f47dfbc27976a121fd346b02048634750501 (diff) | |
| download | sos-d80b7721293be9052cdc330d032755cba2689676.tar.gz | |
[docs] sync README.md and index.rst
Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | docs/index.rst | 16 |
2 files changed, 13 insertions, 5 deletions
@@ -27,7 +27,7 @@ Issue Tracker][5] The [sos-devel][4] is the mailing list for any sos-related questions and discussion. Patch submissions and reviews are welcome too. -## Developers +## Patches and pull requests Patches can be submitted via the mailing list or as GitHub pull requests. If using GitHub please make sure your branch applies to the current master as a diff --git a/docs/index.rst b/docs/index.rst index 10e0c691..77fa5eba 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -25,13 +25,18 @@ Mailing list `sos-devel <https://www.redhat.com/mailman/listinfo/sos-devel>`_ is the mailing list for any sos-related questions and discussion. Patch submissions and reviews are welcome too. -Developers -^^^^^^^^^^ +Patches and pull requests +^^^^^^^^^^^^^^^^^^^^^^^^^ Patches can be submitted via the mailing list or as GitHub pull requests. If using GitHub please make sure your branch applies to the current master as a 'fast forward' merge (i.e. without creating a merge commit). Use the git rebase command to update your branch to the current master if necessary. -Wiki documentation -^^^^^^^^^^^^^^^^^^ +Documentation +============= + +User and API `documentation <http://sos.readthedocs.org/en/latest/index.html#>`_ is automatically generated using `Sphinx <http://sphinx-doc.org/>`_ and `Read the Docs <https://www.readthedocs.org/>`_. + +Wiki +^^^^ `How to write a plugin <https://github.com/sosreport/sos/wiki/How-to-Write-a-Plugin>`_ @@ -41,6 +46,9 @@ Wiki documentation To help get your changes merged quickly with as few revisions as possible please refer to the `Contributor Guidelines <https://github.com/sosreport/sos/wiki/Contribution-Guidelines>`_ when submitting patches or pull requests. +Installation +============ + Manual Installation ^^^^^^^^^^^^^^^^^^^ |