Merge pull request #518 from ritza-co/1234-connectivity

1234: grammar and formatting improvements; connectivity

Author: sixhobbits

docs/infrastructure-management/connectivity/cables.mdx

@@ -10,7 +10,7 @@ The Device42 cables module can track the origin, end connection(s), length, and
 
 The origin and endpoint types can be patch panel ports, switch ports, devices, circuits, or other cables. A given cable endpoint can also be an origin for multiple other cables.
 
-Find the Add Cable screen under **Hardware > Cables**.
+Navigate to **Infrastructure > Connectivity > Cables** to view and add cables.
 
 <ThemedImage
   alt="Add A Cable"
@@ -20,11 +20,11 @@ Find the Add Cable screen under **Hardware > Cables**.
   }}
 />
 
-Cables also have their own unique properties. In addition to length, connector type, and location, cables support [custom fields](../../administration/custom-key-value-pairs-explained.mdx).
+Cables also have their own unique properties. In addition to length, connector type, and location, cables support [custom fields](administration/custom-key-value-pairs-explained.mdx).
 
 ## Drag-and-Drop Cabling From the Rack View
 
-From the rack view under **Data Center > Racks > Your Rack > View Rack Layout**, you can create, move, edit, and trace cables visually via the drag-and-drop functionality, in addition to the above method.
+From the rack layout view under **Infrastructure > DataCenter > Racks**, open a rack and select **View Rack Layout** to create, move, edit, and trace cables visually using drag-and-drop.
 
 You can also view or add a cable connection by clicking **Physical Connections** under **Rack Details** on the left and enabling edit mode:
 

docs/infrastructure-management/connectivity/circuits.mdx

@@ -6,9 +6,9 @@ sidebar_position: 2
 import ThemedImage from '@theme/ThemedImage';
 import useBaseUrl from '@docusaurus/useBaseUrl'
 
-The Device42 circuits module enables you to manage and tack the **Circuit ID**, **Vendor**, **Customer** who owns the circuit, and more. 
+The Device42 circuits module lets you manage circuits, tracking the **Circuit ID**, **Vendor**, **Customer**, and more.
 
-The circuits module tracks both **Origin** and **End Point** connections. The **Origin Type** and **Endpoint Type** includes panel ports, switch ports, devices, or other circuits.
+The module tracks both **Origin** and **End Point** connections. The **Origin Type** and **Endpoint Type** can be panel ports, switch ports, devices, or other circuits.
 
 Navigate to **Infrastructure > Hardware > Circuits** and click the **Create** button.
 
@@ -46,4 +46,4 @@ Navigate to **Infrastructure > Hardware > Circuits** and click the **Create** bu
 
 The module also tracks the **Order Date**, **Provision Date**, **Turn on Date**, and **Expiration Date** on contracts.
 
-Fields to upload **File Attachments**, enter **Custom Fields** and **Purchase/Support** details are also available on this screen.
+The form also includes fields for **File Attachments**, **Custom Fields**, and **Purchase/Support** details.

docs/infrastructure-management/connectivity/creating-wall-jacks.mdx

@@ -1,12 +1,12 @@
 ---
-title: "Creating Wall Jacks"
+title: "Create Wall Jacks"
 sidebar_position: 3
 ---
 
 import ThemedImage from '@theme/ThemedImage';
 import useBaseUrl from '@docusaurus/useBaseUrl'
 
-One method for documenting the connections and the patch from a patch panel to a wall jack, to a switch, to devices is to create a **patch panel model** for wall jacks. 
+One method for documenting the connection path from a patch panel to a wall jack to a switch and its devices is to create a **patch panel model** for the wall jack.
 
 Navigate to **Resources > Assets > Patch Panel Models** and create a model with the appropriate **Port Type** and desired **Number of ports** on the panel of the wall jack.
 
@@ -19,17 +19,17 @@ Navigate to **Resources > Assets > Patch Panel Models** and create a model with
   style={{ width: '80%' }} 
 />
 
-Once you've created the model, make specific assets for the wall jacks via **Resources > All Assets > Create**. When creating the asset, select the type **Patch Panel**, then select the wall jack model for the patch panel model and the **Back connection** type, which can be either **Patch Panel** or **Switch**, and can go to the patch panel or the unmanaged switch you are documenting.
+Once you've created the model, create assets for the wall jacks via **Resources > All Assets > Create**. When creating the asset, select the type **Patch Panel**, then select the wall jack model as the patch panel model. Set the **Back connection** type to either **Patch Panel** or **Switch**, depending on whether it connects to the patch panel or the unmanaged switch you are documenting.
 
-You will then want to create an unmanaged switch:
+Next, create an unmanaged switch:
 
-- Do this by going to **Tools > Templates & Bulk Operations > Switch Templates**, then create a template that reflects the switches that are part of this connectivity by selecting a switch type and adding a ports switch template with the desired ports prefix and a template that includes the type and number of ports.
+- Navigate to **Tools > Templates & Bulk Operations > Switch Templates** and create a template that reflects your switches. Select a switch type and add a ports switch template with the desired ports prefix, type, and number of ports.
 
 - Once you've created the switch template, select the template and click the **Create/Edit** option under the **Ellipsis menu** in the top right corner of the template's details page. Here, you can add the desired amount of unmanaged switches needed.
 
 Once you've created assets for the wall jacks and created switches from the template, you can start creating the connections:
 
-- Go to the desired wall jack asset you want to work with and open the edit details page of the asset. There will be a section for patch panel ports on this details page, with a line for each port contained on the wall jack panel (defined by the previously created patch panel model).
+- Open the wall jack asset and go to its edit details page. The page includes a patch panel ports section with a line for each port on the wall jack panel, as defined by the patch panel model you created earlier.
 - First, define the front connection as either the patch panel or the switch, whichever is desired. 
 - Define the **Connection Type**, then enter the **Object** ID or search for and select the switch port or the patch panel port for the connection. 
 - You can also enter a **Label** for the connection that corresponds with the wall jack label in the room (if it is labeled). Then, define the **Back connection**, which can also be the patch panel port or the switch port (whichever you did not use for the front connection).

docs/infrastructure-management/connectivity/index.mdx

@@ -1,18 +1,5 @@
 ---
-title: "Patch Panels"
-created: 2013-03-06
-authors: 
-  - d42docadmin
+title: "Connectivity"
 ---
 
-You can manage structured cabling. In this section, would discuss following topics:
-
-
-
-## Table of contents
-
-- [Cables](infrastructure-management/connectivity/cables.mdx)
-- [Circuits](infrastructure-management/connectivity/circuits.mdx)
-- [Creating Wall Jacks](infrastructure-management/connectivity/creating-wall-jacks.mdx)
-- [Patch panels and cable management](infrastructure-management/connectivity/patch-panels/patch-panel-cable-management-definitions-and-legends-2.mdx)
-- [Creating patch panels from scratch in Device42: an example](infrastructure-management/connectivity/patch-panels/creating-patch-panels-from-scratch-in-device42-an-example.mdx)
+Device42 lets you document and manage your physical network infrastructure, including cables, circuits, wall jacks, and patch panels. Use the sidebar to navigate to specific topics.

docs/infrastructure-management/connectivity/patch-panels/creating-patch-panels-from-scratch-in-device42-an-example.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Creating patch panels from scratch in Device42: an example"
+title: "Create Patch Panels From Scratch: An Example"
 ---
 
 import ThemedImage from '@theme/ThemedImage';
@@ -17,7 +17,7 @@ The end goal is:
 2. Patch `Panel A` is patched to `switch-01`.
 3. Patch `Panel B` is patched to devices in the same rack as patch `Panel B`.
 
-This will provide our devices with connectivity to switch ports.
+This provides devices with connectivity to switch ports.
 
 ### Create Patch Panel Models
 
@@ -29,11 +29,11 @@ This will provide our devices with connectivity to switch ports.
   }}
 />
 
-Before we add the patch panel, we need to create the template. In this example, this is a single patch panel with 48 RJ-45 ports.
+Before adding the patch panel, create the model template. In this example, this is a single patch panel with 48 RJ-45 ports.
 
-- Go to **Resources > Assets > Patch Panel Models > Create**.
+- Go to **Resources > Assets > Patch Panel Models > Create**.
 - Enter the details for the model, including a name, port type, and number of ports.
-- **Save** the patch panel model.
+- **Save** the patch panel model.
 
 ### Create Patch Panels
 
@@ -69,9 +69,9 @@ Before we add the patch panel, we need to create the template. In this example,
   }}
 />
 
-1. Go to **Resources > All Assets > Create**.
+1. Go to **Resources > All Assets > Create**.
 2. **Name** it `Panel A`, select **Patch Panel** as its **Type**, and choose the model created above.
-3. Click **Save**.
+3. Click **Save**.
 
 Repeat the same steps for `Panel B`, changing only the name to `Panel B` in Step 2.
 
@@ -128,10 +128,10 @@ Now, `Panel A` and `Panel B` are connected to each other.
 
 In this example, ports from switch-01 are patched to Panel A. (You can create switch ports in bulk using switch templates, as discussed under [Switch Templates](infrastructure-management/ipam/switch-templates.mdx).)
 
-The tedious way to do this is to add each switch port to each panel port. Instead, use the recommended API Excel import option as follows:
+You could add each switch port to each panel port manually, but the recommended approach is to use the API Excel import as follows:
 
 1. Download the sample Excel file from **Create/update Patch Panel Ports** on that page.
-2. Check that the columns look like this: **number  |  patch_panel_id  |  switch  |  switchport**
+2. Check that the columns look like this: **number  |  patch_panel_id  |  switch  |  switchport**
 3. Add the rows for the panel port number, panel ID (retrieved from the Asset list view, from APIs, or from hovering over the status bar), switch name, and switch port name.
 4. Import the XLS sheet.
 
@@ -151,7 +151,7 @@ Upon import, you can see the switch ports' connections on Panel A.
 
 In this step, use the same sample Excel sheet downloaded in the step above.
 
-The column layout is a little different and looks like this: **number  |  patch_panel_id  |  device  |  obj_label1**
+The column layout is a little different and looks like this: **number  |  patch_panel_id  |  device  |  obj_label1**
 
 Once you've added the values to Excel and imported the sheet, `Panel B` will show the following.
 
@@ -173,7 +173,7 @@ Once you've added the values to Excel and imported the sheet, `Panel B` will sho
   }}
 />
 
-Now, if you go to `Panel B`'s patch panel layout and hover over any port or device, you will see the full visual path for that port.
+In `Panel B`'s patch panel layout, hover over any port or device to see the full visual path for that port.
 
 ### Switch Port Level Connectivity
 
@@ -185,7 +185,7 @@ Now, if you go to `Panel B`'s patch panel layout and hover over any port or devi
   }}
 />
 
-You will see the patch panel connectivity from each switch port view as well.
+Patch panel connectivity is also visible from each switch port view.
 
 ### Device Level Connectivity
 

docs/infrastructure-management/connectivity/patch-panels/index.mdx

@@ -1,15 +1,5 @@
 ---
 title: "Patch Panels"
-created: 2013-03-06
-authors: 
-  - d42docadmin
 ---
 
-You can manage structured cabling. In this section, would discuss following topics:
-
-
-
-## Table of contents
-
-- [Patch panels and cable management](infrastructure-management/connectivity/patch-panels/patch-panel-cable-management-definitions-and-legends-2.mdx)
-- [Creating patch panels from scratch in Device42: an example](infrastructure-management/connectivity/patch-panels/creating-patch-panels-from-scratch-in-device42-an-example.mdx)
+Device42 lets you document and manage patch panel ports and their cable connections. Use the sidebar to navigate to specific topics.

docs/infrastructure-management/connectivity/patch-panels/patch-panel-cable-management-definitions-and-legends-2.mdx

@@ -58,7 +58,7 @@ If you have different cable types in the same patch panel, you should use **Modu
   }}
 />
 
-You can add modules to your patch panels and configure different port types or just modules. For a modular patch panel, you have the option to add modules. Ports for each module are created based on **patch panel module models**. All the module ports will appear in the original patch panel view.
+For a modular patch panel, you can add modules and configure different port types, or just add modules. Ports for each module are created based on **patch panel module models** and appear in the original patch panel view.
 
 <ThemedImage
   alt="Patch panel modular configuration"
@@ -105,7 +105,7 @@ If a patch panel is racked, by default, only the devices in that rack are shown.
   style={{ width: '70%' }} 
 />
 
-You can choose the individual **Back connection** per port and add a **Back cable** type for back connectivity with this option. You can add cable speed and other attributes for back connectivity for each port. In addition to the edit screens above, there are RESTful APIs and spreadsheet imports available for doing this more easily. There is also a bulk operations option for provisioning back connectivity, as discussed below.
+You can set the **Back connection** and **Back cable** type individually for each port, including cable speed and other attributes. RESTful APIs and spreadsheet imports are also available for bulk updates. A bulk operations option for provisioning back connectivity is discussed below.
 
 ### Bulk Back Ports Connectivity
 
@@ -134,7 +134,7 @@ View full connection paths and patch panel layouts.
   style={{ width: '70%' }} 
 />
 
-You can get full path details visualized in this table.
+The table displays full path details for each connection.
 
 ### Patch Panel Layout
 
@@ -147,7 +147,7 @@ You can get full path details visualized in this table.
   style={{ width: '40%' }} 
 />
 
-The view or edit page of that asset (the patch panel) adds a new **View Patch Panel Layout** button.
+The patch panel's view or edit page includes a **View Patch Panel Layout** button.
 
 <ThemedImage
   alt="Patch Panel Layout view"
@@ -174,7 +174,7 @@ Use drag-and-drop to create and manage patch panel connections.
   }}
 />
 
-From the Patch Panel Layout page, you can turn on the edit mode and connect patch panel ports to other devices or switch ports by dragging a port to a device or another port. This makes it very easy to manage your patch panel connectivity and keep information up to date.
+From the Patch Panel Layout page, enable edit mode and connect patch panel ports to devices or switch ports by dragging a port to its destination.
 
 ### Drag-and-Drop for Switch Port
 
@@ -187,7 +187,7 @@ From the Patch Panel Layout page, you can turn on the edit mode and connect patc
   style={{ width: '80%' }} 
 />
 
-From the Patch Panel Layout page, you can also drag-and-drop switch ports to devices or to patch panel ports. When you do so, a popup appears, giving you the opportunity to enter a port label.
+From the Patch Panel Layout page, you can also drag switch ports to devices or patch panel ports. A popup appears where you can enter a port label.
 
 ### Direct Patch Panel Port to Patch Panel Ports Connections
 
@@ -215,7 +215,7 @@ Handle devices outside the rack, half-depth devices, and multi-hop connections.
   }}
 />
 
-By default, only the devices in the same rack as the asset would show up. You can reset the filter by clicking on total devices, as shown above, and choose a device outside the rack. These are displayed on the left side of the patch panel, as shown below.
+By default, only devices in the same rack as the patch panel are shown. You can reset the filter by clicking on total devices, as shown above, to select a device outside the rack. These are displayed on the left side of the patch panel, as shown below.
 
 ![](/assets/images/wpid5717-media_1355834288356.png)