Merge pull request #143 from nautobot/u/whitej6-renaming

Renaming work
nautobot · Jan 8, 2024 · 741034b · 741034b
2 parents ed4c0ce + 9e19d2a
commit 741034b
Show file tree

Hide file tree

Showing 14 changed files with 41 additions and 41 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
@@ -31,5 +31,5 @@
 - [ ] Attached Screenshots, Payload Example
 - [ ] Unit, Integration Tests
 - [ ] Documentation Updates (when adding/changing features)
-- [ ] Example Plugin Updates (when adding/changing features)
+- [ ] Example App Updates (when adding/changing features)
 - [ ] Outline Remaining Work, Constraints from Design
diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
 # Nautobot Device Onboarding
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/nautobot/nautobot-plugin-device-onboarding/develop/docs/images/icon-DeviceOnboarding.png" class="logo" height="200px">
+  <img src="https://raw.githubusercontent.com/nautobot/nautobot-app-device-onboarding/develop/docs/images/icon-DeviceOnboarding.png" class="logo" height="200px">
   <br>
-  <a href="https://github.com/nautobot/nautobot-plugin-device-onboarding/actions"><img src="https://github.com/nautobot/nautobot-plugin-device-onboarding/actions/workflows/ci.yml/badge.svg?branch=develop"></a>
+  <a href="https://github.com/nautobot/nautobot-app-device-onboarding/actions"><img src="https://github.com/nautobot/nautobot-app-device-onboarding/actions/workflows/ci.yml/badge.svg?branch=develop"></a>
   <a href="https://docs.nautobot.com/projects/device-onboarding/"><img src="https://readthedocs.org/projects/nautobot-plugin-device-onboarding/badge/"></a>
   <a href="https://pypi.org/project/nautobot-device-onboarding/"><img src="https://img.shields.io/pypi/v/nautobot-device-onboarding"></a>
   <a href="https://pypi.org/project/nautobot-device-onboarding/"><img src="https://img.shields.io/pypi/dm/nautobot-device-onboarding"></a>
@@ -15,13 +15,13 @@
 
 The `nautobot-device-onboarding` plugin is using the [netmiko](https://github.com/ktbyers/netmiko) and [NAPALM](https://napalm.readthedocs.io/en/latest/) libraries to simplify the onboarding process of a new device into Nautobot down to, in many cases, an *IP Address* and a *Location*. In some cases, the user may also have to specify a specific *Device Platform* and *Device Port*.
 
-Regardless, the Onboarding Plugin greatly simplifies the onboarding process by allowing the user to specify a small amount of info and having the app populate a much larger amount of device data in Nautobot.
+Regardless, the Onboarding App greatly simplifies the onboarding process by allowing the user to specify a small amount of info and having the app populate a much larger amount of device data in Nautobot.
 
 ### Screenshots
 
 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-plugin-device-onboarding/develop/docs/images/do_job_inputs.png)
+![job input](https://raw.githubusercontent.com/nautobot/nautobot-app-device-onboarding/develop/docs/images/do_job_inputs.png)
 
 ## Try it out!
 
@@ -41,7 +41,7 @@ Full web-based HTML documentation for this app can be found over on the [Nautobo
 
 ### Contributing to the Docs
 
-You can find all the Markdown source for the App documentation under the [docs](https://github.com/nautobot/nautobot-plugin-device-onboarding/tree/develop/docs) folder in this repository. For simple edits, a Markdown capable editor is sufficient - clone the repository and edit away.
+You can find all the Markdown source for the App documentation under the [docs](https://github.com/nautobot/nautobot-app-device-onboarding/tree/develop/docs) folder in this repository. For simple edits, a Markdown capable editor is sufficient - clone the repository and edit away.
 
 If you need to view the fully generated documentation site, you can build it with [mkdocs](https://www.mkdocs.org/). A container hosting the docs will be started using the invoke commands (details in the [Development Environment Guide](https://docs.nautobot.com/projects/device-onboarding/en/latest/dev/dev_environment/#docker-development-environment)) on [http://localhost:8001](http://localhost:8001). As your changes are saved, the live docs will be automatically reloaded.
 

diff --git a/docs/admin/release_notes/version_1.1.md b/docs/admin/release_notes/version_1.1.md
@@ -7,19 +7,19 @@ This document describes all new features and changes in `nautobot-device-onboard
 
 ### Added
 
-#### Assign default custom fields values to new objects ([#13](https://github.com/nautobot/nautobot-plugin-device-onboarding/pull/13))
+#### Assign default custom fields values to new objects ([#13](https://github.com/nautobot/nautobot-app-device-onboarding/pull/13))
 
 While new objects are created during onboarding a device, they will inherit model's default custom fields.
 
-#### Documentation updates ([#19](https://github.com/nautobot/nautobot-plugin-device-onboarding/pull/19))
+#### Documentation updates ([#19](https://github.com/nautobot/nautobot-app-device-onboarding/pull/19))
 
 nautobot-device-onboarding now covers onboarding of Cisco Nexus and Arista EOS devices. Documentation was reviewed and updated.
 
 ### Changed
 
-#### Support for Nautobot 1.1.0 (Celery) ([#18](https://github.com/nautobot/nautobot-plugin-device-onboarding/pull/18))
+#### Support for Nautobot 1.1.0 (Celery) ([#18](https://github.com/nautobot/nautobot-app-device-onboarding/pull/18))
 
-Celery has been introduced to eventually replace RQ for executing background tasks within Nautobot. Plugin's usage of RQ has been migrated to use Celery.
+Celery has been introduced to eventually replace RQ for executing background tasks within Nautobot. App's usage of RQ has been migrated to use Celery.
 
 
 ## v1.1.2 (2022-08-01)
@@ -30,15 +30,15 @@ Celery has been introduced to eventually replace RQ for executing background tas
 
 ### Fixed
 
-- [#45](https://github.com/nautobot/nautobot-plugin-device-onboarding/pull/45) - Update Plugin Dependencies. Fix importing issue with Netmiko 4.x, enable Napalm 4.
+- [#45](https://github.com/nautobot/nautobot-app-device-onboarding/pull/45) - Update App Dependencies. Fix importing issue with Netmiko 4.x, enable Napalm 4.
 
 ## v1.1.1 (2021-09-08)
 
 ### Added
 
 ### Changed
 
-- [#23](https://github.com/nautobot/nautobot-plugin-device-onboarding/pull/23) - Label attribute for sorting and identifying OnboaringTasks.
+- [#23](https://github.com/nautobot/nautobot-app-device-onboarding/pull/23) - Label attribute for sorting and identifying OnboaringTasks.
 
 ### Fixed
 
@@ -47,12 +47,12 @@ Celery has been introduced to eventually replace RQ for executing background tas
 
 ### Added
 
-- [#13](https://github.com/nautobot/nautobot-plugin-device-onboarding/pull/13) - Assign default custom fields values to new objects
-- [#18](https://github.com/nautobot/nautobot-plugin-device-onboarding/pull/18) - Support for Nautobot 1.1.0 (Celery)
-- [#19](https://github.com/nautobot/nautobot-plugin-device-onboarding/pull/19) - Documentation updates
+- [#13](https://github.com/nautobot/nautobot-app-device-onboarding/pull/13) - Assign default custom fields values to new objects
+- [#18](https://github.com/nautobot/nautobot-app-device-onboarding/pull/18) - Support for Nautobot 1.1.0 (Celery)
+- [#19](https://github.com/nautobot/nautobot-app-device-onboarding/pull/19) - Documentation updates
 
 ### Changed
 
 ### Fixed
 
-- [#14](https://github.com/nautobot/nautobot-plugin-device-onboarding/issues/14) - Error 'ipv4' when onboarding Juniper device
+- [#14](https://github.com/nautobot/nautobot-app-device-onboarding/issues/14) - Error 'ipv4' when onboarding Juniper device
diff --git a/docs/admin/release_notes/version_1.2.md b/docs/admin/release_notes/version_1.2.md
@@ -11,9 +11,9 @@ This document describes all new features and changes in `nautobot-device-onboard
 
 ### Changed
 
-- [#53](https://github.com/nautobot/nautobot-plugin-device-onboarding/pull/53) - Documentation updates
-- [#87](https://github.com/nautobot/nautobot-plugin-device-onboarding/pull/87) - Add OnboardingTask status and failure reason metrics
+- [#53](https://github.com/nautobot/nautobot-app-device-onboarding/pull/53) - Documentation updates
+- [#87](https://github.com/nautobot/nautobot-app-device-onboarding/pull/87) - Add OnboardingTask status and failure reason metrics
 
 ### Fixed
 
-- [#75](https://github.com/nautobot/nautobot-plugin-device-onboarding/pull/75) - Fix reverse migration for migrations 0002, 0003
+- [#75](https://github.com/nautobot/nautobot-app-device-onboarding/pull/75) - Fix reverse migration for migrations 0002, 0003
diff --git a/docs/admin/release_notes/version_3.0.md b/docs/admin/release_notes/version_3.0.md
@@ -1,28 +1,28 @@
 # v3.0 Release Notes
 
 !!! warning
-    Nautobot Device Onboarding v2.0.0-2.0.2 contains a vulnerability where the credentials used to log into a device may be visible in clear text on the Job Results page under the Additional Data tab. It is recommended to review all OnbaordingTasks from the affected releases, delete any affeccted JobResults, and upgrade to v3.0.0. For more information please see the full write up on the issue which is available as [a security advisory](https://github.com/nautobot/nautobot-plugin-device-onboarding/security/advisories/GHSA-qf3c-rw9f-jh7v) on the repo. Nautobot Device Onboarding app versions v2.0.0-2.0.2 have been removed for PyPI to ensure all gaps are closed. v2.0.3 is published with disabled functionality and banner message encouraging to upgrade to v3.0.0. [CVE-2023-48700](https://www.cve.org/CVERecord?id=CVE-2023-48700) has been issued for this vulnerability.
+    Nautobot Device Onboarding v2.0.0-2.0.2 contains a vulnerability where the credentials used to log into a device may be visible in clear text on the Job Results page under the Additional Data tab. It is recommended to review all OnbaordingTasks from the affected releases, delete any affeccted JobResults, and upgrade to v3.0.0. For more information please see the full write up on the issue which is available as [a security advisory](https://github.com/nautobot/nautobot-app-device-onboarding/security/advisories/GHSA-qf3c-rw9f-jh7v) on the repo. Nautobot Device Onboarding app versions v2.0.0-2.0.2 have been removed for PyPI to ensure all gaps are closed. v2.0.3 is published with disabled functionality and banner message encouraging to upgrade to v3.0.0. [CVE-2023-48700](https://www.cve.org/CVERecord?id=CVE-2023-48700) has been issued for this vulnerability.
 
 ## Release Overview
 
 ## v3.0.1 2023-11-24
 
 ### Fixed
 
-- [#128](https://github.com/nautobot/nautobot-plugin-device-onboarding/issues/128) - Failures when onboarding via IP Address
+- [#128](https://github.com/nautobot/nautobot-app-device-onboarding/issues/128) - Failures when onboarding via IP Address
 
 ## v3.0.0 2023-11-21
 
 ### Changed
 
-- [#124](https://github.com/nautobot/nautobot-plugin-device-onboarding/pull/124) - Device onboarding is now provided via a Nautobot Job.
-- [#124](https://github.com/nautobot/nautobot-plugin-device-onboarding/pull/124) - CSV import has changed to a comma separated list of IPs/FQDNs as a job input
+- [#124](https://github.com/nautobot/nautobot-app-device-onboarding/pull/124) - Device onboarding is now provided via a Nautobot Job.
+- [#124](https://github.com/nautobot/nautobot-app-device-onboarding/pull/124) - CSV import has changed to a comma separated list of IPs/FQDNs as a job input
 
 ### Fixed
 
-- [#124](https://github.com/nautobot/nautobot-plugin-device-onboarding/pull/124) - Leaking of device credentials if username & password were provided on creation of an instance of the `OnboardingTask` object.
+- [#124](https://github.com/nautobot/nautobot-app-device-onboarding/pull/124) - Leaking of device credentials if username & password were provided on creation of an instance of the `OnboardingTask` object.
 
 ### Removed
 
-- [#124](https://github.com/nautobot/nautobot-plugin-device-onboarding/pull/124) - Removed all models, UI Views, and API Views from app
-- [#124](https://github.com/nautobot/nautobot-plugin-device-onboarding/pull/124) - All data for instances of `OnboardingTask` & `OnboardingDevice` will be removed on upgrade, affected `JobResults` from tasks created while on affected versions should be reviewed & deleted.
+- [#124](https://github.com/nautobot/nautobot-app-device-onboarding/pull/124) - Removed all models, UI Views, and API Views from app
+- [#124](https://github.com/nautobot/nautobot-app-device-onboarding/pull/124) - All data for instances of `OnboardingTask` & `OnboardingDevice` will be removed on upgrade, affected `JobResults` from tasks created while on affected versions should be reviewed & deleted.
diff --git a/docs/dev/dev_environment.md b/docs/dev/dev_environment.md
@@ -361,9 +361,9 @@ Once the dependencies are resolved, stop the existing containers, rebuild the Do
 ➜ invoke start
 ```
 
-### Installing Additional Nautobot Plugins
+### Installing Additional Nautobot Apps
 
-Let's say for example you want the new plugin you're creating to integrate into Slack. To do this, you will want to integrate into the existing Nautobot ChatOps Plugin.
+Let's say for example you want the new plugin you're creating to integrate into Slack. To do this, you will want to integrate into the existing Nautobot ChatOps App.
 
 ```bash
 ➜ poetry shell

diff --git a/docs/dev/onboarding_extensions.md b/docs/dev/onboarding_extensions.md
@@ -47,4 +47,4 @@ The `ext_result` attribute allows to collect and store any data while the device
 
 ## Where do I find an example of onboarding extension ?
 
-Please check our example: [example_ios_set_device_role.py](https://github.com/nautobot/nautobot-plugin-device-onboarding/raw/develop/examples/example_ios_set_device_role.py).
+Please check our example: [example_ios_set_device_role.py](https://github.com/nautobot/nautobot-app-device-onboarding/raw/develop/examples/example_ios_set_device_role.py).
diff --git a/docs/user/app_overview.md b/docs/user/app_overview.md
@@ -42,7 +42,7 @@ One example of a solution that can retrieve that additional device data and impo
 
 The Onboarding App is meant for new Nautobot users who want to start importing their devices directly rather than from another, existing, source. Even with other sources for device information, they may not include everything that is necessary.
 
-Existing Nautobot users may want to incorporate the Onboarding Plugin as part of onboarding new devices to the platform.
+Existing Nautobot users may want to incorporate the Onboarding App as part of onboarding new devices to the platform.
 
 ## Authors and Maintainers
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,10 +1,10 @@
 ---
 dev_addr: "127.0.0.1:8001"
-edit_uri: "edit/main/nautobot-plugin-device-onboarding/docs"
+edit_uri: "edit/main/nautobot-app-device-onboarding/docs"
 site_dir: "nautobot_device_onboarding/static/nautobot_device_onboarding/docs"
 site_name: "Device Onboarding Documentation"
 site_url: "https://docs.nautobot.com/projects/device-onboarding/en/latest/"
-repo_url: "https://github.com/nautobot/nautobot-plugin-device-onboarding"
+repo_url: "https://github.com/nautobot/nautobot-app-device-onboarding"
 copyright: "Copyright &copy; The Authors"
 theme:
   name: "material"

diff --git a/nautobot_device_onboarding/__init__.py b/nautobot_device_onboarding/__init__.py
@@ -1,4 +1,4 @@
-"""Plugin declaration for nautobot_device_onboarding."""
+"""App declaration for nautobot_device_onboarding."""
 # Metadata is inherited from Nautobot. If not including Nautobot in the environment, this should be added
 from importlib import metadata
 
@@ -8,7 +8,7 @@
 
 
 class NautobotDeviceOnboardingConfig(NautobotAppConfig):
-    """Plugin configuration for the nautobot_device_onboarding plugin."""
+    """App configuration for the nautobot_device_onboarding app."""
 
     name = "nautobot_device_onboarding"
     verbose_name = "Device Onboarding"

diff --git a/nautobot_device_onboarding/constants.py b/nautobot_device_onboarding/constants.py
@@ -1,4 +1,4 @@
-"""Constants for nautobot_device_onboarding plugin."""
+"""Constants for nautobot_device_onboarding app."""
 
 NETMIKO_TO_NAPALM_STATIC = {
     "cisco_ios": "ios",

diff --git a/nautobot_device_onboarding/tests/__init__.py b/nautobot_device_onboarding/tests/__init__.py
@@ -1 +1 @@
-"""Unit tests for nautobot_device_onboarding plugin."""
+"""Unit tests for nautobot_device_onboarding app."""
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,13 +1,13 @@
 [tool.poetry]
 name = "nautobot-device-onboarding"
 version = "3.0.1"
-description = "A plugin for Nautobot to easily onboard new devices."
+description = "A app for Nautobot to easily onboard new devices."
 authors = ["Network to Code, LLC <info@networktocode.com>"]
 license = "Apache-2.0"
 readme = "README.md"
-homepage = "https://github.com/nautobot/nautobot-plugin-device-onboarding"
-repository = "https://github.com/nautobot/nautobot-plugin-device-onboarding"
-keywords = ["nautobot", "nautobot-plugin"]
+homepage = "https://github.com/nautobot/nautobot-app-device-onboarding"
+repository = "https://github.com/nautobot/nautobot-app-device-onboarding"
+keywords = ["nautobot", "nautobot-plugin", "nautobot-app"]
 classifiers = [
     "Intended Audience :: Developers",
     "Development Status :: 5 - Production/Stable",

diff --git a/tasks.py b/tasks.py
@@ -671,7 +671,7 @@ def unittest_coverage(context):
     }
 )
 def tests(context, failfast=False, keepdb=False, lint_only=False):
-    """Run all tests for this plugin."""
+    """Run all tests for this app."""
     # If we are not running locally, start the docker containers so we don't have to for each test
     if not is_truthy(context.nautobot_device_onboarding.local):
         print("Starting Docker Containers...")