Skip to content

Commit

Permalink
Revert "Some more doc updates" (librenms#4231)
Browse files Browse the repository at this point in the history
  • Loading branch information
laf authored Aug 27, 2016
1 parent 4b434bf commit dcff4d3
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 163 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,3 @@ patches
rrd
/vendor
composer.phar
/librenms_theme
7 changes: 5 additions & 2 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
### LibreNMS core team:
LibreNMS is a fork of [Observium][1].

LibreNMS core team:
- Paul Gear <paul@librenms.org> (paulgear)
- Neil Lathwood <neil@librenms.org> (laf)
- Daniel Preussker <f0o@librenms.org> (f0o)
- Søren Friis Rosiak <sorenrosiak@gmail.com> (rosiak)
- Mike Rostermund <mike@kollegienet.dk> (SaaldjorMike)
- Tony Murray <tonym@librenms.org> (murrant)

### LibreNMS contributors:
LibreNMS contributors:
- Bohdan Sanders <git@bohdans.com> (bohdan-s)
- Toni Cunyat <elbuit@gmail.com> (elbuit)
- Tuomas Riihimäki <tuomari@iudex.fi> (tuomari)
Expand Down Expand Up @@ -121,6 +123,7 @@
- Bennett Blodinger <bennett.blodinger@gmail.com> (benwa)
- Michael Hansen <nerdalertdk@gmail.com> (nerdalertdk)

[1]: http://observium.org/ "Observium web site"
Observium was written by:
- Adam Armstrong
- Tom Laermans
Expand Down
108 changes: 0 additions & 108 deletions CHANGELOG.md

This file was deleted.

28 changes: 0 additions & 28 deletions doc/Developing/Creating-Documentation.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
source: Developing/Creating-Documentation.md
# Creating Documentation

### Writing documentation
One of the goals of the LibreNMS project is to enable users to get all of the help they need from our documentation.

When you are adding a new feature or extension, we need to have full documentation to go along with it. It's quite
Expand All @@ -17,30 +16,3 @@ simple to do this:

Please ensure you add the document to the relevant section within `pages` of `mkdocs.yml` so that it's in the correct menu and is built.
Forgetting this step will result in your document never seeing the light of day :)

### Building documentation
Our build process in GitHub automatically builds http://docs.librenms.org from everything in the `doc/` folder. You can simulate this
process to test what the docs will look like before you submit your PR.

We use [mkdocs](http://www.mkdocs.org/) to build the documentation so you need to install that first (we assume you have `pip` installed):

```bash
pip install --user mkdocs
pip install --user pymdown-extensions
```

Now you will need to install the LibreNMS theme:

```bash
git clone https://github.com/librenms-docs/librenms_theme.git
```

Now you are ready to build your docs and check them, you can do this with mkdocs:

```bash
mkdocs serve
```

This will launch a web service on localhost port 8000. You can change the port or bind the web server to a different IP by adding
` -a 0.0.0.0:8080`

15 changes: 1 addition & 14 deletions doc/Support/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ source: Support/FAQ.md
- [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)
- [How can I move my LibreNMS install to another server?](#faq22)

### Developing
- [How do I add support for a new OS?](#faq8)
Expand Down Expand Up @@ -144,7 +143,7 @@ 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.

#### <a name="faq21"> What do the values mean in my graphs?</a>
#### <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:
Expand All @@ -164,18 +163,6 @@ here are those values:
10^15 P - peta
```

#### <a name="faq22"> How can I move my LibreNMS install to another server?</a>

If you are moving from one CPU architecture to another then you will need to dump the rrd files and re-create them. If you are in
this scenario then you can use [Dan Brown's migration scripts](https://vlan50.com/2015/04/17/migrating-from-observium-to-librenms/).

If you are just moving to another server with the same CPU architecture then the following steps should be all that's needed:

- Install LibreNMS as per our normal documentation, you don't need to run through the web installer or building the sql schema.
- Dump the MySQL database `librenms` and import this into your new server.
- Copy the `rrd/` folder to the new server.
- Copy the `config.php` file to the new server.

#### <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)
Expand Down
10 changes: 0 additions & 10 deletions package.json

This file was deleted.

0 comments on commit dcff4d3

Please sign in to comment.