diff options
Diffstat (limited to 'docs/index.rst')
-rw-r--r-- | docs/index.rst | 87 |
1 files changed, 87 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..c769e868 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,87 @@ +SoS +=== + +Sos is an extensible, portable, support data collection tool primarily aimed at Linux distributions and other UNIX-like operating systems. + +This project is hosted at: + +http://github.com/sosreport/sos +For the latest version, to contribute, and for more information, please visit the project pages or join the mailing list. + +To clone the current master (development) branch run: + +.. code:: + + git clone git://github.com/sosreport/sos.git + +Reporting bugs +^^^^^^^^^^^^^^ + +Please report bugs via the mailing list or by opening an issue in the GitHub Issue Tracker + +Mailing list +^^^^^^^^^^^^^ + +The sos-devel mailing list is used to discussi sos development and reviewing patches. User questions and general discussion are welcome too. + +Developers +^^^^^^^^^^ + +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 +^^^^^^^^^^^^^^^^^^ + + How to write a plugin + + How to write a policy + + Plugin options + +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. + +Manual Installation +^^^^^^^^^^^^^^^^^^^ + +.. code:: + + to install locally (as root) ==> make install + to build an rpm ==> make rpm + to build a deb ==> make deb + +Pre-built Packaging +^^^^^^^^^^^^^^^^^^^ + +Fedora/RHEL users install via yum: + +``yum install sos`` + +Debian(Sid) users install via apt: + +``apt-get install sosreport`` + +Ubuntu(Saucy 13.10 and above) users install via apt: + +``sudo apt-get install sosreport`` + +API +=== + +Plugin Reference +^^^^^^^^^^^^^^^^ + +.. toctree:: + :maxdepth: 2 + + plugins + + +Core Reference +^^^^^^^^^^^^^^ + +.. toctree:: + :maxdepth: 2 + + archive + reporting + utilities |