7025 documentation

docs/models/circuits/circuitgroup.md

@@ -0,0 +1,13 @@
+# Circuit Groups
+
+[Circuits](./circuit.md) can be arranged into administrative groups for organization. The assignment of a circuit to a group is optional.
+
+## Fields
+
+### Name
+
+A unique human-friendly name.
+
+### Slug
+
+A unique URL-friendly identifier. (This value can be used for filtering.)

docs/models/circuits/circuitgroupassignment.md

@@ -0,0 +1,19 @@
+# Circuit Group Assignments
+
+Circuits can be assigned to [Circuit groups](./circuitgroup.md) to indicate Fallback Circuits. For instance, three circuits, each belonging to a different provider, may each be assigned to the same Circuit group. Each of these assignments would typically receive a different priority.
+
+Circuits are assigned to Circuit groups under the Circuit Group detail view.
+
+## Fields
+
+### Group
+
+The [Circuit group](./circuitgroup.md) being assigned.
+
+### Circuit
+
+The [Circuit](./circuit.md) that is being assigned to the group.
+
+### Priority
+
+A value between 0 and 255 indicating the circuit's priority for being elected as the master/primary node in the group.

mkdocs.yml

@@ -163,6 +163,8 @@ nav:
     - Data Model:
         - Circuits:
             - Circuit: 'models/circuits/circuit.md'
+            - CircuitGroup: 'models/circuits/circuitgroup.md'
+            - CircuitGroupAssignment: 'models/circuits/circuitgroupassignment.md'
             - Circuit Termination: 'models/circuits/circuittermination.md'
             - Circuit Type: 'models/circuits/circuittype.md'
             - Provider: 'models/circuits/provider.md'