From 3a53d50e279b1e5ca29da0b06fb858c209367ecb Mon Sep 17 00:00:00 2001 From: Neil Lathwood Date: Sat, 10 Jan 2015 01:24:38 +0000 Subject: [PATCH] Updated some links and created initial index page --- doc/Extensions/Alerting.md | 2 +- doc/General/Contributing.md | 4 +-- doc/Home.md | 68 ------------------------------------- doc/Observium-Welcome.md | 4 +-- doc/index.md | 1 + 5 files changed, 6 insertions(+), 73 deletions(-) delete mode 100644 doc/Home.md create mode 100644 doc/index.md diff --git a/doc/Extensions/Alerting.md b/doc/Extensions/Alerting.md index 8eeb94020..2d3ea0d69 100644 --- a/doc/Extensions/Alerting.md +++ b/doc/Extensions/Alerting.md @@ -160,7 +160,7 @@ $config['alert']['transports']['nagios'] = "/path/to/my.fifo"; //Flapjack expect ## IRC The IRC transports only works together with the LibreNMS IRC-Bot. -Configuration of the LibreNMS IRC-Bot is described [here](https://github.com/librenms/librenms/blob/master/doc/IRC-Bot.md). +Configuration of the LibreNMS IRC-Bot is described [here](https://github.com/librenms/librenms/blob/master/doc/Extensions/IRC-Bot.md). ```php $config['alert']['transports']['irc'] = true; ``` diff --git a/doc/General/Contributing.md b/doc/General/Contributing.md index 307546742..b73c1cd04 100644 --- a/doc/General/Contributing.md +++ b/doc/General/Contributing.md @@ -22,7 +22,7 @@ id in the file (so that it can be matched to your commits), and stating in the commit log: ``` I agree to the conditions of the Contributor Agreement - contained in doc/CONTRIBUTING.md. + contained in doc/General/Contributing.md. ``` @@ -92,7 +92,7 @@ message. - To incorporate larger blocks of code from third parties (e.g. JavaScript libraries): - Include its name, source URL, copyright notice, and license in - doc/CREDITS.md + doc/General/Credits.md - preferred locations are html/js, html/lib, and lib - Add it in a separate commit into its own directory, using 'git subtree --squash' if it is available via git. diff --git a/doc/Home.md b/doc/Home.md deleted file mode 100644 index 2fa884a5e..000000000 --- a/doc/Home.md +++ /dev/null @@ -1,68 +0,0 @@ -LibreNMS is a fork of Observium. The reason for the fork is nothing to do -with Observium's [recent move to community vs. paid versions][1]. It is -simply that we have different priorities and values to the Observium -developers. We decided to fork (reluctantly) because we like using -Observium, but we want to collaborate on a community-based project with -like-minded IT professionals. See [README.md][2] and the references there -for more information about the kind of community we're trying to promote. - -LibreNMS was forked from [the last GPL-licensed version of Observium][3]. -This has a few implications: -- ~~It doesn't look as nice as the current version of Observium.~~ -- We've lost quite a bit of functionality that has been added to Observium - in the last year. -- You won't be able to take an existing Observium installation later than - r3250 and just change it to LibreNMS. This would probably break (although - if you were on a version between r3250 and the next database schema - change, it might be feasible). Upgrades from versions earlier than r3251 - might work. Please try it on an unimportant system and tell us your - experiences! - -How LibreNMS will be different from Observium: -- We will have an inclusive community, where it's OK to ask stupid - questions, and OK to ask for things that aren't on the roadmap. If you'd - like to see something added, add or comment on the relevant issue in our - [GitHub issue database][9]. -- Development decisions will be community-driven. We want to make software - that fulfills its users' needs. See the [ROADMAP][4] for more thoughts - on our current plans. -- Development will probably proceed at a slower pace, at least initially. -- There are no plans for a paid version, and we don't anticipate this ever - changing. -- There are no current plans for paid support, but this may be added later - if there is sufficient demand. -- We use git for version control and GitHub for hosting to make it as easy - and painless as possible to create forked or private versions. - -Reasons why you might want to use Observium instead of LibreNMS: -- You have a financial investment in Observium and aren't concerned about - community contributions. -- You need the extra functionality that has been added to Observium since - r3250. -- You don't like the [GNU General Public License, version 3][5] or the - [philosophy of Free Software][6] in general. - -Reasons why you might want to use LibreNMS instead of Observium: -- You want to work with others on the project, knowing that [your - investment of time and effort will not be wasted][7]. -- You want to add and experiment with features that are not a priority for - the Observium developers. See [CONTRIBUTING][8] for more details. - -[1]: http://postman.memetic.org/pipermail/observium/2013-October/003915.html -"Observium edition split announcement" -[2]: https://github.com/librenms/librenms/blob/master/README.md -"LibreNMS README" -[3]: http://fisheye.observium.org/rdiff/Observium?csid=3251&u&N -"Link to Observium license change" -[4]: https://github.com/librenms/librenms/blob/master/doc/ROADMAP.md -"LibreNMS ROADMAP" -[5]: https://github.com/librenms/librenms/blob/master/LICENSE.txt -"LibreNMS copy of GPL v3" -[6]: http://www.gnu.org/philosophy/free-sw.html -"Free Software Foundation - what is free software?" -[7]: http://libertysys.com.au/blog/observium-and-gpl -"Paul's blog on what the GPL offers users" -[8]: https://github.com/librenms/librenms/blob/master/doc/CONTRIBUTING.md -"Contribution guidelines" -[9]: https://github.com/librenms/librenms/issues -"LibreNMS issue database at GitHub" \ No newline at end of file diff --git a/doc/Observium-Welcome.md b/doc/Observium-Welcome.md index f8bd25e4a..60f108bd7 100644 --- a/doc/Observium-Welcome.md +++ b/doc/Observium-Welcome.md @@ -57,7 +57,7 @@ Reasons why you might want to use LibreNMS instead of Observium: "LibreNMS README" [3]: http://fisheye.observium.org/rdiff/Observium?csid=3251&u&N "Link to Observium license change" -[4]: https://github.com/librenms/librenms/blob/master/doc/ROADMAP.md +[4]: https://github.com/librenms/librenms/blob/master/doc/General/Roadmap.md "LibreNMS ROADMAP" [5]: https://github.com/librenms/librenms/blob/master/LICENSE.txt "LibreNMS copy of GPL v3" @@ -65,7 +65,7 @@ Reasons why you might want to use LibreNMS instead of Observium: "Free Software Foundation - what is free software?" [7]: http://libertysys.com.au/blog/observium-and-gpl "Paul's blog on what the GPL offers users" -[8]: https://github.com/librenms/librenms/blob/master/doc/CONTRIBUTING.md +[8]: https://github.com/librenms/librenms/blob/master/doc/General/Contributing.md "Contribution guidelines" [9]: https://github.com/librenms/librenms/issues "LibreNMS issue database at GitHub" diff --git a/doc/index.md b/doc/index.md new file mode 100644 index 000000000..1fd87742d --- /dev/null +++ b/doc/index.md @@ -0,0 +1 @@ +# Welcome to the documentation for [LibreNMS](https://github.com/librenms/librenms)