Closes #10545: Standardize description & comment fields on primary models (#10834)

* Standardize description & comments fields on primary models

* Update REST API serializers

* Update forms

* Update tables

* Update templates

netbox/templates/circuits/provider.html

@@ -33,6 +33,10 @@
                         <th scope="row">Account</th>
                         <td>{{ object.account|placeholder }}</td>
                     </tr>
+                    <tr>
+                        <th scope="row">Description</th>
+                        <td>{{ object.description|placeholder }}</td>
+                    </tr>
                     <tr>
                         <th scope="row">Circuits</th>
                         <td>

netbox/templates/dcim/cable.html

@@ -32,6 +32,10 @@
               <th scope="row">Label</th>
               <td>{{ object.label|placeholder }}</td>
             </tr>
+            <tr>
+              <th scope="row">Description</th>
+              <td>{{ object.description|placeholder }}</td>
+            </tr>
             <tr>
               <th scope="row">Color</th>
               <td>
@@ -57,6 +61,7 @@
       </div>
       {% include 'inc/panels/custom_fields.html' %}
       {% include 'inc/panels/tags.html' %}
+      {% include 'inc/panels/comments.html' %}
       {% plugin_left_page object %}
     </div>
     <div class="col col-md-6">

netbox/templates/dcim/cable_edit.html

@@ -80,6 +80,7 @@
               {% render_field form.tenant_group %}
               {% render_field form.tenant %}
               {% render_field form.label %}
+              {% render_field form.description %}
               {% render_field form.color %}
               <div class="row mb-3">
                 <label class="col-sm-3 col-form-label text-lg-end">{{ form.length.label }}</label>
@@ -92,16 +93,22 @@
                 <div class="invalid-feedback"></div>
               </div>
               {% render_field form.tags %}
-              {% if form.custom_fields %}
-                <div class="field-group">
-                  <div class="row mb-3">
-                    <h5 class="offset-sm-3">Custom Fields</h5>
-                  </div>
-                  {% render_custom_fields form %}
-                </div>
-              {% endif %}
             </div>
           </div>
+            <div class="card">
+              <h5 class="card-header text-center">Comments</h5>
+              <div class="card-body">
+              {% render_field form.comments %}
+              </div>
+            </div>
+          {% if form.custom_fields %}
+            <div class="card">
+              <h5 class="card-header offset-sm-3">Custom Fields</h5>
+              <div class="card-body">
+                {% render_custom_fields form %}
+              </div>
+            </div>
+          {% endif %}
         </div>
       </div>
       <div class="row my-3">

netbox/templates/dcim/device.html

@@ -94,7 +94,11 @@
                             </td>
                         </tr>
                         <tr>
-                            <td>Airflow</td>
+                            <th scope="row">Description</th>
+                            <td>{{ object.description|placeholder }}</td>
+                        </tr>
+                        <tr>
+                            <th scope="row">Airflow</th>
                             <td>
                                 {{ object.get_airflow_display|placeholder }}
                             </td>

netbox/templates/dcim/device_edit.html

@@ -10,6 +10,7 @@
       </div>
       {% render_field form.name %}
       {% render_field form.device_role %}
+      {% render_field form.description %}
       {% render_field form.tags %}
     </div>
     

netbox/templates/dcim/devicetype.html

@@ -27,6 +27,10 @@
                             <td>Part Number</td>
                             <td>{{ object.part_number|placeholder }}</td>
                         </tr>
+                        <tr>
+                            <td>Description</td>
+                            <td>{{ object.description|placeholder }}</td>
+                        </tr>
                         <tr>
                             <td>Height (U)</td>
                             <td>{{ object.u_height|floatformat }}</td>

netbox/templates/dcim/module.html

@@ -62,6 +62,10 @@
             <th scope="row">Module Type</th>
             <td>{{ object.module_type|linkify }}</td>
           </tr>
+          <tr>
+            <th scope="row">Description</th>
+            <td>{{ object.description|placeholder }}</td>
+          </tr>
           <tr>
             <th scope="row">Serial Number</th>
             <td class="font-monospace">{{ object.serial|placeholder }}</td>

netbox/templates/dcim/moduletype.html

@@ -22,6 +22,10 @@
               <td>Part Number</td>
               <td>{{ object.part_number|placeholder }}</td>
             </tr>
+            <tr>
+              <th scope="row">Description</th>
+              <td>{{ object.description|placeholder }}</td>
+            </tr>
             <tr>
                 <td>Weight</td>
                 <td>

netbox/templates/dcim/powerfeed.html

@@ -38,6 +38,10 @@
                         <th scope="row">Status</th>
                         <td>{% badge object.get_status_display bg_color=object.get_status_color %}</td>
                     </tr>
+                    <tr>
+                        <th scope="row">Description</th>
+                        <td>{{ object.description|placeholder }}</td>
+                    </tr>
                     <tr>
                         <th scope="row">Connected Device</th>
                         <td>

netbox/templates/dcim/powerpanel.html

@@ -14,26 +14,29 @@
 {% block content %}
 <div class="row">
 	<div class="col col-md-6">
-        <div class="card">
-            <h5 class="card-header">
-                Power Panel
-            </h5>
-            <div class="card-body">
-                <table class="table table-hover attr-table">
-                    <tr>
-                        <th scope="row">Site</th>
-                        <td>{{ object.site|linkify }}</td>
-                    </tr>
-                    <tr>
-                        <th scope="row">Location</th>
-                        <td>{{ object.location|linkify|placeholder }}</td>
-                    </tr>
-                </table>
-            </div>
-        </div>
-        {% include 'inc/panels/tags.html' %}
-        {% plugin_left_page object %}
+    <div class="card">
+      <h5 class="card-header">Power Panel</h5>
+      <div class="card-body">
+        <table class="table table-hover attr-table">
+          <tr>
+            <th scope="row">Site</th>
+            <td>{{ object.site|linkify }}</td>
+          </tr>
+          <tr>
+            <th scope="row">Location</th>
+            <td>{{ object.location|linkify|placeholder }}</td>
+          </tr>
+          <tr>
+            <th scope="row">Description</th>
+            <td>{{ object.description|placeholder }}</td>
+          </tr>
+        </table>
+      </div>
     </div>
+    {% include 'inc/panels/tags.html' %}
+    {% include 'inc/panels/comments.html' %}
+    {% plugin_left_page object %}
+  </div>
 	<div class="col col-md-6">
         {% include 'inc/panels/custom_fields.html' %}
         {% include 'inc/panels/contacts.html' %}

netbox/templates/dcim/rack.html

@@ -78,6 +78,10 @@
                         <th scope="row">Role</th>
                         <td>{{ object.role|linkify|placeholder }}</td>
                     </tr>
+                    <tr>
+                        <th scope="row">Description</th>
+                        <td>{{ object.description|placeholder }}</td>
+                    </tr>
                     <tr>
                         <th scope="row">Serial Number</th>
                         <td class="font-monospace">{{ object.serial|placeholder }}</td>

netbox/templates/dcim/rack_edit.html

@@ -13,6 +13,7 @@
         {% render_field form.name %}
         {% render_field form.status %}
         {% render_field form.role %}
+        {% render_field form.description %}
         {% render_field form.tags %}
     </div>
 

netbox/templates/dcim/rackreservation.html

@@ -73,6 +73,7 @@
         </div>
         {% include 'inc/panels/custom_fields.html' %}
         {% include 'inc/panels/tags.html' %}
+        {% include 'inc/panels/comments.html' %}
         {% plugin_left_page object %}
 	</div>
     <div class="col col-12 col-xl-7">

netbox/templates/dcim/virtualchassis.html

@@ -27,11 +27,15 @@
             <th scope="row">Master</th>
             <td>{{ object.master|linkify }}</td>
           </tr>
+          <tr>
+            <th scope="row">Description</th>
+            <td>{{ object.description|placeholder }}</td>
+          </tr>
         </table>
       </div>
     </div>
-    {% include 'inc/panels/custom_fields.html' %}
     {% include 'inc/panels/tags.html' %}
+    {% include 'inc/panels/custom_fields.html' %}
     {% plugin_left_page object %}
     </div>
     <div class="col col-md-8">
@@ -73,6 +77,7 @@
           </div>
         {% endif %}
       </div>
+      {% include 'inc/panels/comments.html' %}
       {% plugin_right_page object %}
 	</div>
 </div>

netbox/templates/dcim/virtualchassis_edit.html

@@ -17,12 +17,18 @@
           </div>
           {% render_field vc_form.name %}
           {% render_field vc_form.domain %}
+          {% render_field vc_form.description %}
           {% render_field vc_form.master %}
           {% render_field vc_form.tags %}
         </div>
 
+        <div class="field-group my-5">
+          <h5 class="text-center">Comments</h5>
+          {% render_field vc_form.comments %}
+        </div>
+
         {% if vc_form.custom_fields %}
-          <div class="field-group my-5">
+          <div class="field-group mb-5">
             <div class="row mb-2">
               <h5 class="offset-sm-3">Custom Fields</h5>
             </div>

netbox/templates/ipam/aggregate.html

@@ -51,6 +51,7 @@
     <div class="col col-md-6">
       {% include 'inc/panels/custom_fields.html' %}
       {% include 'inc/panels/tags.html' %}
+      {% include 'inc/panels/comments.html' %}
       {% plugin_right_page object %}
     </div>
   </div>

netbox/templates/ipam/asn.html

@@ -67,6 +67,7 @@
     <div class="col col-md-6">
       {% include 'inc/panels/custom_fields.html' %}
       {% include 'inc/panels/tags.html' with tags=object.tags.all url='ipam:asn_list' %}
+      {% include 'inc/panels/comments.html' %}
       {% plugin_right_page object %}
     </div>
   </div>

netbox/templates/ipam/fhrpgroup.html

@@ -42,6 +42,7 @@
         </div>
       </div>
       {% include 'inc/panels/tags.html' %}
+      {% include 'inc/panels/comments.html' %}
       {% plugin_left_page object %}
     </div>
     <div class="col col-md-6">

netbox/templates/ipam/fhrpgroup_edit.html

@@ -13,7 +13,7 @@
     {% render_field form.tags %}
   </div>
 
-  <div class="field-group my-5">
+  <div class="field-group mb-5">
     <div class="row mb-2">
       <h5 class="offset-sm-3">Authentication</h5>
     </div>
@@ -22,7 +22,7 @@
   </div>
 
   {% if not form.instance.pk %}
-    <div class="field-group my-5">
+    <div class="field-group mb-5">
       <div class="row mb-2">
         <h5 class="offset-sm-3">Virtual IP Address</h5>
       </div>
@@ -32,6 +32,13 @@
     </div>
   {% endif %}
 
+  <div class="field-group mb-5">
+    <div class="row mb-2">
+      <h5 class="offset-sm-3">Comments</h5>
+    </div>
+    {% render_field form.comments %}
+  </div>
+
   {% if form.custom_fields %}
     <div class="row mb-2">
       <h5 class="offset-sm-3">Custom Fields</h5>

netbox/templates/ipam/ipaddress.html

@@ -108,6 +108,7 @@
       </div>
       {% include 'inc/panels/tags.html' %}
       {% include 'inc/panels/custom_fields.html' %}
+      {% include 'inc/panels/comments.html' %}
       {% plugin_left_page object %}
 	</div>
 	<div class="col col-md-8">

netbox/templates/ipam/ipaddress_edit.html

@@ -138,6 +138,13 @@
       </div>
     </div>
 
+    <div class="field-group my-5">
+      <div class="row mb-2">
+        <h5 class="text-center">Comments</h5>
+      </div>
+      {% render_field form.comments %}
+    </div>
+
     {% if form.custom_fields %}
       <div class="field-group my-5">
         <div class="row mb-2">

netbox/templates/ipam/iprange.html

@@ -70,9 +70,10 @@
         {% plugin_left_page object %}
     </div>
     <div class="col col-md-6">
-        {% include 'inc/panels/tags.html' %}
-        {% include 'inc/panels/custom_fields.html' %}
-        {% plugin_right_page object %}
+      {% include 'inc/panels/tags.html' %}
+      {% include 'inc/panels/custom_fields.html' %}
+      {% include 'inc/panels/comments.html' %}
+      {% plugin_right_page object %}
     </div>
 </div>
 <div class="row">

netbox/templates/ipam/l2vpn.html

@@ -39,6 +39,7 @@
 	<div class="col col-md-6">
       {% include 'inc/panels/contacts.html' %}
       {% include 'inc/panels/custom_fields.html' %}
+      {% include 'inc/panels/comments.html' %}
       {% plugin_right_page object %}
     </div>
 </div>

netbox/templates/ipam/prefix.html

@@ -155,6 +155,7 @@
     </div>
     {% include 'inc/panels/custom_fields.html' %}
     {% include 'inc/panels/tags.html' %}
+    {% include 'inc/panels/comments.html' %}
     {% plugin_right_page object %}
   </div>
 </div>

netbox/templates/ipam/routetarget.html

@@ -26,6 +26,7 @@
       </div>
       {% include 'inc/panels/tags.html' %}
       {% include 'inc/panels/custom_fields.html' %}
+      {% include 'inc/panels/comments.html' %}
       {% plugin_left_page object %}
     </div>
     <div class="col col-md-6">

netbox/templates/ipam/service.html

@@ -58,9 +58,10 @@
         {% plugin_left_page object %}
     </div>
     <div class="col col-md-6">
-        {% include 'inc/panels/custom_fields.html' %}
-        {% include 'inc/panels/tags.html' %}
-        {% plugin_right_page object %}
+      {% include 'inc/panels/custom_fields.html' %}
+      {% include 'inc/panels/tags.html' %}
+      {% include 'inc/panels/comments.html' %}
+      {% plugin_right_page object %}
     </div>
 </div>
 <div class="row mb-3">

netbox/templates/ipam/service_create.html

@@ -65,6 +65,13 @@
     {% render_field form.tags %}
   </div>
 
+  <div class="field-group my-5">
+    <div class="row mb-2">
+      <h5 class="text-center">Comments</h5>
+    </div>
+    {% render_field form.comments %}
+  </div>
+
   {% if form.custom_fields %}
     <div class="row mb-2">
       <h5 class="offset-sm-3">Custom Fields</h5>

netbox/templates/ipam/service_edit.html

@@ -52,6 +52,13 @@
     {% render_field form.tags %}
   </div>
 
+  <div class="field-group my-5">
+    <div class="row mb-2">
+      <h5 class="text-center">Comments</h5>
+    </div>
+    {% render_field form.comments %}
+  </div>
+
   {% if form.custom_fields %}
     <div class="row mb-2">
       <h5 class="offset-sm-3">Custom Fields</h5>

netbox/templates/ipam/servicetemplate.html

@@ -31,12 +31,13 @@
         </div>
       </div>
       {% plugin_left_page object %}
-      </div>
-      <div class="col col-md-6">
-        {% include 'inc/panels/custom_fields.html' %}
-        {% include 'inc/panels/tags.html' %}
-        {% plugin_right_page object %}
-      </div>
+    </div>
+    <div class="col col-md-6">
+      {% include 'inc/panels/custom_fields.html' %}
+      {% include 'inc/panels/tags.html' %}
+      {% include 'inc/panels/comments.html' %}
+      {% plugin_right_page object %}
+    </div>
   </div>
   <div class="row mb-3">
     <div class="col col-md-12">

netbox/templates/ipam/vlan.html

@@ -74,9 +74,10 @@
             {% plugin_left_page object %}
         </div>
         <div class="col col-md-6">
-            {% include 'inc/panels/custom_fields.html' %}
-            {% include 'inc/panels/tags.html' %}
-            {% plugin_right_page object %}
+          {% include 'inc/panels/custom_fields.html' %}
+          {% include 'inc/panels/tags.html' %}
+          {% include 'inc/panels/comments.html' %}
+          {% plugin_right_page object %}
         </div>
     </div>
     <div class="row">

netbox/templates/ipam/vlan_edit.html

@@ -55,6 +55,13 @@
     {% endwith %}
   </div>
 
+  <div class="field-group my-5">
+    <div class="row mb-2">
+      <h5 class="text-center">Comments</h5>
+    </div>
+    {% render_field form.comments %}
+  </div>
+
   {% if form.custom_fields %}
     <div class="field-group my-5">
       <div class="row mb-2">

netbox/templates/ipam/vrf.html

@@ -55,6 +55,7 @@
   <div class="col col-md-6">
     {% include 'inc/panels/tags.html' %}
     {% include 'inc/panels/custom_fields.html' %}
+    {% include 'inc/panels/comments.html' %}
     {% plugin_right_page object %}
 	</div>
 </div>

netbox/templates/tenancy/contact.html

@@ -63,6 +63,10 @@
                 {% endif %}
               </td>
             </tr>
+            <tr>
+              <th scope="row">Description</th>
+              <td>{{ object.description|placeholder }}</td>
+            </tr>
             <tr>
               <th scope="row">Assignments</th>
               <td>{{ assignment_count }}</td>

netbox/templates/virtualization/cluster.html

@@ -23,6 +23,10 @@
                   <th scope="row">Status</th>
                   <td>{% badge object.get_status_display bg_color=object.get_status_color %}</td>
                 </tr>
+                <tr>
+                  <th scope="row">Description</th>
+                  <td>{{ object.description|placeholder }}</td>
+                </tr>
                 <tr>
                     <th scope="row">Group</th>
                     <td>{{ object.group|linkify|placeholder }}</td>

netbox/templates/virtualization/virtualmachine.html

@@ -29,6 +29,10 @@
                         <th scope="row">Platform</th>
                         <td>{{ object.platform|linkify|placeholder }}</td>
                     </tr>
+                    <tr>
+                      <th scope="row">Description</th>
+                      <td>{{ object.description|placeholder }}</td>
+                    </tr>
                     <tr>
                         <th scope="row">Tenant</th>
                         <td>

netbox/templates/wireless/wirelesslan.html

@@ -39,6 +39,7 @@
       </div>
     </div>
     {% include 'inc/panels/tags.html' %}
+    {% include 'inc/panels/comments.html' %}
     {% plugin_left_page object %}
   </div>
   <div class="col col-md-6">

netbox/templates/wireless/wirelesslink.html

@@ -40,6 +40,7 @@
         </div>
       </div>
       {% include 'inc/panels/tags.html' %}
+      {% include 'inc/panels/comments.html' %}
       {% plugin_left_page object %}
     </div>
     <div class="col col-md-6">

netbox/templates/wireless/wirelesslink_edit.html

@@ -22,6 +22,12 @@
       </div>
     </div>
   </div>
+  <div class="field-group my-5">
+    <div class="row mb-2">
+      <h5 class="offset-sm-3">Comments</h5>
+    </div>
+    {% render_field form.comments %}
+  </div>
   {% if form.custom_fields %}
     <div class="field-group my-5">
       <div class="row mb-2">