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 <[email protected]>
This commit is contained in:
Jellyfrog
2022-02-08 23:02:28 +00:00
committed by GitHub
co-authored by Neil Lathwood
parent ee00f59ce6
commit 8f474dd4d4
163 changed files with 1226 additions and 2451 deletions
-1
View File
@@ -1 +0,0 @@
<meta http-equiv="refresh" content="0; url=/API" />
-3
View File
@@ -1,6 +1,3 @@
source: API/ARP.md
path: blob/master/doc/
### `list_arp`
Retrieve a specific ARP entry or all ARP entries for a device
-3
View File
@@ -1,6 +1,3 @@
source: API/Alerts.md
path: blob/master/doc/
### `get_alert`
Get details of an alert
-3
View File
@@ -1,6 +1,3 @@
source: API/Bills.md
path: blob/master/doc/
### `list_bills`
Retrieve the list of bills currently in the system.
-3
View File
@@ -1,6 +1,3 @@
source: API/DeviceGroups.md
path: blob/master/doc/
### `get_devicegroups`
List all device groups.
-3
View File
@@ -1,6 +1,3 @@
source: API/Devices.md
path: blob/master/doc/
### `del_device`
Delete a given device.
-3
View File
@@ -1,6 +1,3 @@
source: API/Inventory.md
path: blob/master/doc/
### `get_inventory`
Retrieve the inventory for a device. If you call this without any
-3
View File
@@ -1,6 +1,3 @@
source: API/Locations.md
path: blob/master/doc/
### `add_location`
Add a new location
-3
View File
@@ -1,6 +1,3 @@
source: API/Logs.md
path: blob/master/doc/
All the `list_*logs` calls are aliased to `list_logs`.
Retrieve all logs or logs for a specific device.
-3
View File
@@ -1,6 +1,3 @@
source: API/PortGroups.md
path: blob/master/doc/
### `get_graph_by_portgroup`
Get the graph based on the group type.
-3
View File
@@ -1,6 +1,3 @@
source: API/Port_Groups.md
path: blob/master/doc/
### `get_port_groups`
List all port groups.
-3
View File
@@ -1,6 +1,3 @@
source: API/Devices.md
path: blob/master/doc/
### `get_all_ports`
Get info for all ports on all devices. Strongly recommend that you use
-3
View File
@@ -1,6 +1,3 @@
source: API/Routing.md
path: blob/master/doc/
### `list_bgp`
List the current BGP sessions.
-3
View File
@@ -1,6 +1,3 @@
source: API/Services.md
path: blob/master/doc/
### `list_services`
Retrieve all services
-3
View File
@@ -1,6 +1,3 @@
source: API/Switching.md
path: blob/master/doc/
### `list_vlans`
Get a list of all VLANs.
-3
View File
@@ -1,6 +1,3 @@
source: API/System.md
path: blob/master/doc/
### `system`
Display Librenms instance information.
-3
View File
@@ -1,6 +1,3 @@
source: API/index.md
path: blob/master/doc/
## Versioning
Versioning an API is a minefield which saw us looking at numerous