Commit Graph

20 Commits

Author SHA1 Message Date
Tony Murray
843d0a4669 Fix settings titles in dark mode (#15174)
Fix settings icon not showing in some browsers
Fix fping configuration formatting issue
Add brief docs on formatting settings links
2023-07-31 14:21:22 -05:00
Stef
82bd437e47 Syslog sink over http for logstash (or any json source) (#14424)
* inital commit of a new syslog sink over http

* cosmetics

* cosmetics fix...

* cosmetic fix again

* cosmetics fix again

* its nice now...

* add non blocking option

* Syslog Sink integrated as API PUT method

* lint fix

* Update includes/html/api_functions.inc.php

Co-authored-by: Tony Murray <murraytony@gmail.com>

* Update includes/html/api_functions.inc.php

Co-authored-by: Tony Murray <murraytony@gmail.com>

* Update includes/html/api_functions.inc.php

Co-authored-by: Tony Murray <murraytony@gmail.com>

* change to POST, fix decoding issue and json exception

* logstash/json documentation added. syslog documentation a bit re-structured

* lint fix

---------

Co-authored-by: Tony Murray <murraytony@gmail.com>
2023-03-15 08:14:38 -05:00
Jellyfrog
8f474dd4d4 Rework documentation (#13709)
* Rework documentation

* Slightly adjust theme

* wip

* fixes

* Remove unneeded header

* Re-added Acknowledgement.md file

* Added Acknowledgement.md to mkdocs.yml

Co-authored-by: Neil Lathwood <gh+n@laf.io>
2022-02-08 23:02:28 +00:00
Claude Brown
6bf97c6ac9 API 'list_parents_of_host' - mostly doco, but one small code enhancement (#13567)
* Allow 'list_devices' to query by exact device-id

* Remove 'http://' prefix from --dev-addr in doco for 'mkdocs serve'

* Document 'list_parents_of_host' API call by reference to 'list_devices' call

* Remove possibility of SQL injection attacks

* Remove possibility of SQL injection attacks
2021-11-25 22:38:50 +01:00
Sean
bcedc0ed77 Improve Markdown syntax in Document (#12949)
* Use GitLab instead of Gitlab

Only change text part, the Alert.Transport.Gitlab class left as is.

* Fix href in document

* Move section in document

The agent list in this document is sorted by alphabetical order,
"SDFS info" is the only exception.

* Remove trailing spaces in document

* Align code in document

* Fix Markdown in document

- Escape underline
- Add syntax highlight
- Add two space in the end of line to make it a newline
- Add newline before list or code section

* Update LibreNMS/Alert/Transport/Gitlab.php

Co-authored-by: Jellyfrog <Jellyfrog@users.noreply.github.com>
2021-06-16 21:16:21 +02:00
Jellyfrog
20b4215204 Swich links to https (#12511)
* Switch librenms links to https

* Convert librenms links in comments

* Switch gnu.org url to https

* switch php urls to https
2021-02-09 00:29:04 +01:00
yrebrac
3251cc8ac0 Creating Documentation page (#12486)
* Updated the creating documentation page with more informationg on
building and viewing. Fixed some formatting and markup issues with
existing text.

* Minor corrections

* Revert "Minor corrections"

This reverts commit efbe4bde55.

* Minor corrections

* Update Creating-Documentation.md

* Update Creating-Documentation.md

* Update Creating-Documentation.md

Co-authored-by: Jellyfrog <Jellyfrog@users.noreply.github.com>
2021-02-01 20:50:52 +01:00
dlehman83
9f591c0aa2 Update Documentation (#12411)
* Update Documentation

Most work in Graylog and SNMP
Fixed many code tags, spelling and wording.
Added SNMP PowerShell example.

* Update SNMP-Configuration-Examples.md

Fix TOC brackets
2020-12-30 15:38:14 +01:00
Jellyfrog
c76e95d343 Markdown linting of docs (#10595)
* Remove trailing spaces

* Markdown linting of docs
2019-10-21 00:47:40 +00:00
VVelox
6575042f5f go through making lots of the docs more lint happy (#10342)
* clean up all but header incrementing in Creating-Transport.md

* make Device-Dependencies.md mdl happy

* make Entities.md as mdl happy as possible... one long table line left

* make mdl as happy as possible for index.md

* clean up Introduction.md as much as possible

* minor formatting cleanup... move each icon onto its own row

* make ack and notes the same style

* clean Macros.md up

* clean Rules.md up as much as possible

* tweak one line a bit to get it to format a bit nicer

* a bit more format tweaking, making sure it does not sure with >

* clean up as much as possible for Templates.md

* make Testing.md as mdl happy as possibly

* clean Transports.md up as much as possible

* clean as many issues as possible for Alerts.md

* clean up as much of ARP.md as possible

* clean up as much as possible for Bills.md

* make DeviceGroups.md as mdl happy as possible

* cleanup Devices.md

* make as mdl happy as possible Inventory.md and index.md

* mdl cleanup for Logs.md and PortGroups.md

* make Ports.md and Routing.md as happy as possible

* clean up Services.md, Switching.md, and Systems.md as much as possible

* more markup cleanup

* lots more md cleanup udner Devloping/

* reapply bits from #10343 that accidentally got removed when merging
2019-06-20 13:53:44 -05:00
Michael Stolovitzsky
afedb034d3 update docs on mkdocs (#9631)
* be more specific about duplicate IP addresses

* generate TAGS for emacs

* note on using mkdocs, and make docs rule

* ignore emacs temp files

* Update .gitignore

* Update functions.php

* Update Makefile

* Update Creating-Documentation.md
2019-01-24 00:13:32 -06:00
Neil Lathwood
1ee2e8e0e0 Updated to use new theme for docs site (#9320)
* Updated to use new theme for docs site

* Updated theme location

* Removed librenms.css

* Updated index page + re-added librenms.css

* Use built in theme modification

* flexbox grid, dump bootstrap

* tidy up things

* Added path and updated deploy script + mkdocs config

* Removed db schmea changes

* Updated to install python/pip 3

* Removed pip3 install

* Pip3 install

* Updated deploy-docs

* Updated deploy-docs
2018-10-27 23:04:34 +01:00
Kevin Krumm
1c3f0d8345 docs: added link to Documentation (#7716)
Added Markdown Cheatsheet, helpful when creating docs.
2017-11-13 08:47:35 -06:00
Bennett Blodinger
f37f3ddff6 docs: Swap mdx_del_ins with pymdownx.tilde
It's actively developed and in the same package as pymdownx.tasklist
2017-08-19 19:39:00 +01:00
Neil Lathwood
7ff35ca6ef docs: More doc updates (#4365)
* More doc updates

* Updated to add update

* added tune option
2016-09-09 12:06:26 -05:00
Neil Lathwood
dcff4d3ed1 Revert "Some more doc updates" (#4231) 2016-08-27 22:12:44 +01:00
Neil Lathwood
87745cad7a Removed option to mkdocs build from creating-documentation.md 2016-08-27 15:31:51 +01:00
Neil Lathwood
acde0db434 More doc updates 2016-08-27 13:41:26 +01:00
Neil Lathwood
383c50b4f4 Updated docs to have source to use for edit github (#4185)
* Added source link for edit on github

* Updated formatting issues

* Updated formatting issues

* Updated formatting issues
2016-08-24 08:12:20 +01:00
Neil Lathwood
0b57b1ef69 Docs update (#4182) 2016-08-23 13:32:24 -05:00