diff --git a/doc/Developing/Using-Git.md b/doc/Developing/Using-Git.md index 075d416844..7e5fa07ee1 100644 --- a/doc/Developing/Using-Git.md +++ b/doc/Developing/Using-Git.md @@ -89,6 +89,9 @@ git push origin issue-123 If after do this you get some merge conflicts then you need to resolve these before carrying on. +Please try to squash all commits into one, this isn't essential as we can do this when we merge but it would +be helpful to do this before you submit your pull request. + Now you will be ready to submit a pull request from within GitHub. To do this, go to your GitHub page for the LibreNMS repo. Now select the branch you have just been working on (issue-123) from the drop down to the left and then click 'Pull Request'. Fill in the details to describe the work you have done and click 'Create pull request'. @@ -105,4 +108,4 @@ Ok, that should get you started on the contributing path. If you have any other on Freenode ##librenms. [1]: http://gitready.com -[2]: http://git-scm.com/book \ No newline at end of file +[2]: http://git-scm.com/book diff --git a/doc/General/Contributing.md b/doc/General/Contributing.md index 4027cfeaea..1a8bb572a9 100644 --- a/doc/General/Contributing.md +++ b/doc/General/Contributing.md @@ -55,21 +55,26 @@ Copyright We recommend that if you add a new file containing original code to the code base that you include a copyright notice in it as per the Free Software Foundation's guidelines. You might find something like the following header -appropriate (although this is not legal advice ;-): +appropriate (although this is not legal advice ;-). Please also ensure you add +the package information to the header. ``` - - * - * This program is free software: you can redistribute it and/or modify it - * under the terms of the GNU General Public License as published by the - * Free Software Foundation, either version 3 of the License, or (at your - * option) any later version. Please see LICENSE.txt at the top level of - * the source code distribution for details. - */ - ?> + + * + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU General Public License as published by the + * Free Software Foundation, either version 3 of the License, or (at your + * option) any later version. Please see LICENSE.txt at the top level of + * the source code distribution for details. + */ + + * @package LibreNMS + * @subpackage webui + * @link http://librenms.org + * @copyright 2016 Internet Widgitz Pty Ltd + * @author Me + ``` The GPLv3 itself also contains recommendations about applying the GPL to your code. Please see LICENSE.txt at the top of this source code diff --git a/doc/Support/FAQ.md b/doc/Support/FAQ.md index 179997333e..d85fb2efbd 100644 --- a/doc/Support/FAQ.md +++ b/doc/Support/FAQ.md @@ -17,6 +17,7 @@ - [How do I change the IP / hostname of a device?](#faq16) - [My device doesn't finish polling within 300 seconds](#faq19) - [Things aren't working correctly?](#faq18) + - [What do the values mean in my graphs?](#faq21) ### Developing - [How do I add support for a new OS?](#faq8) @@ -141,6 +142,26 @@ Re-run `./validate.php` once you've resolved any issues raised. You have an odd issue - we'd suggest you join our irc channel to discuss. +#### What do the values mean in my graphs? + +The values you see are reported as metric values. Thanks to a post on [Reddit](https://www.reddit.com/r/networking/comments/4xzpfj/rrd_graph_interface_error_label_what_is_the_m/) +here are those values: + +``` +10^-18 a - atto +10^-15 f - femto +10^-12 p - pico +10^-9 n - nano +10^-6 u - micro +10^-3 m - milli +0 (no unit) +10^3 k - kilo +10^6 M - mega +10^9 G - giga +10^12 T - tera +10^15 P - peta +``` + #### How do I add support for a new OS? The easiest way to show you how to do that is to link to an existing pull request that has been merged in on [GitHub](https://github.com/librenms/librenms/pull/352/files)