clones/librenms
1
0
Fork 0
mirror of https://github.com/librenms/librenms.git synced 2024-09-21 18:38:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
daffa7e274
librenms/mkdocs.yml

168 lines
5.9 KiB
YAML
Raw Normal View History

Custom ordering for docs I only really ordered the top level nav and installation, others could be customized if desired. Shorten the header to LibreNMS Docs, so the menu stays nice on smaller screens, maybe even should shorten it to LibreNMS Add some links on the index.md page
2016-08-21 03:49:23 +00:00
site_name: LibreNMS Docs
Ready for new docs site
2016-08-19 13:37:44 +00:00
docs_dir: doc
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 22:04:34 +00:00
theme:
name: material
logo: img/librenms.svg
language: en
palette: null
font:
text: 'Roboto'
code: 'Roboto Mono'
feature: null
Ready for new docs site
2016-08-19 13:37:44 +00:00
site_dir: out
site_url: http://docs.librenms.org
markdown_extensions:
docs: More doc updates (#4365) * More doc updates * Updated to add update * added tune option
2016-09-09 17:06:26 +00:00
- pymdownx.tasklist
docs: Swap mdx_del_ins with pymdownx.tilde It's actively developed and in the same package as pymdownx.tasklist
2017-08-19 18:39:00 +00:00
- pymdownx.tilde
Ready for new docs site
2016-08-19 13:37:44 +00:00
extra_css:
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 22:04:34 +00:00
- https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css
Ready for new docs site
2016-08-19 13:37:44 +00:00
- librenms.css
docs: Continue to reorganize docs (#7762) * docs: Continue to reorganize things Make landing pages for /Installation, /API, etc. Split API out into multiple docs Properly use multi-level navigation Add lower nav buttons (tops are bug so disable for now) Add logo for fanciness Refine index page a bit * Improve API TOC layout * Couple of fixes. * Fix API/API-Docs, assumed it was at the right url.
2017-11-19 01:19:18 +00:00
extra:
article_nav_top: false
article_nav_bottom: true
Ready for new docs site
2016-08-19 13:37:44 +00:00
site_author: LibreNMS
site_description: LibreNMS user and developer documentation
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 22:04:34 +00:00
repo_url: https://github.com/librenms/librenms/
edit_uri: edit/master/doc
Ready for new docs site
2016-08-19 13:37:44 +00:00
repo_name: GitHub
Updated themes doc + added Google analytics (#4158)
2016-08-21 20:10:01 +00:00
google_analytics: ['UA-79149977-2', 'docs.librenms.org']
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 22:04:34 +00:00
nav:
docs: Updated alerting docs / formatting (#7185) * Ignore docs/ * Fix indenentation YAML's pretty strict * Remove static anchor names Markdown does this automatically for us * Tabelize entities * Remove tildes They don't do anything
2017-08-19 18:40:50 +00:00
- Home: index.md
Docs refactor (#7389) * docs: Refactored docs for new layout * some more changes * more doc updates * More doc updates * small update * small update
2017-10-02 20:36:22 +00:00
- 1. General:
- Acknowledgements: General/Acknowledgement.md
docs: Updated alerting docs / formatting (#7185) * Ignore docs/ * Fix indenentation YAML's pretty strict * Remove static anchor names Markdown does this automatically for us * Tabelize entities * Remove tildes They don't do anything
2017-08-19 18:40:50 +00:00
- General/Changelog.md
- Code of Conduct: General/CODE_OF_CONDUCT.md
Docs refactor (#7389) * docs: Refactored docs for new layout * some more changes * more doc updates * More doc updates * small update * small update
2017-10-02 20:36:22 +00:00
- Support/Features.md
docs: Updated alerting docs / formatting (#7185) * Ignore docs/ * Fix indenentation YAML's pretty strict * Remove static anchor names Markdown does this automatically for us * Tabelize entities * Remove tildes They don't do anything
2017-08-19 18:40:50 +00:00
- General/Welcome-to-Observium-users.md
Docs refactor (#7389) * docs: Refactored docs for new layout * some more changes * more doc updates * More doc updates * small update * small update
2017-10-02 20:36:22 +00:00
- 2. Installing:
docs: Continue to reorganize docs (#7762) * docs: Continue to reorganize things Make landing pages for /Installation, /API, etc. Split API out into multiple docs Properly use multi-level navigation Add lower nav buttons (tops are bug so disable for now) Add logo for fanciness Refine index page a bit * Improve API TOC layout * Couple of fixes. * Fix API/API-Docs, assumed it was at the right url.
2017-11-19 01:19:18 +00:00
- Installing LibreNMS: Installation/index.md
Update docs for virtual images (#9456)
2018-11-17 14:19:38 +00:00
- LibreNMS VMs: Installation/Images.md
Create Installation-Ubuntu-1804-Nginx.md (#8630) * Create Installation-Ubuntu-1804-Nginx.md A few tweaks are required to the Ubuntu 16.04 instructions to install on the newly released 18.04 version mostly relating to php being bumped to 7.2 from 7.0 and no mcrypt module for this php version in the distro repository. * Create Installation-Ubuntu-1804-Apache.md Used instructions from 1604 Apache as template and updated to work on Bionic (18.04). * Update Installation-Ubuntu-1804-Nginx.md Removed instructions for installing mcrypt module as I confirmed it works without it and it was mentioned it was no longer needed. * Update Installation-Ubuntu-1804-Apache.md The 1604 directions had a mixture of vi and vim for editing files. Since this is ubuntu and we want the instructions to be as easy as possible, I updated editor to be nano. I have no personal preference and can make it whatever we prefer, just figured it should be consistent between the two guides. * Update mkdocs.yml Added Ubuntu 18.04 instruction pages * Update Installation-Ubuntu-1804-Apache.md Corrected to libapache2-mod-php7.2 from libapache2-mod-php7.0 * Updated Ubuntu install docs * Added missing mbstring + curl packages
2018-08-28 15:30:37 +00:00
- Ubuntu 18.04 (Nginx): Installation/Installation-Ubuntu-1804-Nginx.md
- Ubuntu 18.04 (Apache): Installation/Installation-Ubuntu-1804-Apache.md
docs: Updated alerting docs / formatting (#7185) * Ignore docs/ * Fix indenentation YAML's pretty strict * Remove static anchor names Markdown does this automatically for us * Tabelize entities * Remove tildes They don't do anything
2017-08-19 18:40:50 +00:00
- CentOS 7 (Nginx): Installation/Installation-CentOS-7-Nginx.md
- CentOS 7 (Apache): Installation/Installation-CentOS-7-Apache.md
- Migrating from Observium: Installation/Migrating-from-Observium.md
Docs refactor (#7389) * docs: Refactored docs for new layout * some more changes * more doc updates * More doc updates * small update * small update
2017-10-02 20:36:22 +00:00
- 3. Getting started:
- Choosing a release: General/Releases.md
- Adding a device: Support/Adding-a-Device.md
- Grouping Devices: Extensions/Device-Groups.md
- Submitting stats: General/Callback-Stats-and-Privacy.md
- Updating an install: General/Updating.md
- 4. Basic Setup:
docs: Updated alerting docs / formatting (#7185) * Ignore docs/ * Fix indenentation YAML's pretty strict * Remove static anchor names Markdown does this automatically for us * Tabelize entities * Remove tildes They don't do anything
2017-08-19 18:40:50 +00:00
- Extensions/Applications.md
Docs refactor (#7389) * docs: Refactored docs for new layout * some more changes * more doc updates * More doc updates * small update * small update
2017-10-02 20:36:22 +00:00
- Check_MK Setup: Extensions/Agent-Setup.md
docs: Updated alerting docs / formatting (#7185) * Ignore docs/ * Fix indenentation YAML's pretty strict * Remove static anchor names Markdown does this automatically for us * Tabelize entities * Remove tildes They don't do anything
2017-08-19 18:40:50 +00:00
- Extensions/Billing-Module.md
- Extensions/Dell-OpenManage.md
docs: Update World Map doc (#7858) * docs: Update World Map Doc Updated Doc and removed old Globe Map info. * image for world map settings * Update mkdocs.yml
2017-12-07 14:08:31 +00:00
- Extensions/World-Map.md
docs: Updated alerting docs / formatting (#7185) * Ignore docs/ * Fix indenentation YAML's pretty strict * Remove static anchor names Markdown does this automatically for us * Tabelize entities * Remove tildes They don't do anything
2017-08-19 18:40:50 +00:00
- Extensions/Interface-Description-Parsing.md
- Extensions/Network-Map.md
Docs refactor (#7389) * docs: Refactored docs for new layout * some more changes * more doc updates * More doc updates * small update * small update
2017-10-02 20:36:22 +00:00
- Extensions/Syslog.md
docs: Create new docs on using dashboards (#7688) * docs: create new dashboards doc * docs: added new dashboard doc * docs: images for dashboard doc * Update Dashboards.md * docs: dashboard minor changes spelling changes.
2017-11-09 12:00:49 +00:00
- Extensions/Dashboards.md
Docs refactor (#7389) * docs: Refactored docs for new layout * some more changes * more doc updates * More doc updates * small update * small update
2017-10-02 20:36:22 +00:00
- 5. Advanced Setup:
- Support/1-Minute-Polling.md
Allow ping checks to be ran separately from polling (#8821) Allows ping checks at intervals not tied to the poller. Pointless if you are not alerting on device status. I updated the rrdstep.php script to treat ping-perf files separately and made it so it only converts if needed. Docs here: https://docs.librenms.org/Extensions/Fast-Ping-Check/ DO NOT DELETE THIS TEXT #### Please note > Please read this information carefully. You can run `./scripts/pre-commit.php` to check your code before submitting. - [x] Have you followed our [code guidelines?](http://docs.librenms.org/Developing/Code-Guidelines/) #### Testers If you would like to test this pull request then please run: `./scripts/github-apply <pr_id>`, i.e `./scripts/github-apply 5926`
2018-07-30 21:58:38 +00:00
- Fast Ping Checking: Extensions/Fast-Ping-Check.md
Allow trusted proxy via APP_TRUSTED_PROXIES (#9196) * Allow trusted proxy via APP_TRUSTED_PROXIES Set to '*' by default to emulate legacy behavior. Set up doc describing environment variables * Create helper to parse environment variables into arrays properly. * Update doc blocks
2018-09-13 12:26:42 +00:00
- Support/Environment-Variables.md
Docs refactor (#7389) * docs: Refactored docs for new layout * some more changes * more doc updates * More doc updates * small update * small update
2017-10-02 20:36:22 +00:00
- Configuration docs: Support/Configuration.md
- Authentication Options: Extensions/Authentication.md
- Two-Factor Auth: Extensions/Two-Factor-Auth.md
- Auto-discovery Setup: Extensions/Auto-Discovery.md
- Scaling LibreNMS: Extensions/Distributed-Poller.md
docs: Updated alerting docs / formatting (#7185) * Ignore docs/ * Fix indenentation YAML's pretty strict * Remove static anchor names Markdown does this automatically for us * Tabelize entities * Remove tildes They don't do anything
2017-08-19 18:40:50 +00:00
- Extensions/RRDCached.md
Docs refactor (#7389) * docs: Refactored docs for new layout * some more changes * more doc updates * More doc updates * small update * small update
2017-10-02 20:36:22 +00:00
- Sub-directory Support: Extensions/Sub-Directory.md
- Extensions/Varnish.md
- Poller Service (BETA): Extensions/Poller-Service.md
docs: Updated alerting docs / formatting (#7185) * Ignore docs/ * Fix indenentation YAML's pretty strict * Remove static anchor names Markdown does this automatically for us * Tabelize entities * Remove tildes They don't do anything
2017-08-19 18:40:50 +00:00
- Extensions/RRDTune.md
Docs refactor (#7389) * docs: Refactored docs for new layout * some more changes * more doc updates * More doc updates * small update * small update
2017-10-02 20:36:22 +00:00
- Extensions/IRC-Bot.md
- Extensions/IRC-Bot-Extensions.md
docs: Updated alerting docs / formatting (#7185) * Ignore docs/ * Fix indenentation YAML's pretty strict * Remove static anchor names Markdown does this automatically for us * Tabelize entities * Remove tildes They don't do anything
2017-08-19 18:40:50 +00:00
- Extensions/SNMP-Proxy.md
- Extensions/SNMP-Trap-Handler.md
docs: build new Cleanup Options doc (#7798) * docs: build new Cleanup Options doc * docs: create new cleanup options doc * Update Cleanup-options.md
2017-11-26 17:37:02 +00:00
- Support/Cleanup-options.md
Docs refactor (#7389) * docs: Refactored docs for new layout * some more changes * more doc updates * More doc updates * small update * small update
2017-10-02 20:36:22 +00:00
- 6. 3rd Party Integration:
docs: Created Gateone 3rd party integration doc (#8229) * Create Gateone.md Doc for Gateone integration. Credit to davama who wrote most of this. https://github.com/davama/librenms/commit/f6a7e5973f7aca86c65e651eb45bf513c66d27f1 * Update Gateone.md * Update mkdocs.yml added gateone.md
2018-02-10 20:52:26 +00:00
- Extensions/Gateone.md
Docs refactor (#7389) * docs: Refactored docs for new layout * some more changes * more doc updates * More doc updates * small update * small update
2017-10-02 20:36:22 +00:00
- Extensions/Graylog.md
- Nagios Plugins: Extensions/Services.md
- Extensions/NFSen.md
- Extensions/Oxidized.md
testing: Added test unit for Docs (#8745) * testing: Added test unit for Docs * Update mkdocs.yml * Avoid extra function * contains -> diff
2018-05-26 04:10:25 +00:00
- Extensions/Rancid.md
Docs refactor (#7389) * docs: Refactored docs for new layout * some more changes * more doc updates * More doc updates * small update * small update
2017-10-02 20:36:22 +00:00
- Extensions/PeeringDB.md
- Extensions/Proxmox.md
docs: Continue to reorganize docs (#7762) * docs: Continue to reorganize things Make landing pages for /Installation, /API, etc. Split API out into multiple docs Properly use multi-level navigation Add lower nav buttons (tops are bug so disable for now) Add logo for fanciness Refine index page a bit * Improve API TOC layout * Couple of fixes. * Fix API/API-Docs, assumed it was at the right url.
2017-11-19 01:19:18 +00:00
- Storing Metrics:
- Intro: Extensions/Metric-Storage.md
- Extensions/metrics/Graphite.md
feature: Added Prometheus PushGateway metric support (#8437) * Added Prometheus PushGateway support * fixed formatting * fix set_curl_proxy to correct variable * add documentation * Update Metric-Storage.md * Update mkdocs.yml
2018-04-13 14:46:19 +00:00
- Extensions/metrics/InfluxDB.md
docs: Continue to reorganize docs (#7762) * docs: Continue to reorganize things Make landing pages for /Installation, /API, etc. Split API out into multiple docs Properly use multi-level navigation Add lower nav buttons (tops are bug so disable for now) Add logo for fanciness Refine index page a bit * Improve API TOC layout * Couple of fixes. * Fix API/API-Docs, assumed it was at the right url.
2017-11-19 01:19:18 +00:00
- Extensions/metrics/OpenTSDB.md
feature: Added Prometheus PushGateway metric support (#8437) * Added Prometheus PushGateway support * fixed formatting * fix set_curl_proxy to correct variable * add documentation * Update Metric-Storage.md * Update mkdocs.yml
2018-04-13 14:46:19 +00:00
- Extensions/metrics/Prometheus.md
docs: Updated alerting docs / formatting (#7185) * Ignore docs/ * Fix indenentation YAML's pretty strict * Remove static anchor names Markdown does this automatically for us * Tabelize entities * Remove tildes They don't do anything
2017-08-19 18:40:50 +00:00
- Extensions/Smokeping.md
docs: Added doc for weathermap integration (#7536) * docs: new doc for weathermap * Update Weathermap * Update Weathermap * Update mkdocs.yml added in Weathermap.md * Update Weathermap minor grammar fix * Rename Weathermap to Weathermap.md * Update Weathermap.md
2017-10-25 13:10:59 +00:00
- Extensions/Weathermap.md
Docs refactor (#7389) * docs: Refactored docs for new layout * some more changes * more doc updates * More doc updates * small update * small update
2017-10-02 20:36:22 +00:00
- 7. API:
docs: Continue to reorganize docs (#7762) * docs: Continue to reorganize things Make landing pages for /Installation, /API, etc. Split API out into multiple docs Properly use multi-level navigation Add lower nav buttons (tops are bug so disable for now) Add logo for fanciness Refine index page a bit * Improve API TOC layout * Couple of fixes. * Fix API/API-Docs, assumed it was at the right url.
2017-11-19 01:19:18 +00:00
- Using the API: API/index.md
- API/Devices.md
- API/DeviceGroups.md
- API/Ports.md
- API/PortGroups.md
- API/Alerts.md
- API/Routing.md
- API/Switching.md
- API/Inventory.md
- API/Bills.md
- API/ARP.md
- API/Services.md
testing: Added test unit for Docs (#8745) * testing: Added test unit for Docs * Update mkdocs.yml * Avoid extra function * contains -> diff
2018-05-26 04:10:25 +00:00
- API/System.md
docs: Continue to reorganize docs (#7762) * docs: Continue to reorganize things Make landing pages for /Installation, /API, etc. Split API out into multiple docs Properly use multi-level navigation Add lower nav buttons (tops are bug so disable for now) Add logo for fanciness Refine index page a bit * Improve API TOC layout * Couple of fixes. * Fix API/API-Docs, assumed it was at the right url.
2017-11-19 01:19:18 +00:00
- API/Logs.md
Docs refactor (#7389) * docs: Refactored docs for new layout * some more changes * more doc updates * More doc updates * small update * small update
2017-10-02 20:36:22 +00:00
- 8. Alerting:
docs: Continue to reorganize docs (#7762) * docs: Continue to reorganize things Make landing pages for /Installation, /API, etc. Split API out into multiple docs Properly use multi-level navigation Add lower nav buttons (tops are bug so disable for now) Add logo for fanciness Refine index page a bit * Improve API TOC layout * Couple of fixes. * Fix API/API-Docs, assumed it was at the right url.
2017-11-19 01:19:18 +00:00
- Intro: Alerting/index.md
Added support for allowing alerts to un-ack (#9136) * Add support for allowing alerts to un-ack * Updated db_schema.yaml * Update and rename 263.sql to 265.sql * Fix up ui a bit. * Renamed sql file
2018-09-19 22:38:01 +00:00
- Alerting/Introduction.md
Docs refactor (#7389) * docs: Refactored docs for new layout * some more changes * more doc updates * More doc updates * small update * small update
2017-10-02 20:36:22 +00:00
- Alerting/Rules.md
- Alerting/Templates.md
- Alerting/Transports.md
Added Alert Transports Mapping (#8660) Hello all, I guess this is the second version of a more fully fleshed out alert contact mapping feature. The old one was GH-8507 Transports to convert: - [x] API - [x] Cisco Spark - [x] Elasticsearch - [x] GitLab - [x] Philips Hue - [x] Jira - [x] Mail - [ ] ~~PagerDuty~~ - Requires a callback so leaving for now - [x] Nagios - [x] IRC - [x] Discord - [x] Rocket.chat - [x] Hipchat - [x] Pushover - [x] Boxcar - [x] Telegram - [x] Pushbullet - [x] VictorOps - [x] OpsGenie - [x] Clickatell - [x] PlaySMS - [x] Canopsis - [x] osTicket - [x] Microsoft Teams - [x] SMSEagle - [x] Syslog - [x] Slack The intention is for this feature to have three different levels to it: 1. Alert rule to an alert contact mapping (where the code is at now) 2. Alert rule to an alert group (made up of alert contacts) mapping 3. Alert contact mapping to different transport configurations. There will be three transport configuration types. 1. Default (the configuration that is held in the configs table) 2. None (no transport configuration - will explain later) 3. Other (a configuration that will be defined in a different able) Take Mail transport for example. It can either be of a "default" or "other" configuration. The hope is that in the future, users can send mail from different mail servers if they wish. However, for ciscospark which requires a room ID and an api-token, I've decided that it has no transport configuration. Most likely, every alert contact will contain a different room-id and an api-token - which is why it has the transport config of "none". For other transports : I am not familiar with them, so hopefully the community can add support for these. I can definitely help! To add support for each transport will require several things: - addition to the UI - addition to forms/alert-contacts.inc.php - modifications to its object class Screenshots ![image](https://user-images.githubusercontent.com/28970851/39594533-2092ce9e-4eca-11e8-9c5d-cd002ece1425.png) ![image](https://user-images.githubusercontent.com/28970851/39594544-276e9856-4eca-11e8-80cc-82789ee0b2b2.png) ![image](https://user-images.githubusercontent.com/28970851/39594553-2fdf528c-4eca-11e8-8a40-4f149e767054.png) I'm not sure if this is the best way to do things, so please let me know if there's a better way to structure the code! Any comments on code/db schema,/UI etc is welcome and encouraged! The UI is heavily based on alert rules (front end is not my strong suit). And parts of the code are based on the code that was written for alert rules. DO NOT DELETE THIS TEXT #### Please note > Please read this information carefully. You can run `./scripts/pre-commit.php` to check your code before submitting. - [x] Have you followed our [code guidelines?](http://docs.librenms.org/Developing/Code-Guidelines/) #### Testers If you would like to test this pull request then please run: `./scripts/github-apply <pr_id>`, i.e `./scripts/github-apply 5926`
2018-07-21 19:34:59 +00:00
- Alerting/Creating-Transport.md
Docs refactor (#7389) * docs: Refactored docs for new layout * some more changes * more doc updates * More doc updates * small update * small update
2017-10-02 20:36:22 +00:00
- Alerting/Entities.md
- Alerting/Macros.md
- Alerting/Testing.md
fix documentation issues (#7928)
2017-12-20 17:03:54 +00:00
- Alerting/Device-Dependencies.md
Docs refactor (#7389) * docs: Refactored docs for new layout * some more changes * more doc updates * More doc updates * small update * small update
2017-10-02 20:36:22 +00:00
- 9. Getting help:
docs: Continue to reorganize docs (#7762) * docs: Continue to reorganize things Make landing pages for /Installation, /API, etc. Split API out into multiple docs Properly use multi-level navigation Add lower nav buttons (tops are bug so disable for now) Add logo for fanciness Refine index page a bit * Improve API TOC layout * Couple of fixes. * Fix API/API-Docs, assumed it was at the right url.
2017-11-19 01:19:18 +00:00
- How to get help: Support/index.md
docs: Updated alerting docs / formatting (#7185) * Ignore docs/ * Fix indenentation YAML's pretty strict * Remove static anchor names Markdown does this automatically for us * Tabelize entities * Remove tildes They don't do anything
2017-08-19 18:40:50 +00:00
- Support/FAQ.md
- Support/Install Validation.md
- Support/Performance.md
Docs refactor (#7389) * docs: Refactored docs for new layout * some more changes * more doc updates * More doc updates * small update * small update
2017-10-02 20:36:22 +00:00
- Support/Discovery Support.md
docs: Updated alerting docs / formatting (#7185) * Ignore docs/ * Fix indenentation YAML's pretty strict * Remove static anchor names Markdown does this automatically for us * Tabelize entities * Remove tildes They don't do anything
2017-08-19 18:40:50 +00:00
- Support/Poller Support.md
Docs refactor (#7389) * docs: Refactored docs for new layout * some more changes * more doc updates * More doc updates * small update * small update
2017-10-02 20:36:22 +00:00
- Support/Example-Hardware-Setup.md
docs: Updated alerting docs / formatting (#7185) * Ignore docs/ * Fix indenentation YAML's pretty strict * Remove static anchor names Markdown does this automatically for us * Tabelize entities * Remove tildes They don't do anything
2017-08-19 18:40:50 +00:00
- Support/Remote-Monitoring-VPN.md
- Support/SNMP-Configuration-Examples.md
- Support/SSL-Configuration.md
docs: Added device-troubleshooting page (#7638) * docs: create device-troubleshooting page using the capture debug info page. * Update device-troubleshooting.md * capture debug info images * Update and rename device-troubleshooting.md to Device-Troubleshooting.md * added Device-Troubleshooting.md * Update Device-Troubleshooting.md
2017-11-06 21:52:32 +00:00
- Support/Device-Troubleshooting.md
doc: create device sensor help doc. (#7868) * doc: create device sensor help doc. this should help users that get confused when receiving alerts for sensors. * Update mkdocs.yml * Update Device-Sensors.md * Update Device-Sensors.md * Update Device-Sensors.md changes requested
2017-12-07 21:48:45 +00:00
- Support/Device-Sensors.md
Docs refactor (#7389) * docs: Refactored docs for new layout * some more changes * more doc updates * More doc updates * small update * small update
2017-10-02 20:36:22 +00:00
- 10. Contributing + Developing:
docs: Continue to reorganize docs (#7762) * docs: Continue to reorganize things Make landing pages for /Installation, /API, etc. Split API out into multiple docs Properly use multi-level navigation Add lower nav buttons (tops are bug so disable for now) Add logo for fanciness Refine index page a bit * Improve API TOC layout * Couple of fixes. * Fix API/API-Docs, assumed it was at the right url.
2017-11-19 01:19:18 +00:00
- Contributing: Developing/index.md
docs: Updated alerting docs / formatting (#7185) * Ignore docs/ * Fix indenentation YAML's pretty strict * Remove static anchor names Markdown does this automatically for us * Tabelize entities * Remove tildes They don't do anything
2017-08-19 18:40:50 +00:00
- Developing/Using-Git.md
- Developing/Code-Guidelines.md
- Developing/Style-Guidelines.md
- Developing/Validating-Code.md
- Developing/Code-Structure.md
- Developing/Creating-Documentation.md
docs: Improve developer intro, add learning resources (#7811)
2017-11-29 08:08:18 +00:00
- Developing/Licensing.md
Docs refactor (#7389) * docs: Refactored docs for new layout * some more changes * more doc updates * More doc updates * small update * small update
2017-10-02 20:36:22 +00:00
- Extensions/Component.md
- Mib Based Polling (ALPHA): Extensions/MIB-based-polling.md
docs: Continue to reorganize docs (#7762) * docs: Continue to reorganize things Make landing pages for /Installation, /API, etc. Split API out into multiple docs Properly use multi-level navigation Add lower nav buttons (tops are bug so disable for now) Add logo for fanciness Refine index page a bit * Improve API TOC layout * Couple of fixes. * Fix API/API-Docs, assumed it was at the right url.
2017-11-19 01:19:18 +00:00
- Support for a new OS:
- Intro: Developing/Support-New-OS.md
- Developing/os/Initial-Detection.md
- Developing/os/Mem-CPU-Information.md
- Developing/os/Test-Units.md
- Developing/os/Health-Information.md
- Developing/os/Wireless-Sensors.md
- Developing/os/Custom-Graphs.md
- Developing/os/Settings.md
- Developing/Sensor-State-Support.md
Updates to snmptrap handling (#9010) * Updates to snmptrap handling fix a bug in findDeviceByIP. Add more tests for that. Move handle outside of the Trap class, it doesn't fit. Add developer docs. * fix tests copy paste issue. * Fix findByIp when port may not exist. * Logging: Output context (and extra) if they exist * Generic trap event logging and new config setting.
2018-08-14 06:56:16 +00:00
- Developing/SNMP-Traps.md
docs: Updated alerting docs / formatting (#7185) * Ignore docs/ * Fix indenentation YAML's pretty strict * Remove static anchor names Markdown does this automatically for us * Tabelize entities * Remove tildes They don't do anything
2017-08-19 18:40:50 +00:00
- Developing/Dynamic-Config.md
- Developing/Merging-Pull-Requests.md
- Developing/Creating-Release.md
Docs refactor (#7389) * docs: Refactored docs for new layout * some more changes * more doc updates * More doc updates * small update * small update
2017-10-02 20:36:22 +00:00
- Extensions/Plugin-System.md
- 11. Misc:
- Security information: General/Security.md
feature: Added purge-port scipt to allow deleting of ports from the CLI. (#7528) * Add purge-port scipt to allow deleting of ports from the CLI. This script allows deleting single ports by their port_id or a list of ports read from a file or STDIN. LibreNMS Port purge tool -p <port_id> Purge single port by it's port-id -f <file> Purge a list of ports, read port-ids from <file>, one on each line. A filename of - means reading from STDIN. Signed-off-by: Maximilian Wilhelm <max@sdn.clinic> * Update CLI-Tools.md
2017-11-09 12:57:41 +00:00
- CLI Scripts: Support/CLI-Tools.md
Test docs before deploying (#7992) * Test docs before deploying fix issue with docs * Actually check the result of the doc build add error for testing * Fix up docs * use original logic * only deploy docs if build succeeds. Make pip quiet
2018-01-02 14:20:19 +00:00
- Device Notes:
- Intro: Support/Device-Notes/index.md
- Carel pCOweb: Support/Device-Notes/Carel-pCOweb-Devices.md
Reference in New Issue Copy Permalink