diff --git a/README.md b/README.md index ce5d375c..732d1625 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,16 @@ Regardless, the Onboarding App greatly simplifies the onboarding process by allo Device Onboarding is a Job that allows you to provide a few required pieces of information and onboard the device. -![job input](https://raw.githubusercontent.com/nautobot/nautobot-app-device-onboarding/develop/docs/images/sync_devices_inputs.png) +As Job data and Job execution will be same for both Manual Input and CSV Input. + +Manual Input: + +![job input](https://raw.githubusercontent.com/nautobot/nautobot-app-device-onboarding/develop/docs/images/manual_input_dark.png) + +CSV Input: + +![job input](https://raw.githubusercontent.com/nautobot/nautobot-app-device-onboarding/develop/docs/images/csv_input_dark.png) + ## Try it out! diff --git a/changes/472.documentation b/changes/472.documentation new file mode 100644 index 00000000..05135590 --- /dev/null +++ b/changes/472.documentation @@ -0,0 +1 @@ +Updated Device onboarding documentation to include 3.0 screenshots. \ No newline at end of file diff --git a/docs/images/csv_input_dark.png b/docs/images/csv_input_dark.png new file mode 100644 index 00000000..366d8653 Binary files /dev/null and b/docs/images/csv_input_dark.png differ diff --git a/docs/images/csv_input_light.png b/docs/images/csv_input_light.png new file mode 100644 index 00000000..2076b746 Binary files /dev/null and b/docs/images/csv_input_light.png differ diff --git a/docs/images/manual_input_dark.png b/docs/images/manual_input_dark.png new file mode 100644 index 00000000..17e9005b Binary files /dev/null and b/docs/images/manual_input_dark.png differ diff --git a/docs/images/manual_input_light.png b/docs/images/manual_input_light.png new file mode 100644 index 00000000..effc39ce Binary files /dev/null and b/docs/images/manual_input_light.png differ diff --git a/docs/images/platform_cisco_ios.png b/docs/images/platform_cisco_ios.png deleted file mode 100644 index b27d743f..00000000 Binary files a/docs/images/platform_cisco_ios.png and /dev/null differ diff --git a/docs/images/platform_cisco_ios_dark.png b/docs/images/platform_cisco_ios_dark.png new file mode 100644 index 00000000..fed7f3b7 Binary files /dev/null and b/docs/images/platform_cisco_ios_dark.png differ diff --git a/docs/images/platform_cisco_ios_light.png b/docs/images/platform_cisco_ios_light.png new file mode 100644 index 00000000..69b660e0 Binary files /dev/null and b/docs/images/platform_cisco_ios_light.png differ diff --git a/docs/images/platform_juniper_junos.png b/docs/images/platform_juniper_junos.png deleted file mode 100644 index badf5ce0..00000000 Binary files a/docs/images/platform_juniper_junos.png and /dev/null differ diff --git a/docs/images/platform_juniper_junos_dark.png b/docs/images/platform_juniper_junos_dark.png new file mode 100644 index 00000000..85fc749b Binary files /dev/null and b/docs/images/platform_juniper_junos_dark.png differ diff --git a/docs/images/platform_juniper_junos_light.png b/docs/images/platform_juniper_junos_light.png new file mode 100644 index 00000000..17065111 Binary files /dev/null and b/docs/images/platform_juniper_junos_light.png differ diff --git a/docs/images/sync_devices_inputs.png b/docs/images/sync_devices_inputs.png deleted file mode 100644 index 628e069c..00000000 Binary files a/docs/images/sync_devices_inputs.png and /dev/null differ diff --git a/docs/images/sync_network_data_inputs.png b/docs/images/sync_network_data_inputs.png deleted file mode 100755 index d2fc841d..00000000 Binary files a/docs/images/sync_network_data_inputs.png and /dev/null differ diff --git a/docs/user/app_getting_started.md b/docs/user/app_getting_started.md index 30c81cef..1f4fce56 100644 --- a/docs/user/app_getting_started.md +++ b/docs/user/app_getting_started.md @@ -74,7 +74,17 @@ Navigate to the Device Onboarding Job: Jobs > Perform Device Onboarding (origina ## What are the next steps? You can check out the [Use Cases](app_use_cases.md) section for more examples or try out the job inputs with at least the required fields. + +As Job data and Job execution will be same for both Manual Input and CSV Input. -![job input](../images/sync_devices_inputs.png) +Manual Input: + +![job input](../images/manual_input_light.png#only-light){ .on-glb } +![job input](../images/manual_input_dark.png#only-dark){ .on-glb } + +CSV Input: + +![job input](../images/csv_input_light.png#only-light){ .on-glb } +![job input](../images/csv_input_dark.png#only-dark){ .on-glb } The Nautobot job will pass the job execution to the worker which will initiate an onboarding and will reach out to the device and attempt to onboard it. diff --git a/docs/user/app_use_cases.md b/docs/user/app_use_cases.md index f664cb95..9f5b2fe3 100755 --- a/docs/user/app_use_cases.md +++ b/docs/user/app_use_cases.md @@ -40,8 +40,11 @@ For the platforms where SSH auto-detection does not work, the user will need to: The Onboarding App will automatically create Platforms for vendor operating systems where platform auto-detection works. The picture below shows the details of auto-created Platforms for `cisco_ios` and `juniper_junos`. -![cisco_ios_platform](../images/platform_cisco_ios.png) -![juniper_junos_platform](../images/platform_juniper_junos.png) +![cisco_ios_platform](../images/platform_cisco_ios_light.png#only-light){ .on-glb } +![cisco_ios_platform](../images/platform_cisco_ios_dark.png#only-dark){ .on-glb } + +![juniper_junos_platform](../images/platform_juniper_junos_light.png#only-light){ .on-glb } +![juniper_junos_platform](../images/platform_juniper_junos_dark.png#only-dark){ .on-glb } ### Passing Custom Nornir Connection Options diff --git a/docs/user/app_use_cases_original.md b/docs/user/app_use_cases_original.md index d1acc406..f82e156c 100644 --- a/docs/user/app_use_cases_original.md +++ b/docs/user/app_use_cases_original.md @@ -51,9 +51,11 @@ For the platforms where SSH auto-detection does not work, the user will need to: The Onboarding App will automatically create Platforms for vendor operating systems where platform auto-detection works. The picture below shows the details of auto-created Platforms for `cisco_ios` and `juniper_junos`. -![cisco_ios_platform](../images/platform_cisco_ios.png) -![juniper_junos_platform](../images/platform_juniper_junos.png) +![cisco_ios_platform](../images/platform_cisco_ios_light.png#only-light){ .on-glb } +![cisco_ios_platform](../images/platform_cisco_ios_dark.png#only-dark){ .on-glb } +![juniper_junos_platform](../images/platform_juniper_junos_light.png#only-light){ .on-glb } +![juniper_junos_platform](../images/platform_juniper_junos_dark.png#only-dark){ .on-glb } ## Use-cases and common workflows