Merge pull request #337 from ritza-co/docs-18.14.7

Docs v18.14.7 release (Week 20, 2024)

docs/getstarted/tutorials/device42-tutorial.mdx

@@ -100,8 +100,8 @@ Of course, there are forms available for screen-based data entry via the UI, as
 Three tutorials are available to help familiarize you with the Device42 system, and a selection of How-to videos are available that address common questions: ([Check out the how-to videos index here!](docs/how-to-videos/index.md))
 
 1. The [Loading Data Using the API Tutorial](getstarted/tutorials/tutorial-loading-data-using-the-api.md) uses the API to load a fairly robust set of data into Device42 system. Don't be concerned if you are not a programmer. The script used in this tutorial is a very simple bash script. Please send us a note if you would like a sample in PowerShell, Python or other languages.
-2. The [Loading Data Using Spreadsheets Tutorial](/getstarted/tutorials/tutorial-loading-data-using-spreadsheets.md) uses spreadsheets to load data. There is no scripting involved. If you are fairly certain that you will never script API calls, this is the tutorial you should use.
-3. The [Navigating The Device42 User Interface Tutorial](getstarted/tutorials/tutorial-navigating-the-device42-user-interface.md) explores the Device42 core features using your data (follow the above tutorials to create data, or should you not have time to create your own data, request a sample spreadsheet of data by emailing [email protected]. This sample spreadsheet will load a wide variety of data in Device42; use tutorial #2, "Loading data using spreadsheets" to load the sample data).
+2. The [Loading Data Using Spreadsheets Tutorial](/getstarted/tutorials/tutorial-loading-data-using-spreadsheets.mdx) uses spreadsheets to load data. There is no scripting involved. If you are fairly certain that you will never script API calls, this is the tutorial you should use.
+3. The [Navigating The Device42 User Interface Tutorial](getstarted/tutorials/tutorial-navigating-the-device42-user-interface.mdx) explores the Device42 core features using your data (follow the above tutorials to create data, or should you not have time to create your own data, request a sample spreadsheet of data by emailing [email protected]. This sample spreadsheet will load a wide variety of data in Device42; use tutorial #2, "Loading data using spreadsheets" to load the sample data).
 
 It might not be necessary to work through all of the tutorials, but we absolutely recommend that you work through at least one of them if you're new. Many will find it beneficial to follow through on more than one tutorial, as well, gaining valuable experience along the way. If you'd like to keep your Device42 instance fresh for each tutorial, or would like to revert back to fresh after doing one, simply use hypervisor snapshots (ask your IT/sysadmin if you don't manage Device42!), start with a new copy of the Device42 virtual appliance, or set up a dedicated training environment!
 

docs/getstarted/tutorials/index.md

@@ -9,6 +9,6 @@ Welcome to the Device42 tutorials section. Choose a topic below to get started!
 ## Table of contents
 
 - [Tutorials Overview](/getstarted/tutorials/device42-tutorial.mdx)
-- [Tutorial:  Loading Data Using Spreadsheets](getstarted/tutorials/tutorial-loading-data-using-spreadsheets.md)
+- [Tutorial:  Loading Data Using Spreadsheets](getstarted/tutorials/tutorial-loading-data-using-spreadsheets.mdx)
 - [Tutorial:  Loading Data using the API](getstarted/tutorials/tutorial-loading-data-using-the-api.md)
-- [Tutorial:  Navigating the Device42 User Interface](getstarted/tutorials/tutorial-navigating-the-device42-user-interface.md)
+- [Tutorial:  Navigating the Device42 User Interface](getstarted/tutorials/tutorial-navigating-the-device42-user-interface.mdx)

docs/getstarted/tutorials/tutorial-loading-data-using-spreadsheets.mdx

@@ -0,0 +1,123 @@
+---
+title: "Tutorial: Loading Data Using Spreadsheets"
+sidebar_position: 1
+---
+
+import ThemedImage from '@theme/ThemedImage'
+import useBaseUrl from '@docusaurus/useBaseUrl'
+import apiImage from '/assets/images/tutorial-loading-data-using-spreadsheets/buildings-api-parameters.png'
+
+In this tutorial, we will load data to the Main Appliance using the API import feature. You can load any type of data that can be loaded via the Device42 API, which means it is possible to import just about all of your data using the import feature. 
+
+To get started, navigate to **Tools > Imports/Exports (xls)**.
+
+<ThemedImage
+  alt="Imports/Exports (xls) menu item"
+  sources={{
+    light: useBaseUrl('/assets/images/tutorial-loading-data-using-spreadsheets/imports-xls-menu-location-light.png'),
+    dark: useBaseUrl('/assets/images/tutorial-loading-data-using-spreadsheets/imports-xls-menu-location-dark.png'),
+  }}
+  style={{ width: '80%' }} 
+/>
+
+## Workflow Overview
+
+The easiest way to create an API Import spreadsheet is to look through the list of import types (3) on the page to find the one you need. Click the **Download Sample Excel File** link (4) and add your data to it. 
+
+To learn what the fields in the spreadsheet mean and which parameters are required, click the **View Documentation** link (5) to go to the API documentation.
+
+Click the **Browse** button (1) to select a prepared Excel file on your machine and click the green **Import** button (2) to upload the data.
+
+<ThemedImage
+  alt="Imports/Exports (xls) page"
+  sources={{
+    light: useBaseUrl('/assets/images/tutorial-loading-data-using-spreadsheets/import-excel-page-light.png'),
+    dark: useBaseUrl('/assets/images/tutorial-loading-data-using-spreadsheets/import-excel-page-dark.png'),
+  }}
+  style={{ width: '110%' }} 
+/>
+
+Alternatively, you can download all your current data (6) and add new data to it. If the **Type of Import** contains the words "Create" or "Update", you can change and add data elements, and then upload the spreadsheet with the **Import** button (2).
+
+## Buildings Example
+
+### Prepare the Excel Data
+
+![Loading sample data](/assets/images/tutorial-loading-data-using-spreadsheets/building-xls-modified-sample.png)
+
+Let's start by uploading building data. When you open the downloaded sample spreadsheet, you'll see the API URL and HTTP request method on the first two rows. 
+
+The third row contains the field names. The actual data starts from the fourth row onwards. The example above shows two buildings to be loaded into Device42. If we wanted to load 20 buildings, we would put the data on rows 4 through 23 of the spreadsheet.
+
+### Consult the API Docs
+
+As you can see from the [documentation](https://api.device42.com/#Buildings_postBuildings), the name of the building is required but the rest of the fields are optional and can be left blank.
+
+<img src={apiImage} width="90%"/>
+
+### Upload the Excel File
+
+From the Main Appliance, **Browse** to your buildings spreadsheet and click the **Import** button to upload the data.
+
+You'll see a message indicating a successful upload.
+
+<ThemedImage
+  alt="Imports success message"
+  sources={{
+    light: useBaseUrl('/assets/images/tutorial-loading-data-using-spreadsheets/success-message-light.png'),
+    dark: useBaseUrl('/assets/images/tutorial-loading-data-using-spreadsheets/success-message-dark.png'),
+  }}
+  style={{ width: '110%' }} 
+/>
+
+### View the Uploaded Data
+
+Navigate to **Infrastructure > Buildings** and find the two buildings listed in the table. You can click on a building name to view its details, edit, or add more information to it.
+
+<ThemedImage
+  alt="Buildings list page with new data"
+  sources={{
+    light: useBaseUrl('/assets/images/tutorial-loading-data-using-spreadsheets/buildings-list-page-light.png'),
+    dark: useBaseUrl('/assets/images/tutorial-loading-data-using-spreadsheets/buildings-list-page-dark.png'),
+  }}
+
+/>
+
+You can also view the new building data from the **Classic Dashboard** on the home page. Click the number across the **Buildings** statistics to go to the buildings list page.
+
+<ThemedImage
+  alt="Buildings list page with new data"
+  sources={{
+    light: useBaseUrl('/assets/images/tutorial-loading-data-using-spreadsheets/classic-dashboard-light.png'),
+    dark: useBaseUrl('/assets/images/tutorial-loading-data-using-spreadsheets/classic-dashboard-dark.png'),
+  }}
+
+/>
+
+## Load Related Data
+
+Next, let's add a couple of rooms. Download the **Rooms - Create Rooms** sample spreadsheet and add room data to it.
+
+A unique `building` name or the `building_id` is required to add a new room record,  which means that building data needs to be added before room data. Most of the other imports will have logical references like these.
+
+### Upload Order
+
+A good order for uploading objects to Device42 is the following:
+
+* Add Buildings 
+* Add Rooms 
+* Add Vendors 
+* Add Racks 
+* Add Hardware Models 
+* Add Devices 
+* Add Devices to Racks 
+* Add Assets 
+* Add Switches (Devices) 
+* Add VLANs 
+* Add Subnets 
+* Add IP Addresses 
+* Add Application Components
+
+## Next Steps
+
+Next, we encourage you to follow the [Navigating the Device42 User Interface](/getstarted/tutorials/tutorial-navigating-the-device42-user-interface.mdx) tutorial. Browse through the documentation for more detailed information on the various Device42 features.

docs/getstarted/tutorials/tutorial-loading-data-using-the-api.md

@@ -45,4 +45,4 @@ For example, hover over the "2nd Floor" hyperlink, and look at the lower left co
 
 ![wpid3355-media_1375697151375.png](/assets/images/wpid3355-media_1375697151375.png)
 
-We've reached the end of this tutorial. Next, we encourage you to follow the Tutorial [Navigating the device42 User Interface](getstarted/tutorials/tutorial-navigating-the-device42-user-interface.md). We'd also like to encourage you browse through the documentation for more detailed information on the various device42 features.
+We've reached the end of this tutorial. Next, we encourage you to follow the Tutorial [Navigating the device42 User Interface](getstarted/tutorials/tutorial-navigating-the-device42-user-interface.mdx). We'd also like to encourage you browse through the documentation for more detailed information on the various device42 features.