MM-30754. Restructured and improved DNS user guide.

guides/user-manual/dns.rst

@@ -7,10 +7,15 @@
 DNS
 ====
 
-Micetro's :ref:`access control` system provides granular control over who can access DNS information. The system includes the following built-in roles that provide varying levels of access to the DNS page. 
+On the **DNS** page, manage your DNS information, including zones and resource records all in one place. Here, you can create and delete zones, migrate zones between servers, edit zone options, manage zone records, and more.
+
+.. image:: ../../images/DNS-Micetro.png
+   :width: 90%
+
+Micetro's role-based and centralized :ref:`Access Management<access-control>` system provides granular control over who can access DNS information. The system includes the following built-in roles that provide varying levels of access to the **DNS** page: 
 
 * **DNS Administrators**
-* **DNS viewers** (allows viewing of DNS information)
+* **DNS viewers** (can only view DNS information)
 
 To grant other roles access to DNS information, make sure that they include the following permissions:
 
@@ -19,12 +24,12 @@ To grant other roles access to DNS information, make sure that they include the
 * **List (or view) zone**
 
 .. note::
-   To fully manage zones, additional permissions may be required, and specific access might be defined on individual zones.
+   To fully manage zones, additional permissions may be required. Specific access might be defined on individual zones and require explicit permissions.
 
-
 .. toctree::
   :maxdepth: 1
 
   dns_zones
+  managing_dns_zones
   dns_records
   webapp_import_dns_records

guides/user-manual/dns_records.rst

@@ -4,30 +4,26 @@
 
 .. _dns-records:
 
-DNS Resource Records
+DNS resource records
 ====================
-
-Overview
---------
-
-Each zone in the Domain Name System (DNS) contains a set of resource records that define how requests are processed or delegated within that zone. To view the resource records for a particular zone, you can double-click the zone, or select the zone and then click :guilabel:`Open` on the toolbar at the top or on the row menu (**...**). Once you have opened the zone, you can view, edit, and manipulate the resource records.
+Each zone in the Domain Name System (DNS) contains a set of resource records that define how requests are processed or delegated within that zone. To view the resource records for a particular zone, double-click the zone or select the zone in the grid and then select :guilabel:`Open` on the task bar or :guilabel:`Open zone` on the Row :guilabel:`...` menu. Once the zone is open, you can view, edit, and manipulate the resource records as needed.
 
 .. image:: ../../images/DNS-records-Micetro-10.5.png
   :width: 90%
   :align: center
 |
-Selecting a DNS record in the list will display the following details and actions for the record in the :guilabel:`Inspector` pane on the right.
+Select a DNS record in the grid to view the following details and actions for the record in the Inspector.
 
 .. csv-table::
   :header: "Item", "Description"
   :widths: 15, 85
 
   "Actions", "Lists all available actions for the selected record."
   "Properties", "Lists the properties for the selected DNS record."
-  "Related DNS Data", "Lists all related DNS records for the selected DNS record. Related DNS records all DNS records that are somehow associated with the specified record."
-  "Related IP address", "Lists the related IP address in case of an A or AAAA DNS record."
+  "Related DNS Data", "Lists all DNS records that are somehow associated with the selected DNS record."
+  "Related IP Addresses", "Lists the related IP addresses in the case of an A or AAAA DNS record."
 
-Available Record Types
+Available record types
 ----------------------
 
 * A / AAAA
@@ -89,22 +85,23 @@ Available Record Types
 * CSYNC
 
 
-Creating New DNS Records
+Creating new DNS records
 -------------------------
+In Micetro, you can create new DNS records for a zone.
 
 .. note::
-  For importing DNS records in bulk, see :ref:`webapp-import-dns-records`.
+  For instructions on importing DNS records in bulk, refer to :ref:`webapp-import-dns-records`.
 
-To create a new DNS record:
+**To create a new DNS record**:
 
-1. Click :guilabel:`Create` in the main toolbar. The Create DNS Record dialog box opens.
+1. On the **DNS** page, select :guilabel:`Create`.
 
-2. Enter a name and select the record type. After selecting the type, the relevant fields are automatically displayed.
+2. In the **Create DNS Record** dialog box, enter a name for the record and select the record type. After selecting the type, the relevant fields for that type are automatically displayed.
 
   .. warning::
-    If you save a new DNS record with the wrong type, you cannot change the type later. You have to delete the record and create a new one with the correct type.
+    If you save a new DNS record with the wrong type, you cannot change the type later. You must delete the record and create a new one with the correct type.
 
-3. Fill in the required information and custom fields, if there are any.
+3. Enter the required and any optional custom information.
 
    * For A records, an autocomplete behavior helps find a free IP address in a network.
 
@@ -113,48 +110,46 @@ To create a new DNS record:
        .. image:: ../../images/create-DNS-record-ip-Micetro.png
           :width: 75%
 
-  * Selecting an item from the list, will fill in the **Address** field with the next free IP address from that network, along with an indicator on the address state: ``Free``, ``Reserved``, ``Claimed`` or ``Assigned``. You'll also see insights for the selected IP address.
+  * Selecting an item from the list autofills the :guilabel:`Address` field with the next free IP address from that network, along with an indicator on the address state: ``Free``, ``Reserved``, ``Claimed`` or ``Assigned``. It also displays insights for the selected IP address.
 
       .. image:: ../../images/create-DNS-record-ipam-Micetro.png
          :width: 75%
 
-4. When you are finished, click :guilabel:`Create now` to save the new record to the zone, or :guilabel:`Add to request` to add it to the request queue. For more information about the request queue, see :ref:`webapp-workflows`.
+4. When you are finished, select :guilabel:`Create Now` to save the new record to the zone or :guilabel:`Add to Request` to add it to the request queue. For more information about the request queue, refer to :ref:`webapp-workflows`.
 
-IP Address Insights
+IP address insights
 ^^^^^^^^^^^^^^^^^^^^
-Once you have entered/selected the IP address in the **Address** field, you can see some insights about the address and related objects. These insights give you more information about the IP address and can help you understand its state better.
+Once you have entered/selected the IP address in the :guilabel:`Address` field, the dialog box will display insights about the address and related objects. These insights provide more information about the IP address and can help you to better understand its state.
 
 .. image:: ../../images/create-DNS-record-ipam-insights-Micetro.png
      :width: 75%
 |
 Hover over the :guilabel:`i` icon to see more information or a list of objects:
 
-  * *Network* will show more details on the network.
+  * **Network** shows more details on the network.
 
-  * *Properties* will show a list of all defined properties for the specified IP address.
+  * **Properties** shows a list of all defined properties for the specified IP address.
 
-  * *DNS hosts* will show a list of all defined DNS hosts for the specified IP address.
+  * **DNS hosts** shows a list of all defined DNS hosts for the specified IP address.
 
-  * *MAC address* will show a list of additional MAC information for the specified IP address.
+  * **MAC address** shows a list of additional MAC information for the specified IP address.
 
-  * *Last seen* will show a list of additional information for the specified IP address.
+  * **Last seen** shows a list of additional information for the specified IP address.
 
 .. csv-table:: IPAM Insights
   :widths: 15, 85
 
   "Network", "The network containing the specified IP address"
   "Network type", "Either an IP address range or a DHCP scope"
-  "Properties", "Various properties including custom properties, if defined."
-  "DHCP client",
+  "Properties", "Various properties including custom properties, if defined"
   "DNS hosts", "Lists all DNS hosts that are set for the specified IP address"
   "MAC address", "The MAC address of the discovered device"
   "Last seen", "The date for which the IP address was last seen"
 
 
 Time-to-live (TTL)
 """"""""""""""""""
-
-Throughout the system, the TTL value can either be specified in seconds or using the shorthand notation, such as:
+When creating a DNS record, you must can provide its time-to-live (TTL). Throughout the system, the TTL value can either be specified in seconds or using the shorthand notation, such as:
 
    * **1s**: 1 second
 
@@ -169,38 +164,43 @@ Throughout the system, the TTL value can either be specified in seconds or using
 
 Editing a DNS record
 --------------------
+When necessary, Micetro enables you to edit an existing DNS record.
 
-1. Select the DNS record in the DNS record list
+.. note::
+  Once a DNS record is created, you cannot edit its type. If you created a record with the wrong type, delete the record and create a new one with the correct type.
 
-2. Either click :guilabel:`Edit` in the main task bar, or click on :guilabel:`Edit DNS record` in the row menu (...).
+**To edit a DNS record**:
 
-3. A dialog box is displayed where you can modify the DNS record.
+1. Select the DNS record in the grid on the **DNS** page.
 
-4. Click :guilabel:`Save`.
+2. Select either :guilabel:`Edit` on the task bar or use the Row :guilabel:`...` menu to select :guilabel:`Edit DNS record`.
 
+3. In the dialog box, modify the DNS record as needed.
+
+4. Click :guilabel:`Save`.
 
-Deleting Records
-----------------
 
+Deleting a DNS record
+---------------------
 Deleting a record removes both the data and the physical record from the grid. 
 
-1. Select the record(s) that you want to delete. To select multiple records, hold down the Ctrl (or Cmd on Mac) key while making your selections.
+**To delete a DNS record**
 
-2. Click :guilabel:`Delete` on the task bar. The record is immediately deleted from the zone.
+1. Select the record(s) that you want to delete. To select multiple records, hold down the **Ctrl** (or **Cmd** on Mac) key while making your selections.
 
+2. Click :guilabel:`Delete` on the task bar. The record is immediately deleted from the zone.
 
-Undoing Changes to Records
---------------------------
-If you need to revert or undo changes made to DNS records, Micetro provides a straightforward process through its history feature. It's essential to use this feature carefully, especially when dealing with critical DNS configurations.
 
-**To undo changes**:
+Undoing changes to a DNS record
+-------------------------------
+If you need to undo or revert changes made to DNS records, Micetro provides a straightforward process through its History feature. It's essential to use this feature carefully, especially when dealing with critical DNS configurations.
 
-1.	Locate the zone where the changes were made, and click on the row menu (...) associated with it.
+**To undo changes to a DNS record**:
 
-2. Select :guilabel:`View history`.
+1.	Locate the zone where the changes were made, and use the Row :guilabel:`...` menu to select :guilabel:`View history`.
 
-3.	Locate the specific action you want to undo within the history.
+3.	In the **History** dialog, select the specific action you want to undo.
 
-4.	Select :guilabel:`Undo` option on the Row menu (…). This action will roll back the selected change, restoring the DNS record to its previous state.
+4.	Use the Row :guilabel:`...` menu to select :guilabel:`Undo`. This action will roll back the selected change, restoring the DNS record to its previous state.
 
-For more information about viewing object change history, see :ref:`view-change-history`.
+For more information about viewing object change history, refer to :ref:`view-change-history`.