diff --git a/doc/General/Contributing.md b/doc/General/Contributing.md index e78fbffe85..b22775cf11 100644 --- a/doc/General/Contributing.md +++ b/doc/General/Contributing.md @@ -13,8 +13,7 @@ any other means), you assert that: - You have not viewed code written under the [Observium License][4] in the production of contributed code. This includes all Observium code after Subversion revision 3250 and any patches or other code covered by that - license from Observium web sites after Tue May 29 13:08:01 2012 +0000 (the - date of Observium r3250). + license after Tue May 29 13:08:01 2012 +0000 (the date of Observium r3250). To agree with these assertions, please submit a github pull request against [AUTHORS.md][5] including your name, email address, and github user id in @@ -80,7 +79,8 @@ General Guidelines able. Collaborating in real time makes the coordination of contributions easier. -- Ensure you read the Code Guidelines documention and understand the code style that should be adhered to [6]. +- Ensure you read the Code Guidelines documention and understand the code + style that should be adhered to [6]. Integrating other code @@ -89,7 +89,8 @@ Integrating other code Giving credit where credit is due is critical to the Free Software philosophy. If you use code from somewhere else, even if it's trivial, be sure to note this as a comment in the code (preferably) or the commit -message. +message. Accurate attribution is crucial to our success as a Free Software +project. - To incorporate larger blocks of code from third parties (e.g. JavaScript libraries): @@ -182,7 +183,8 @@ git pull git checkout issue-#### git pull ```` -- Push your changes to your remote git hub branch so you can submit a pull from your issue-#### branch: +- Push your changes to your remote git hub branch so you can submit a pull + from your issue-#### branch: ```` git push origin issue-#### ```` diff --git a/doc/General/Roadmap.md b/doc/General/Roadmap.md index c98772ac2d..6680a000a7 100644 --- a/doc/General/Roadmap.md +++ b/doc/General/Roadmap.md @@ -1,26 +1,20 @@ - Device support: - - Ruckus wireless controllers (Paul) + - Ruckus wireless controllers - Investigate generic device support based on MIBs. It should be possible to do basic graphs based just on the MIB. They would obviously not be as customised as the specifically supported devices but should still be useful to users. - Functionality/performance improvements: - - Investigate solutions for poller performance improvement. (Tyler) - - Investigate solutions for multiple communities per device. (tooms) + - Investigate solutions for poller performance improvement. + - Investigate solutions for multiple communities per device. - Eliminate interface churn for transient interfaces (e.g. ppp/tun) on net-snmp. -- ~~Integrate Nagios-based alerting. Allow user to choose their preferred - Nagios distribution/fork.~~ Alerting is now present. - - Consider adding some non-monitoring administrative functions: - enabling/disabling ports - changing access port VLANs - editing port labels - Integrate as many usability improvements as time permits: - - ~~Integrate nice menus like current Observium?~~ UI Design improved - - Front page: more automation; GUI configuration? - -- ~~Improve / Change alerting system~~ Alerting is now present. + - Front page: more automation; GUI configuration diff --git a/doc/General/Updating.md b/doc/General/Updating.md index 5ac6973155..f5017eea23 100644 --- a/doc/General/Updating.md +++ b/doc/General/Updating.md @@ -1,12 +1,15 @@ ## Updating your install ## -LibreNMS by default performs updates on a daily basis. This can be disabled by ensuring: +LibreNMS by default performs updates on a daily basis. This can be disabled +by ensuring: $config['update'] = 0; -Is no longer commented out. If you would like to perform a manual update then you can do this by running the following commands: +is no longer commented out. If you would like to perform a manual update +then you can do this by running the following commands: git pull --no-edit --quiet php includes/sql-schema/update.php -This will update both the core LibreNMS files but also update the database structure if updates are available. \ No newline at end of file +This will update both the core LibreNMS files but also update the database +structure if updates are available.