aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
Commit message (Collapse)AuthorAgeFilesLines
* [docs] Update README for Matrix/IRCJake Hunsaker2021-06-221-0/+12
| | | | | | | Updates the README to include information on the Matrix and IRC rooms used by SoS. Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [readme] Update badgingJake Hunsaker2020-11-231-2/+2
| | | | | | | Update the build badge for the repo README to point to Cirrus-CI instead of Travis now that we've switched CI platforms. Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [docs] update readmeKenny Tordeurs2020-10-091-2/+7
| | | | | | | Resolves: #2268 Signed-off-by: Kenny Tordeurs <ktordeur@redhat.com> Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [docs] Small fixes for RTD online generation changesJake Hunsaker2020-08-261-2/+2
| | | | | | | | | | A few changes on the RTD side in turn need us to slightly adjust some parts of our docs in-tree so that RTD can successfully build the docs online based on current master branch. Resolves: #2209 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [docs] Update READMEJake Hunsaker2020-08-171-15/+5
| | | | | | | Updates the README to reflect doc generation and setuptools install changes. Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [doc] Update path to the sosreport command.Jose Castillo2020-05-191-5/+5
| | | | | | | | | | | The documentation references ./sosreport , but the command now lives inside ./bin, so this commit updates such references. Resolves: #2060 Signed-off-by: Jose Castillo <jcastillo@redhat.com> Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [doc] update documentation URLs to use HTTPSMikel Olasagasti Uranga2019-10-141-3/+3
| | | | | | | Related: #1829 Signed-off-by: Mikel Olasagasti Uranga <mikel@olasagasti.info> Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] Update Debian and Ubuntu commandMikel Olasagasti Uranga2018-05-181-4/+4
| | | | | | | | | | | | | Since Debian Jessie (8) and Ubuntu 14.04 `apt` command is available, no need to use `apt-get`. Debian stable and old-stable have sosreport available, no need to mention Sid. Resolves: #1240 Signed-off-by: Mikel Olasagasti Uranga <mikel@olasagasti.info> Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] clarify test requirements in README.mdBryn M. Reeves2018-03-131-1/+3
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [build] Added dependencies in requirementsSachin2018-03-131-0/+14
| | | | | | | | | * Updated instructions in README to install Python dependencies * Added an example to create HTML docs * Added instruction to optionally run 'make test' before sending a PR * Relavant changes made in .travis.yml to test requirements Signed-off-by: Sachin Patil <sacpatil@redhat.com>
* [docs] document use of --config with in-tree buildsBryn M. Reeves2016-10-181-4/+24
|
* Mention python3 and update Ubuntu note.Bryan Quigley2016-10-171-1/+2
| | | | | | | | | | | | | Mention how to run sosreport on a system with only python3. Update the first release sosreport got into Ubuntu to a supported LTS which should be more recognizable to people. Fixes: #830 Signed-off-by: Bryan Quigley <bryan.quigley@canonical.com> Signed-off-by: Adam Stokes <battlemidget@users.noreply.github.com>
* [docs] add contributor guidelines link to patch docsBryn M. Reeves2015-09-291-0/+3
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] Remove make deb, run from gitBryan Quigley2015-03-021-1/+1
| | | | | | | | Make deb was removed You can also just run ./sosreport from git now. Signed-off-by: Bryan Quigley <bryan.quigley@canonical.com> Signed-off-by: Adam Stokes <adam.stokes@ubuntu.com>
* [docs] sync README.md and index.rstBryn M. Reeves2014-08-031-1/+1
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] Fix Read the Docs URL in README.mdBryn M. Reeves2014-08-021-1/+1
| | | | | | | http://readthedocs.org does not respond - the correct host is www.readthedocs.org. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] update README.md to point to sos.readthedocs.orgBryn M. Reeves2014-08-021-1/+11
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] fix a typo in the mailing list descriptionBryn M. Reeves2014-08-011-2/+2
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] Improve README.md formattingBryn M. Reeves2014-07-151-4/+6
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] update README.mdBryn M. Reeves2014-07-151-10/+37
| | | | | | | Update README.md for the new repository URL and add links to a couple of new wiki pages. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* Update references to github URLBryn M. Reeves2014-04-061-2/+2
| | | | | | Update URLs to reflect repository rename to 'sos'. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* Update travis-ci build status imageAdam Stokes2014-04-011-1/+1
| | | | Signed-off-by: Adam Stokes <adam.stokes@ubuntu.com>
* Update readme to point to contributor guidelinesAdam Stokes2013-10-181-3/+11
| | | | Signed-off-by: Adam Stokes <adam.stokes@ubuntu.com>
* Update README.mdAdam Stokes2013-09-081-1/+1
| | | Replace travis-ci status image with that of this upstream repo.
* Update README.mdAdam Stokes2013-07-291-3/+8
| | | Now that sosreport is in Debian unstable and Ubuntu 13.10 update the readme to reflect a more 'official' way to install this application
* Update readme to reflect the removal of jboss/application server build andAdam Stokes2013-04-261-2/+1
| | | | | | reflect the new build task name for debian builds. Signed-off-by: Adam Stokes <adam.stokes@ubuntu.com>
* Update README.mdAdam Stokes2013-04-181-1/+1
| | | Due to the results from the Debian packaging policy this package was renamed to sosreport from sos. Updating readme to reflect that
* Include coverage module during CI testsAdam Stokes2013-04-041-1/+1
| | | | Signed-off-by: Adam Stokes <adam.stokes@ubuntu.com>
* Fix unittests and more pep8 conformingAdam Stokes2013-04-041-0/+40
- In our unittest we defined 'is_installed' to be a bool when in fact we wanted to verify if a package is installed via the _method_ is is_installed. Since overriding that method with our variable definition we basically removed any functionality of 'is_installed' method in Plugin class. - Initializing a fake plugin to test was failing due to our global logger not being initialized. Put a simple check in the library to make sure the logger is defined no matter what the calling state does. - Make import selinux conditional - Add travis-ci support - Rename README to utilize travis-ci build status and other markdown supported features Signed-off-by: Adam Stokes <adam.stokes@ubuntu.com>