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

Renaming work

.cookiecutter.json

@@ -4,16 +4,16 @@
         "full_name": "Network to Code, LLC",
         "email": "opensource@networktocode.com",
         "github_org": "nautobot",
-        "plugin_name": "nautobot_circuit_maintenance",
+        "app_name": "nautobot_circuit_maintenance",
         "verbose_name": "Circuit Maintenance",
-        "plugin_slug": "nautobot-circuit-maintenance",
-        "project_slug": "nautobot-plugin-circuit-maintenance",
-        "repo_url": "https://github.com/nautobot/nautobot-plugin-circuit-maintenance",
+        "app_slug": "nautobot-circuit-maintenance",
+        "project_slug": "nautobot-app-circuit-maintenance",
+        "repo_url": "https://github.com/nautobot/nautobot-app-circuit-maintenance",
         "base_url": "circuit-maintenance",
         "min_nautobot_version": "2.0.0",
         "max_nautobot_version": "2.9999",
         "camel_name": "NautobotCircuitMaintenance",
-        "project_short_description": "Nautobot plugin to automatically handle Circuit Maintenances Notifications",
+        "project_short_description": "Nautobot app to automatically handle Circuit Maintenances Notifications",
         "model_class_name": "None",
         "open_source_license": "Apache-2.0",
         "docs_base_url": "https://docs.nautobot.com",
@@ -33,3 +33,4 @@
         }
     }
 }
+

.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

CHANGELOG.md

@@ -1,5 +1,5 @@
 <!-- markdownlint-disable MD024 -->
 
-# Changelog - Nautobot Plugin Circuit Maintenance
+# Changelog - Nautobot App Circuit Maintenance
 
 The changelog is located on the [project release notes](https://docs.nautobot.com/projects/circuit-maintenance/en/latest/admin/release_notes/).

README.md

@@ -1,9 +1,9 @@
 # Circuit Maintenance
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/nautobot/nautobot-plugin-circuit-maintenance/develop/docs/images/icon-nautobot-circuit-maintenance.png" class="logo" height="200px">
+  <img src="https://raw.githubusercontent.com/nautobot/nautobot-app-circuit-maintenance/develop/docs/images/icon-nautobot-circuit-maintenance.png" class="logo" height="200px">
   <br>
-  <a href="https://github.com/nautobot/nautobot-plugin-circuit-maintenance/actions"><img src="https://github.com/nautobot/nautobot-plugin-circuit-maintenance/actions/workflows/ci.yml/badge.svg?branch=main"></a>
+  <a href="https://github.com/nautobot/nautobot-app-circuit-maintenance/actions"><img src="https://github.com/nautobot/nautobot-app-circuit-maintenance/actions/workflows/ci.yml/badge.svg?branch=main"></a>
   <a href="https://docs.nautobot.com/projects/circuit-maintenance/en/latest"><img src="https://readthedocs.org/projects/nautobot-plugin-circuit-maintenance/badge/"></a>
   <a href="https://pypi.org/project/nautobot-circuit-maintenance/"><img src="https://img.shields.io/pypi/v/nautobot-circuit-maintenance"></a>
   <a href="https://pypi.org/project/nautobot-circuit-maintenance/"><img src="https://img.shields.io/pypi/dm/nautobot-circuit-maintenance"></a>
@@ -13,19 +13,19 @@
 
 ## Overview
 
-A plugin for [Nautobot](https://github.com/nautobot/nautobot) to easily handle Circuit Maintenances related to Nautobot Circuits.
+A app for [Nautobot](https://github.com/nautobot/nautobot) to easily handle Circuit Maintenances related to Nautobot Circuits.
 
 `nautobot-circuit-maintenance` lets you handle maintenances for your Circuits based on notifications received via email by leveraging [circuit-maintenance-parser](https://github.com/networktocode/circuit-maintenance-parser), a notifications parser library for multiple network service providers that exposes structured data following a recommendation defined in this [draft NANOG BCOP](https://github.com/jda/maintnote-std/blob/master/standard.md).
 
 ### Screenshots
 
-More screenshots can be found in the [Using the App](https://docs.nautobot.com/projects/circuit-maintenance/en/latest/user/app_use_cases/) page in the documentation. Here's a quick overview of some of the plugin's added functionality:
+More screenshots can be found in the [Using the App](https://docs.nautobot.com/projects/circuit-maintenance/en/latest/user/app_use_cases/) page in the documentation. Here's a quick overview of some of the app's added functionality:
 
-![Circuit Maintenance Dashboard](https://raw.githubusercontent.com/nautobot/nautobot-plugin-circuit-maintenance/develop/docs/images/dashboard.png)
+![Circuit Maintenance Dashboard](https://raw.githubusercontent.com/nautobot/nautobot-app-circuit-maintenance/develop/docs/images/dashboard.png)
 
-![Example Circuit Maintenance View](https://raw.githubusercontent.com/nautobot/nautobot-plugin-circuit-maintenance/develop/docs/images/circuit_maintenance.png)
+![Example Circuit Maintenance View](https://raw.githubusercontent.com/nautobot/nautobot-app-circuit-maintenance/develop/docs/images/circuit_maintenance.png)
 
-![Example Raw Notifications View](https://raw.githubusercontent.com/nautobot/nautobot-plugin-circuit-maintenance/develop/docs/images/circuit_notifications.png)
+![Example Raw Notifications View](https://raw.githubusercontent.com/nautobot/nautobot-app-circuit-maintenance/develop/docs/images/circuit_notifications.png)
 
 
 ## Try it out!
@@ -46,7 +46,7 @@ Full documentation for this App can be found over on the [Nautobot Docs](https:/
 
 ### Contributing to the Documentation
 
-You can find all the Markdown source for the App documentation under the [`docs`](https://github.com/nautobot/nautobot-plugin-circuit-maintenance/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-circuit-maintenance/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 documentation can be started using the `invoke` commands (details in the [Development Environment Guide](https://docs.nautobot.com/projects/circuit-maintenance/en/latest/dev/dev_environment/#docker-development-environment)) on [http://localhost:8001](http://localhost:8001). Using this container, as your changes to the documentation are saved, they will be automatically rebuilt and any pages currently being viewed will be reloaded in your browser.
 

development/towncrier_template.j2

@@ -1,5 +1,5 @@
 {% if render_title %}
-## [v{{ versiondata.version }} ({{ versiondata.date }})](https://github.com/nautobot/nautobot-plugin-circuit-maintenance/releases/tag/v{{ versiondata.version}})
+## [v{{ versiondata.version }} ({{ versiondata.date }})](https://github.com/nautobot/nautobot-app-circuit-maintenance/releases/tag/v{{ versiondata.version}})
 
 {% endif %}
 {% for section, _ in sections.items() %}

docs/admin/install.md

@@ -4,7 +4,7 @@ Here you will find detailed instructions on how to **install** and **configure**
 
 ## Prerequisites
 
-- The plugin is compatible with Nautobot 2.0.0 and higher.
+- The app is compatible with Nautobot 2.0.0 and higher.
 - Databases supported: PostgreSQL, MySQL
 
 !!! note
@@ -17,9 +17,9 @@ You will need access to an email account that receives provider maintenance noti
 ## Install Guide
 
 !!! note
-Plugins can be installed manually or using Python's `pip`. See the [nautobot documentation](https://docs.nautobot.com/projects/core/en/stable/plugins/#install-the-package) for more details. The pip package name for this plugin is [`nautobot-circuit-maintenance`](https://pypi.org/project/nautobot-circuit-maintenance/).
+Apps can be installed manually or using Python's `pip`. See the [nautobot documentation](https://docs.nautobot.com/projects/core/en/stable/plugins/#install-the-package) for more details. The pip package name for this app is [`nautobot-circuit-maintenance`](https://pypi.org/project/nautobot-circuit-maintenance/).
 
-The plugin is available as a Python package via PyPI and can be installed with `pip`:
+The app is available as a Python package via PyPI and can be installed with `pip`:
 
 ```shell
 pip install nautobot-circuit-maintenance
@@ -31,7 +31,7 @@ To ensure Circuit Maintenance is automatically re-installed during future upgrad
 echo nautobot-circuit-maintenance >> local_requirements.txt
 ```
 
-Once installed, the plugin needs to be enabled in your Nautobot configuration. The following block of code below shows the additional configuration required to be added to your `nautobot_config.py` file:
+Once installed, the app needs to be enabled in your Nautobot configuration. The following block of code below shows the additional configuration required to be added to your `nautobot_config.py` file:
 
 - Append `"nautobot_circuit_maintenance"` to the `PLUGINS` list.
 - Append the `"nautobot_circuit_maintenance"` dictionary to the `PLUGINS_CONFIG` dictionary and override any defaults.
@@ -73,9 +73,9 @@ sudo systemctl restart nautobot nautobot-worker nautobot-scheduler
 
 ## App Configuration
 
-The plugin behavior can be controlled with the following list of settings:
+The app behavior can be controlled with the following list of settings:
 
-- `raw_notification_initial_days_since`: define how many days back the plugin will check for `RawNotification`s for each `NotificationSource`, in order to limit the number of notifications to be processed on the first run of the plugin. In subsequent runs, the last notification date will be used as the reference to limit. If not defined, it defaults to **7 days**.
+- `raw_notification_initial_days_since`: define how many days back the app will check for `RawNotification`s for each `NotificationSource`, in order to limit the number of notifications to be processed on the first run of the app. In subsequent runs, the last notification date will be used as the reference to limit. If not defined, it defaults to **7 days**.
 - `raw_notification_size`: define how many bytes from a notification will be stored in the database to not store too big objects (maximum allowed is **16384** bytes). If not defined, it defaults to **8192** bytes.
 
 The `notification_sources` have custom definition depending on the `Source` type, and are defined in the [General Usage](../user/app_use_cases.md#general-usage) section.