From fdde13af90cb3b766212e8b303f37146c90dc33b Mon Sep 17 00:00:00 2001 From: Paul Dee <647633+systemcrash@users.noreply.github.com> Date: Tue, 25 May 2021 21:44:57 +0200 Subject: [PATCH] Documenting spelling (#12919) setup / set up Update Style-Guidelines.md sp/gram Update SNMP-Trap-Handler.md Update RRDCached.md setup = noun set up = verb/idiom --- doc/Developing/Style-Guidelines.md | 12 ++++++------ doc/Extensions/Distributed-Poller.md | 6 +++--- doc/Extensions/RRDCached.md | 2 +- doc/Extensions/SNMP-Trap-Handler.md | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/doc/Developing/Style-Guidelines.md b/doc/Developing/Style-Guidelines.md index 7c285d7c0d..987b9c2c45 100644 --- a/doc/Developing/Style-Guidelines.md +++ b/doc/Developing/Style-Guidelines.md @@ -10,17 +10,17 @@ interest that a consistent well thought out Web UI is available. ### Responsiveness The Web UI is designed to be mobile friendly and for the most part is -and works well. It's worth spending sometime to read through the +and works well. It's worth spending some time to read through the [Bootstrap website](http://getbootstrap.com/css/#grid) to learn more about how to keep things responsive. ### Navigation bar -- Always pick the best location for new links to go, think about where +- Always pick the best location for new links to go; think about where users would expect the link to be located and name it so that it's obvious what it does. -- Ensure sub sections within the Navigation are separated correctly +- Ensure sub-sections within the Navigation are separated correctly using ``. - Only use [Font Awesome icons](http://fontawesome.io/icons/) within the Navigation. It speeds up page load times quite considerably. @@ -43,7 +43,7 @@ probably the most common. Unless the table being used will only ever display a handful of items - yeah that's what we all said, then you need to write your table using [JQuery Bootgrid](http://www.jquery-bootgrid.com/). This -shouldn't take that much more code to do this but provides so much +shouldn't take that much more code to do it, but provides so much flexibility along with stopping the need for retrieving all the data from SQL in the first place. @@ -54,9 +54,9 @@ idea of what it's like to convert an existing pure html table to Bootgrid. ### Datetime format When displaying datetimes, please ensure you use the format YYYY-MM-DD -mm:hh:ss where possible, you shouldn't change the order of this as it +hh:mm:ss where possible, you shouldn't change the order of this as it will be confusing to users. Cutting it short to just display -YYYY-MM-DD mm:hh is fine :). +YYYY-MM-DD hh:mm is fine :). To keep things consistent we have the following variables which should be used rather than to format dates yourself. This has the added diff --git a/doc/Extensions/Distributed-Poller.md b/doc/Extensions/Distributed-Poller.md index 39b11acab1..4dd0a7b016 100644 --- a/doc/Extensions/Distributed-Poller.md +++ b/doc/Extensions/Distributed-Poller.md @@ -99,12 +99,12 @@ out: ## Architecture -How you setup the distribution is entirely up to you, you can choose +How you set the distribution up is entirely up to you. You can choose to host the majority of the required services on a single virtual machine or server and then a poller to actually query the devices -being monitored all the way through to having a dedicated server for +being monitored, all the way through to having a dedicated server for each of the individual roles. Below are notes on what you need to -consider both from the software layer but also connectivity. +consider both from the software layer, but also connectivity. ### Web / API Layer diff --git a/doc/Extensions/RRDCached.md b/doc/Extensions/RRDCached.md index a21b97f97d..74a041f118 100644 --- a/doc/Extensions/RRDCached.md +++ b/doc/Extensions/RRDCached.md @@ -3,7 +3,7 @@ path: blob/master/doc/ # Setting up RRDCached -This document will explain how to setup RRDCached for LibreNMS. +This document will explain how to set up RRDCached for LibreNMS. Since version 1.5, rrdtool / rrdcached now supports creating rrd files over rrdcached. If you have rrdcached 1.5.5 or above, you can also diff --git a/doc/Extensions/SNMP-Trap-Handler.md b/doc/Extensions/SNMP-Trap-Handler.md index d825ca90c1..ef1f40fd34 100644 --- a/doc/Extensions/SNMP-Trap-Handler.md +++ b/doc/Extensions/SNMP-Trap-Handler.md @@ -58,7 +58,7 @@ devices (community, etc.) ### Option 2 > Tested on Ubuntu 18 -Just setup your service like: +Just set up your service like: ``` [Unit]