mirror/librenms-librenms
1
0
Fork 0
mirror of https://github.com/librenms/librenms.git synced 2024-10-07 16:52:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #4146 from laf/docs-n-docs

Browse Source 
Updated some docs
This commit is contained in:
Tony Murray
2016-08-20 21:11:30 -05:00
committed by GitHub
parent 4361da605f d2b00a87d9
commit 936191cae9
3 changed files with 44 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
doc/Developing/Using-Git.md
View File

@@ -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. 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 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 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'. '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. on Freenode ##librenms.
[1]: http://gitready.com [1]: http://gitready.com
[2]: http://git-scm.com/book [2]: http://git-scm.com/book

33
doc/General/Contributing.md
View File

@@ -55,21 +55,26 @@ Copyright
We recommend that if you add a new file containing original code to the code 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 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 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.
``` ```
<?php <?php
/* /*
* LibreNMS module to frob blurgs from a foo bar * Copyright (c) 2015 Internet Widgitz Pty Ltd <http://example.com/>
* *
* Copyright (c) 2015 Internet Widgitz Pty Ltd <http://example.com/> * 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
* This program is free software: you can redistribute it and/or modify it * Free Software Foundation, either version 3 of the License, or (at your
* under the terms of the GNU General Public License as published by the * option) any later version. Please see LICENSE.txt at the top level of
* Free Software Foundation, either version 3 of the License, or (at your * the source code distribution for details.
* 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 <info@widgitz.com>
* @author Me <me@infowidgitz.com>
``` ```
The GPLv3 itself also contains recommendations about applying the GPL to The GPLv3 itself also contains recommendations about applying the GPL to
your code. Please see LICENSE.txt at the top of this source code your code. Please see LICENSE.txt at the top of this source code

21
doc/Support/FAQ.md
View File

@@ -17,6 +17,7 @@
- [How do I change the IP / hostname of a device?](#faq16) - [How do I change the IP / hostname of a device?](#faq16)
- [My device doesn't finish polling within 300 seconds](#faq19) - [My device doesn't finish polling within 300 seconds](#faq19)
- [Things aren't working correctly?](#faq18) - [Things aren't working correctly?](#faq18)
- [What do the values mean in my graphs?](#faq21)
### Developing ### Developing
- [How do I add support for a new OS?](#faq8) - [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. You have an odd issue - we'd suggest you join our irc channel to discuss.
#### <a name="faq22"> What do the values mean in my graphs?</a>
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
```
#### <a name="faq8"> How do I add support for a new OS?</a> #### <a name="faq8"> How do I add support for a new OS?</a>
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) 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)