small documentation updates

README.md

@@ -49,10 +49,10 @@ A special `common` subsection under `Backends` defines configuration settings th
   backends:
       ...
       common:
-      diode:
-        target: grpc://192.168.0.22:8080/diode
-        api_key: ${DIODE_API_KEY}
-        agent_name: agent01
+        diode:
+          target: grpc://192.168.0.22:8080/diode
+          api_key: ${DIODE_API_KEY}
+          agent_name: agent01
 ```
 
 
@@ -65,10 +65,10 @@ orb:
   policies:
     device_discovery:
       device_policy_1:
-        # see device_discovery section
+        # see docs/backends/device_discovery.md
     network_discovery:
       network_policy_1:
-       # see network_discovery section
+       # see docs/backends/network_discovery.md
  ```
 
  ## Configuration samples

docs/backends/device_discovery.md

@@ -1,5 +1,5 @@
 # Device Discovery
-The device discovery backend leverages NAPALM to connect to network devices and collect network information.
+The device discovery backend leverages [NAPALM](https://napalm.readthedocs.io/en/latest/index.html) to connect to network devices and collect network information.
 
 
 ## Configuration
@@ -15,7 +15,7 @@ orb:
         api_key: ${DIODE_API_KEY}
         agent_name: agent01
     device_discovery:
-      host: 192.168.5.11 #default 0.0.0.0
+      host: 192.168.5.11 # default 0.0.0.0
       port: 8857 # default 8072
 
 ```

docs/backends/network_discovery.md

@@ -1,5 +1,5 @@
 # Network Discovery
-The network discovery backend leverages NMAP to scan networks and discover IP information.
+The network discovery backend leverages [NMAP](https://nmap.org/) to scan networks and discover IP information.
 
 
 ## Configuration
@@ -15,10 +15,10 @@ orb:
         api_key: ${DIODE_API_KEY}
         agent_name: agent01
     network_discovery:
-      host: 192.168.5.11 #default 0.0.0.0
+      host: 192.168.5.11 # default 0.0.0.0
       port: 8863 # default 8072
-      log_level: ERROR #default INFO
-      log_format: JSON #default TEXT
+      log_level: ERROR # default INFO
+      log_format: JSON # default TEXT
 
 ```
 
@@ -71,6 +71,6 @@ orb:
             - 192.168.7.32
             - 192.168.7.30-40 # IP range
             - 192.168.7.0/24 # IP subnet
-            - google.com #dns lookup
+            - google.com # dns lookup
 
 ```

docs/config_samples.md

@@ -2,7 +2,7 @@
 Here is a collection of configuration samples supported by orb agent
 
 ## Device-discovery backend
-This sample configuration file demonstrates the device discovery backend connecting to a Cisco router at 192.168.0.5. It retrieves device, interface, and IP information, then sends the data to a diode server running at 192.168.0.100.
+This sample configuration file demonstrates the device discovery backend connecting to a Cisco router at 192.168.0.5. It retrieves device, interface, and IP information, then sends the data to a [diode](https://github.com/netboxlabs/diode) server running at 192.168.0.100.
 
 ```yaml
 orb:
@@ -34,7 +34,7 @@ Run command:
  docker run -v /local/orb:/opt/orb/ \
  -e DIODE_API_KEY={YOUR_API_KEY} \
  -e PASS={DEVICE_PASSWORD} \
- netboxlabs/orb-agent:develop run -c /opt/orb/agent.yaml
+ netboxlabs/orb-agent:latest run -c /opt/orb/agent.yaml
 ```
 
 ### Custom Drivers
@@ -62,7 +62,7 @@ Run command:
  -e DIODE_API_KEY={YOUR_API_KEY} \
  -e PASS={DEVICE_PASSWORD} \
  -e INSTALL_DRIVERS_PATH=/opt/orb/drivers.txt \
- netboxlabs/orb-agent:develop run -c /opt/orb/agent.yaml
+ netboxlabs/orb-agent:latest run -c /opt/orb/agent.yaml
 ```
 The relative path used by `pip install` should point to the directory containing the `.txt` file.
 
@@ -93,5 +93,5 @@ Run command:
 ```sh
  docker run -v /local/orb:/opt/orb/ \
  -e DIODE_API_KEY={YOUR_API_KEY} \
- netboxlabs/orb-agent:develop run -c /opt/orb/agent.yaml
+ netboxlabs/orb-agent:latest run -c /opt/orb/agent.yaml
 ```