nautobot 2.4.2__py3-none-any.whl → 2.4.4__py3-none-any.whl

nautobot/project-static/docs/development/apps/migration/from-v1.html

@@ -9204,14 +9204,14 @@
 <li>Steps to Migrate an App from V1<ul>
 <li>Preliminary Steps:<ul>
 <li>Add <a href="https://github.com/nautobot/pylint-nautobot"><code>pylint-nautobot</code></a> as a development dependency</li>
-<li>Run <code>pylint -v --disable=all --enable=nautobot-code-location-changes,nautobot-replaced-models *</code> in order to parse your development environment for changes that need to be fixed before pylint-django can successfully run.</li>
+<li>Run <code>pylint -v --disable=all --enable=nautobot-code-location-changes,nautobot-replaced-models *</code> in order to parse your development environment for changes that need to be fixed before <code>pylint-django</code> can successfully run.</li>
 <li>Specific steps to install and run <code>pylint-nautobot</code> in your development environment is available <a href="https://docs.nautobot.com/projects/pylint-nautobot/en/latest/getting_started/">here</a></li>
 </ul>
 </li>
 <li><a href="dependency-updates.html">Dependency Updates</a><ul>
 <li><a href="dependency-updates.html#nautobot-version">Nautobot Version</a></li>
 <li><a href="dependency-updates.html#python-version">Python Version</a></li>
-<li><a href="dependency-updates.html#pylint-nautobot">pylint-nautobot</a></li>
+<li><a href="dependency-updates.html#pylint-nautobot"><code>pylint-nautobot</code></a></li>
 </ul>
 </li>
 <li><a href="code-updates.html">Code Updates</a><ul>
@@ -9220,7 +9220,7 @@
 <li><a href="code-updates.html#remove-tagtags-filter-from-filterset-definitions">Remove Tag/Tags Filter Field from FilterSet Definitions</a></li>
 <li><a href="code-updates.html#replace-djangofilterbackend-with-nautobotfilterbackend">Replace DjangoFilterBackend with NautobotFilterBackend</a></li>
 <li><a href="code-updates.html#app-model-serializer-inheritance">App Model Serializer Inheritance</a></li>
-<li><a href="code-updates.html#revamp-rest-api-serializers">Revamp Rest API Serializers</a></li>
+<li><a href="code-updates.html#revamp-rest-api-serializers">Revamp REST API Serializers</a></li>
 <li><a href="code-updates.html#revamp-csv-import-and-export">Revamp CSV Import and Export</a></li>
 </ul>
 </li>

nautobot/project-static/docs/development/core/application-registry.html

@@ -9370,9 +9370,6 @@
 </code></pre></div>
 <p>Apps may extend this dictionary with additional data sources and/or data types by calling <code>extras.registry.register_datasource_contents()</code> as desired.</p>
 <h3 id="homepage_layout"><code>homepage_layout</code><a class="headerlink" href="#homepage_layout" title="Permanent link">&para;</a></h3>
-<details class="version-added">
-<summary>Added in version 1.2.0</summary>
-</details>
 <p>A dictionary holding information about the layout of Nautobot's homepage. Each app may register homepage panels and items using objects from the generic app class. Each object has a weight attribute allowing the developer to define the position of the object.</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="p">{</span>
 <a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>    <span class="s2">&quot;panels&quot;</span><span class="p">:</span> <span class="p">{</span>
@@ -9445,9 +9442,6 @@
 </code></pre></div>
 <p>For more information visit <a href="model-features.html">model-features</a>.</p>
 <h3 id="nav_menu"><code>nav_menu</code><a class="headerlink" href="#nav_menu" title="Permanent link">&para;</a></h3>
-<details class="version-added">
-<summary>Added in version 1.1.0</summary>
-</details>
 <p>Navigation menu items provided by Nautobot applications. Each app may register its navbar configuration inside of the <code>nav_menu</code> dictionary using <code>navigation.py</code>. Tabs are stored in the top level moving down to groups, items and buttons. Tabs, groups and items can be modified by using the key values inside other core applications and Apps. The <code>nav_menu</code> dict should never be modified directly.</p>
 <p>Example:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="p">{</span>

nautobot/project-static/docs/development/core/best-practices.html

@@ -8333,15 +8333,6 @@
       </ul>
     </nav>
   
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#using-nautobotuiviewset-for-app-development" class="md-nav__link">
-    <span class="md-ellipsis">
-      Using NautobotUIViewSet for App Development
-    </span>
-  </a>
-  
 </li>
       
     </ul>
@@ -9578,15 +9569,6 @@
       </ul>
     </nav>
   
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#using-nautobotuiviewset-for-app-development" class="md-nav__link">
-    <span class="md-ellipsis">
-      Using NautobotUIViewSet for App Development
-    </span>
-  </a>
-  
 </li>
       
     </ul>
@@ -9761,10 +9743,6 @@ For most purposes, this is not the case you are intending to check!</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="kn">from</span> <span class="nn">nautobot.core.utils.lookup</span> <span class="kn">import</span> <span class="n">get_route_for_model</span>
 </code></pre></div>
 <p>This utility function supports both UI and API views for both Nautobot core apps and Nautobot Apps.</p>
-<details class="version-added">
-<summary>Added in version 1.4.3</summary>
-<p>Support for generating API routes was added to <code>get_route_for_model()</code> by passing the argument <code>api=True</code>.</p>
-</details>
 <h3 id="ui-routes">UI Routes<a class="headerlink" href="#ui-routes" title="Permanent link">&para;</a></h3>
 <p>Instead of:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="n">route</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">model</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">app_label</span><span class="si">}</span><span class="s2">:</span><span class="si">{</span><span class="n">model</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">model_name</span><span class="si">}</span><span class="s2">_list&quot;</span>
@@ -9993,7 +9971,7 @@ For most purposes, this is not the case you are intending to check!</p>
 <a id="__codelineno-22-11" name="__codelineno-22-11" href="#__codelineno-22-11"></a>        <span class="nb">breakpoint</span><span class="p">()</span>  <span class="c1"># This was added to illustrate debugging with pdb below</span>
 <a id="__codelineno-22-12" name="__codelineno-22-12" href="#__codelineno-22-12"></a>        <span class="k">return</span> <span class="n">queryset</span><span class="o">.</span><span class="n">exclude</span><span class="p">(</span><span class="n">frontports__isnull</span><span class="o">=</span><span class="n">value</span><span class="p">,</span> <span class="n">rearports__isnull</span><span class="o">=</span><span class="n">value</span><span class="p">)</span>
 </code></pre></div>
-<p>The default <code>lookup_expr</code> unless otherwise specified is “exact”, as seen in <a href="https://github.com/carltongibson/django-filter/blob/main/django_filters/conf.py#L10">django_filters.conf</a>:</p>
+<p>The default <code>lookup_expr</code> unless otherwise specified is “exact”, as seen in the <a href="https://github.com/carltongibson/django-filter/blob/main/django_filters/conf.py#L10"><code>django_filters.conf</code></a> module:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-23-1" name="__codelineno-23-1" href="#__codelineno-23-1"></a>  <span class="s1">&#39;DEFAULT_LOOKUP_EXPR&#39;</span><span class="p">:</span> <span class="s1">&#39;exact&#39;</span><span class="p">,</span>
 </code></pre></div>
 <p>When this method is called, the internal state is default, making reverse introspection impossible, because the <code>lookup_expr</code> is defaulting to “exact”:</p>
@@ -10054,11 +10032,6 @@ For most purposes, this is not the case you are intending to check!</p>
 <li>For exceptions such as <code>DeviceFilterSet.has_primary_ip</code> where it checks for both <code>Device.primary_ip4</code> OR <code>Device.primary_ip6</code>, method filters may still be necessary, however, they would be <strong>the exception and not the norm.</strong></li>
 <li>The good news is that in the core there are not that many of these filter methods defined, but we also don’t want to see them continue to proliferate.</li>
 </ul>
-<h2 id="using-nautobotuiviewset-for-app-development">Using NautobotUIViewSet for App Development<a class="headerlink" href="#using-nautobotuiviewset-for-app-development" title="Permanent link">&para;</a></h2>
-<details class="version-added">
-<summary>Added in version 1.4.0</summary>
-<p>Using <code>NautobotUIViewSet</code> for <a href="../apps/api/views/nautobotuiviewset.html">App development</a> is strongly recommended.</p>
-</details>
 
 
 

nautobot/project-static/docs/development/core/bootstrap-ui.html

@@ -9213,7 +9213,7 @@
 
 <h1 id="developing-the-bootstrap-3-ui">Developing the Bootstrap 3 UI<a class="headerlink" href="#developing-the-bootstrap-3-ui" title="Permanent link">&para;</a></h1>
 <h2 id="introduction">Introduction<a class="headerlink" href="#introduction" title="Permanent link">&para;</a></h2>
-<p>Nautobot's current primary UI is based on <a href="https://getbootstrap.com/docs/3.4/">Bootstrap 3</a>. Since Nautobot 2.1.0, this UI has used a Nautobot-specific custom Bootstrap theme built in the <a href="https://github.com/nautobot/nautobot-bootstrap/">nautobot-bootstrap</a> GitHub repository and then customized further in the main <a href="https://github.com/nautobot/nautobot/">nautobot</a> GitHub repository.</p>
+<p>Nautobot's current primary UI is based on <a href="https://getbootstrap.com/docs/3.4/">Bootstrap 3</a>. Since Nautobot 2.1.0, this UI has used a Nautobot-specific custom Bootstrap theme built in the <a href="https://github.com/nautobot/nautobot-bootstrap/"><code>nautobot-bootstrap</code></a> GitHub repository and then customized further in the main <a href="https://github.com/nautobot/nautobot/"><code>nautobot</code></a> GitHub repository.</p>
 <h2 id="theme-files">Theme Files<a class="headerlink" href="#theme-files" title="Permanent link">&para;</a></h2>
 <ul>
 <li><code>nautobot/project-static/bootstrap-3.4.1-dist/css/</code> - the base Nautobot-themed Bootstrap CSS definitions, directly as compiled from <code>nautobot-bootstrap</code>. <em>These should never be edited manually, only recompiled from <code>nautobot-bootstrap</code> and copied as-is into <code>nautobot</code>.</em></li>

nautobot/project-static/docs/development/core/docker-compose-advanced-use-cases.html

@@ -8208,6 +8208,30 @@
     </span>
   </a>
   
+    <nav class="md-nav" aria-label="Remote Debugging Configuration">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#running-inside-the-nautobot-workspace" class="md-nav__link">
+    <span class="md-ellipsis">
+      Running inside the Nautobot workspace
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#adding-nautobot-folder-to-an-existing-workspace" class="md-nav__link">
+    <span class="md-ellipsis">
+      Adding Nautobot folder to an existing workspace
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
         
       </ul>
@@ -9450,6 +9474,30 @@
     </span>
   </a>
   
+    <nav class="md-nav" aria-label="Remote Debugging Configuration">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#running-inside-the-nautobot-workspace" class="md-nav__link">
+    <span class="md-ellipsis">
+      Running inside the Nautobot workspace
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#adding-nautobot-folder-to-an-existing-workspace" class="md-nav__link">
+    <span class="md-ellipsis">
+      Adding Nautobot folder to an existing workspace
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
         
       </ul>
@@ -9486,6 +9534,7 @@
 <li><code>compose_dir</code>: the full path to the directory containing the Docker Compose YAML files (default: <code>"&lt;nautobot source directory&gt;/development"</code>)</li>
 <li><code>compose_files</code>: the Docker Compose YAML file(s) to use (default: <code>["docker-compose.yml", "docker-compose.postgres.yml", "docker-compose.dev.yml"]</code>)</li>
 <li><code>docker_image_names_main</code> and <code>docker_image_names_develop</code>: Used when <a href="release-checklist.html#publish-docker-images">building Docker images for publication</a>; you shouldn't generally need to change these.</li>
+<li><code>ephemeral_ports</code>: Setting this value to <code>True</code> will make all Nautobot containers with published ports expose themselves with dynamic ports. This is useful when running multiple Nautobot versions at the same time on the same machine so you won't experience system port conflicts.</li>
 </ul>
 <p>These setting may be overridden several different ways (from highest to lowest precedence):</p>
 <ul>
@@ -9580,11 +9629,11 @@
 <p>Once all steps are completed Nautobot should now have the <code>Continue to SSO</code> button on the login screen and should immediately redirect the user to sign in with Keycloak.</p>
 <h4 id="keycloak-login-credentials">Keycloak Login Credentials<a class="headerlink" href="#keycloak-login-credentials" title="Permanent link">&para;</a></h4>
 <p>Keycloak admin console is reachable via <code>http://localhost:8087/admin/</code> with user <code>admin</code> and password <code>admin</code>. The below users are pre-configured within Keycloak, at this time their permissions are not directly mapped to any permissions provided by default by Nautobot. This will be a later enhancement to the local development environment.</p>
-<p>| Username         | Password  |
-+------------------+-----------+
-| nautobot_unpriv  | unpriv123 |
-| nautobot_admin   | admin123  |
-| nautobot_auditor | audit123  |</p>
+<p>| Username           | Password    |
++--------------------+-------------+
+| <code>nautobot_unpriv</code>  | <code>unpriv123</code> |
+| <code>nautobot_admin</code>   | <code>admin123</code>  |
+| <code>nautobot_auditor</code> | <code>audit123</code>  |</p>
 <h2 id="microsoft-visual-studio-code-integration">Microsoft Visual Studio Code Integration<a class="headerlink" href="#microsoft-visual-studio-code-integration" title="Permanent link">&para;</a></h2>
 <p>For users of Microsoft Visual Studio Code, several files are included to ease development and integrate with the <a href="https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers">VS Code Remote - Containers extension</a>. The following related files are found relative to the root of the project:</p>
 <ul>
@@ -9596,7 +9645,7 @@
 <details class="version-changed">
 <summary>Changed in version 2.1.2</summary>
 </details>
-<h4 id="python_ver-environment-variable">PYTHON_VER Environment Variable<a class="headerlink" href="#python_ver-environment-variable" title="Permanent link">&para;</a></h4>
+<h4 id="python_ver-environment-variable"><code>PYTHON_VER</code> Environment Variable<a class="headerlink" href="#python_ver-environment-variable" title="Permanent link">&para;</a></h4>
 <p>The <code>PYTHON_VER</code> environment variable must be set in the <code>development/.env</code> file or the container build will fail.</p>
 <p>You can run <code>invoke</code> with the <code>vscode</code> target to generate this file and re-open the VSCode session under the workspace.</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>invoke<span class="w"> </span>vscode
@@ -9621,8 +9670,13 @@
 <li>As a last step open the folder <code>/opt/nautobot</code> in VS Code.</li>
 </ul>
 <h3 id="remote-debugging-configuration">Remote Debugging Configuration<a class="headerlink" href="#remote-debugging-configuration" title="Permanent link">&para;</a></h3>
-<p>Using the Remote-Attach functionality of VS Code debugger is an alternative to debugging in a development container. This allows a local VS Code instance to connect to a remote container and debug the code running in the container the same way as when debugging locally.</p>
-<p>Follow the steps below to configure VS Code to debug Nautobot and Celery Worker running in a remote container:</p>
+<p>Using the <a href="https://code.visualstudio.com/docs/python/debugging#_debugging-by-attaching-over-a-network-connection">Remote-Attach functionality of VS Code</a> debugger is an alternative to debugging in a development container. This allows a local VS Code instance to connect to a remote container and debug the code running in the container the same way as when debugging locally. To learn more about debugging in VSCode, please <a href="https://code.visualstudio.com/docs/editor/debugging">follow the official docs</a>.</p>
+<p>Follow either of the options below to configure VS Code to debug Nautobot and Celery Worker running in a remote container:</p>
+<h4 id="running-inside-the-nautobot-workspace">Running inside the Nautobot workspace<a class="headerlink" href="#running-inside-the-nautobot-workspace" title="Permanent link">&para;</a></h4>
+<p>If you have opened the project via the workspace file <code>nautobot.code-workspace</code> then there are two debug configurations for remote debugging available. These can be run via one of the debug tasks:
+- <code>Python: Nautobot (Remote)</code> or
+- <code>Python: Nautobot-Celery (Remote)</code></p>
+<h4 id="adding-nautobot-folder-to-an-existing-workspace">Adding Nautobot folder to an existing workspace<a class="headerlink" href="#adding-nautobot-folder-to-an-existing-workspace" title="Permanent link">&para;</a></h4>
 <ol>
 <li>
 <p><strong>Configure <code>invoke.yml</code> to use the <code>docker-compose.vscode-rdb.yml</code> file.</strong></p>
@@ -9643,7 +9697,7 @@
 <p><strong>VS Code debug configuration.</strong></p>
 <p>If you have opened the workspace file <code>nautobot.code-workspace</code> then there are two debug
 configurations for remote debugging already available.</p>
-<p>If you add nautobot to an existing VS Code workspace (Menu: <em>File &gt; Add Folder to Workspace...</em>)
+<p>If you add <code>nautobot</code> to an existing VS Code workspace (Menu: <em>File &gt; Add Folder to Workspace...</em>)
 then copy the <code>launch:</code> values to the <code>.vscode/launch.json</code> file.</p>
 <ul>
 <li>Debug Configurations for Remote Debugging:</li>
@@ -9662,10 +9716,10 @@ then copy the <code>launch:</code> values to the <code>.vscode/launch.json</code
 <a id="__codelineno-9-12" name="__codelineno-9-12" href="#__codelineno-9-12"></a><span class="w">  </span><span class="p">]</span>
 <a id="__codelineno-9-13" name="__codelineno-9-13" href="#__codelineno-9-13"></a><span class="p">}</span>
 </code></pre></div>
-</li>
-</ol>
 <p>It is now possible to debug the containerized Nautobot and Celery Worker using the VS Code debugger.</p>
 <p>After restarting the Celery-Worker container you need to restart the debug session.</p>
+</li>
+</ol>
 
 
 

nautobot/project-static/docs/development/core/getting-started.html

@@ -10359,10 +10359,6 @@
 <p>You may install Poetry in your user environment by running:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a>curl -sSL https://install.python-poetry.org | python3 -
 </code></pre></div>
-<details class="version-changed">
-<summary>Changed in version 1.5.6</summary>
-<p>Poetry 1.3+ is required to be able to install packages against the latest lockfile.</p>
-</details>
 <div class="admonition danger">
 <p class="admonition-title">Danger</p>
 <p>Always utilize this documented method to install Poetry for use when developing Nautobot.</p>
@@ -10549,10 +10545,10 @@
 <p>Do not use <code>poetry run nautobot-server runserver</code> as it will crash unless you also pass the <code>--noreload</code> flag, which somewhat defeats the purpose of using the development server. It is recommended to use <code>nautobot-server runserver</code> from within an active virtualenv (e.g. <code>poetry shell</code>). This is a <a href="https://github.com/python-poetry/poetry/issues/2435">known issue with Django and Poetry</a>.</p>
 </div>
 <p>Please see the <a href="https://docs.djangoproject.com/en/stable/ref/django-admin/#runserver">official Django documentation on <code>runserver</code></a> for more information.</p>
-<p>You can connect to the development server at <code>localhost:8080</code>.</p>
+<p>You can connect to the development server in your local web browser at <code>http://localhost:8080</code>. If you are using the ephemeral ports feature (disabled by default), you can make use of the command, <code>invoke open-nautobot-web</code>. This will open up the default web-browser on your system pointing to the correct Nautobot admin port. Note that this command can be used regardless of ephemeral port mode.</p>
 <h3 id="starting-the-worker-server">Starting the Worker Server<a class="headerlink" href="#starting-the-worker-server" title="Permanent link">&para;</a></h3>
 <p>In order to run Nautobot Jobs or anything that requires a worker you must start a Celery worker.</p>
-<p>The worker is started in Docker Workflow with <a href="https://pythonhosted.org/watchdog/">watchdog</a> and can be setup to be started with watchdog in the Virtual Environment Workflow. Watchdog provides a similar experience to the Django lightweight HTTP/WSGI for restarting your application automatically. Watchdog can watch for changes on your filesystem, this is helpful when adjusting existing Python files to not have to restart the celery worker when testing jobs.</p>
+<p>The worker is started in Docker Workflow with <a href="https://pythonhosted.org/watchdog/">watchdog</a> and can be setup to be started with watchdog in the Virtual Environment Workflow. Watchdog provides a similar experience to the Django lightweight HTTP/WSGI for restarting your application automatically. Watchdog can watch for changes on your filesystem, this is helpful when adjusting existing Python files to not have to restart the Celery worker when testing jobs.</p>
 <table>
 <thead>
 <tr>
@@ -10569,7 +10565,7 @@
 </table>
 <div class="admonition tip">
 <p class="admonition-title">Tip</p>
-<p>You can leverage watchdog for your celery worker as described above, with the following watchmedo command in your development environment <code>watchmedo auto-restart --directory './' --pattern '*.py' --recursive -- nautobot-server celery worker -l INFO --events</code>.</p>
+<p>You can leverage watchdog for your Celery worker as described above, with the following watchmedo command in your development environment <code>watchmedo auto-restart --directory './' --pattern '*.py' --recursive -- nautobot-server celery worker -l INFO --events</code>.</p>
 </div>
 <h3 id="starting-the-interactive-shell">Starting the Interactive Shell<a class="headerlink" href="#starting-the-interactive-shell" title="Permanent link">&para;</a></h3>
 <p>Nautobot provides an <a href="../../user-guide/administration/tools/nautobot-shell.html">interactive Python shell</a> that sets up the server environment and gives you direct access to the database models for debugging. Nautobot extends this slightly to automatically import models and other utilities.</p>
@@ -10752,10 +10748,10 @@
 <p class="admonition-title">Tip</p>
 <p>You may also use <code>invoke integration-test</code> in the Virtual Environment workflow given that the <code>selenium</code> container is running, and that the <code>INVOKE_NAUTOBOT_LOCAL=True</code> environment variable has been set.</p>
 </div>
-<details class="version-changed">
-<summary>Changed in version 1.5.11</summary>
+<div class="admonition tip">
+<p class="admonition-title">Tip</p>
 <p>The <code>--cache-test-fixtures</code> argument was added to the <code>invoke integration-test</code> and <code>nautobot-server test</code> commands to allow for caching of test factory data between test runs. See the <a href="testing.html#factory-caching">factories documentation</a> for more information.</p>
-</details>
+</div>
 <h5 id="customizing-integration-test-executions">Customizing Integration Test Executions<a class="headerlink" href="#customizing-integration-test-executions" title="Permanent link">&para;</a></h5>
 <p>The following environment variables can be provided when running tests to customize where Nautobot looks for Selenium and where Selenium looks for Nautobot. If using the default setup documented above, there is no need to customize these.</p>
 <ul>
@@ -10845,27 +10841,27 @@
 <p>Some features require documentation updates or new documentation to be written. The documentation files can be found in the <code>docs</code> directory. To preview these changes locally, you can use <code>mkdocs</code>.</p>
 <p>For substantial changes to the code (including new features, removal of existing features, or significant changes in behavior) you should always make corresponding documentation updates. Nautobot's documentation pipeline includes a custom plugin for <code>mkdocs</code> that adds a few useful macros for annotating such changes:</p>
 <ul>
-<li><code>+++ 1.4.3</code>, on a line by itself, is a shorthand for <code>!!! version-added "Added in version 1.4.3"</code></li>
-<li><code>+/- 1.4.3</code>, on a line by itself, is a shorthand for <code>!!! version-changed "Changed in version 1.4.3"</code></li>
-<li><code>--- 1.4.3</code>, on a line by itself, is a shorthand for <code>!!! version-removed "Removed in version 1.4.3"</code></li>
+<li><code>+++ 2.4.3</code>, on a line by itself, is a shorthand for <code>!!! version-added "Added in version 2.4.3"</code></li>
+<li><code>+/- 2.4.3</code>, on a line by itself, is a shorthand for <code>!!! version-changed "Changed in version 2.4.3"</code></li>
+<li><code>--- 2.4.3</code>, on a line by itself, is a shorthand for <code>!!! version-removed "Removed in version 2.4.3"</code></li>
 </ul>
 <p>These admonitions in turn appear in the rendered documentation as follows:</p>
 <details class="version-added">
-<summary>Added in version 1.4.3</summary>
+<summary>Added in version 2.4.3</summary>
 </details>
 <details class="version-changed">
-<summary>Changed in version 1.4.3</summary>
+<summary>Changed in version 2.4.3</summary>
 </details>
 <details class="version-removed">
-<summary>Removed in version 1.4.3</summary>
+<summary>Removed in version 2.4.3</summary>
 </details>
 <p>You can also add text to any of these admonitions for further clarity, for example:</p>
-<div class="highlight"><pre><span></span><code>??? version-added &quot;Added in version 1.4.3&quot;
+<div class="highlight"><pre><span></span><code>??? version-added &quot;Added in version 2.4.3&quot;
     The custom `mkdocs` plugin was added.
 </code></pre></div>
 <p>will render as:</p>
 <details class="version-added">
-<summary>Added in version 1.4.3</summary>
+<summary>Added in version 2.4.3</summary>
 <p>The custom <code>mkdocs</code> plugin was added.</p>
 </details>
 <div class="admonition caution">

nautobot/project-static/docs/development/core/homepage.html

@@ -9176,9 +9176,6 @@
 
 
 <h1 id="populating-the-home-page">Populating the Home Page<a class="headerlink" href="#populating-the-home-page" title="Permanent link">&para;</a></h1>
-<details class="version-added">
-<summary>Added in version 1.2.0</summary>
-</details>
 <p>Both core applications and Apps can contribute items to the Nautobot home page by defining <code>layout</code> inside of their app's <code>homepage.py</code>. Using a key and weight system, a developer can integrate amongst existing home page panels or can create entirely new panels as desired.</p>
 <h2 id="adding-a-new-home-page-panel">Adding a new Home Page Panel<a class="headerlink" href="#adding-a-new-home-page-panel" title="Permanent link">&para;</a></h2>
 <p>Each panel on the home page is defined by a <code>HomePagePanel</code> object. A <code>HomePagePanel</code> may contain either or both of <code>HomePageItem</code> and/or <code>HomePageGroup</code> objects, or may define custom content via a referenced Django template. A <code>HomePageGroup</code> may itself contain <code>HomePageItem</code> objects as well, and individual <code>HomePageItem</code> objects may also reference custom Django templates.</p>

nautobot/project-static/docs/development/core/index.html

@@ -9561,7 +9561,7 @@
 <p>Communication among the contributors should always occur via public channels. The following outlines the best ways to communicate and engage on all things Nautobot.</p>
 <h3 id="slack">Slack<a class="headerlink" href="#slack" title="Permanent link">&para;</a></h3>
 <ul>
-<li><a href="http://slack.networktocode.com/"><strong>#nautobot</strong> on Network to Code Slack</a> - Good for quick chats. Avoid any discussion that might need to be referenced later on, as the chat history is not retained long.</li>
+<li><a href="http://slack.networktocode.com/"><code>#nautobot</code> on Network to Code Slack</a> - Good for quick chats. Avoid any discussion that might need to be referenced later on, as the chat history is not retained long.</li>
 </ul>
 <h3 id="github">GitHub<a class="headerlink" href="#github" title="Permanent link">&para;</a></h3>
 <ul>

nautobot/project-static/docs/development/core/minikube-dev-environment-for-k8s-jobs.html

@@ -9487,7 +9487,7 @@
 <p>Run the following command to point your terminal to use the docker daemon inside minikube. This will ensure that your up-to-date local image named <code>local/nautobot-final-dev:local-${NAUTOBOT_VER}-py${PYTHON_VER}</code> is used when you build your kubernetes deployments.</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a><span class="nb">eval</span><span class="w"> </span><span class="k">$(</span>minikube<span class="w"> </span>docker-env<span class="k">)</span>
 </code></pre></div>
-<p>Now you can build your nautobot image locally using the <code>invoke build</code> command. After the build is complete, you are ready to build your kubernetes deployments.</p>
+<p>Now you can build your Nautobot image locally using the <code>invoke build</code> command. After the build is complete, you are ready to build your kubernetes deployments.</p>
 <h3 id="starting-the-deployments-and-services">Starting the Deployments and Services<a class="headerlink" href="#starting-the-deployments-and-services" title="Permanent link">&para;</a></h3>
 <p>Once you have confirmed that you have all the files listed above. You can start the required deployments and services:</p>
 <p>To start all deployments:</p>
@@ -9620,7 +9620,7 @@ Check the override default value checkbox on the <code>Default Job Queue</code>
 <p>You can inspect the job result and the job logs in this page. Notice the two job log entries that reads something like "Creating job pod (pod-name) in namespace default" and "Reading job pod (pod-name) in namespace default". Those entries indicate that a Kubernetes Job pod was executing the job for you.</p>
 <p><img alt="K8s Job Result Completed" src="../../media/development/core/kubernetes/k8s_job_result_completed.png" /></p>
 <h3 id="running-a-scheduled-job">Running a Scheduled Job<a class="headerlink" href="#running-a-scheduled-job" title="Permanent link">&para;</a></h3>
-<p>You can run scheduled jobs as well. In order to run scheduled jobs, you do need celery beat which should already be running from previous steps. To confirm that the celery beat is running, you need to retrieve the celery beat pod name by running the command <code>kubectl get pods</code>. You should see the following output or something similar, copy the pod name with prefix <code>celery-beat-*</code>.</p>
+<p>You can run scheduled jobs as well. In order to run scheduled jobs, you do need Celery Beat which should already be running from previous steps. To confirm that the Celery Beat is running, you need to retrieve the Celery Beat pod name by running the command <code>kubectl get pods</code>. You should see the following output or something similar, copy the pod name with prefix <code>celery-beat-*</code>.</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-29-1" name="__codelineno-29-1" href="#__codelineno-29-1"></a>NAME<span class="w">                           </span>READY<span class="w">   </span>STATUS<span class="w">    </span>RESTARTS<span class="w">   </span>AGE
 <a id="__codelineno-29-2" name="__codelineno-29-2" href="#__codelineno-29-2"></a>celery-beat-6fb67477b7-rsw62<span class="w">   </span><span class="m">1</span>/1<span class="w">     </span>Running<span class="w">   </span><span class="m">0</span><span class="w">          </span>10m
 <a id="__codelineno-29-3" name="__codelineno-29-3" href="#__codelineno-29-3"></a>db-8687b48964-gtvtc<span class="w">            </span><span class="m">1</span>/1<span class="w">     </span>Running<span class="w">   </span><span class="m">0</span><span class="w">          </span>10m
@@ -9645,7 +9645,7 @@ Check the override default value checkbox on the <code>Default Job Queue</code>
 <p><img alt="K8s Run Job" src="../../media/development/core/kubernetes/k8s_run_job.png" /></p>
 <p>Fill in the data shown below (for the "Starting date and time" field, pick a date and time that is close to the current date and time) and click on the "Schedule Job" button on the bottom right.</p>
 <p><img alt="K8s Run Scheduled Job Form" src="../../media/development/core/kubernetes/k8s_run_scheduled_job_form.png" /></p>
-<p>To confirm that the Scheduled Job is running, you go back to the terminal that was logging celery beat. You should see the following logs or something similar:</p>
+<p>To confirm that the Scheduled Job is running, you go back to the terminal that was logging Celery Beat. You should see the following logs or something similar:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-31-1" name="__codelineno-31-1" href="#__codelineno-31-1"></a><span class="o">[</span><span class="m">2024</span>-11-21<span class="w"> </span><span class="m">02</span>:09:57,756:<span class="w"> </span>INFO/MainProcess<span class="o">]</span><span class="w"> </span>DatabaseScheduler:<span class="w"> </span>Schedule<span class="w"> </span>changed.
 <a id="__codelineno-31-2" name="__codelineno-31-2" href="#__codelineno-31-2"></a><span class="o">[</span><span class="m">2024</span>-11-21<span class="w"> </span><span class="m">02</span>:09:57,774:<span class="w"> </span>INFO/MainProcess<span class="o">]</span><span class="w"> </span>Scheduler:<span class="w"> </span>Sending<span class="w"> </span>due<span class="w"> </span>task<span class="w"> </span>Export<span class="w"> </span>Object<span class="w"> </span>List<span class="w"> </span>Hourly_85413d3f-1342-4adf-8d80-11e740ebb907<span class="w"> </span><span class="o">(</span>nautobot.extras.jobs.run_job<span class="o">)</span>
 <a id="__codelineno-31-3" name="__codelineno-31-3" href="#__codelineno-31-3"></a><span class="m">02</span>:09:57.782<span class="w"> </span>INFO<span class="w">    </span>nautobot.extras.utils<span class="w"> </span>utils.py<span class="w">        </span>run_kubernetes_job_and_return_job_result<span class="o">()</span><span class="w"> </span>:

nautobot/project-static/docs/development/core/model-checklist.html

@@ -9588,7 +9588,7 @@ article ul li {
 </ul>
 </li>
 <li>Validate that the field appears correctly in GraphQL<ul>
-<li>If the field is not compatible with GraphQL or shouldn't be included in GraphQL it's possible to exclude a specific field in the GraphQL Type Object associated with this specific model. You can refer to the <a href="https://docs.graphene-python.org/projects/django/en/latest/queries/#specifying-which-fields-to-include">graphene-django documentation</a> for additional information.</li>
+<li>If the field is not compatible with GraphQL or shouldn't be included in GraphQL it's possible to exclude a specific field in the GraphQL Type Object associated with this specific model. You can refer to the <a href="https://docs.graphene-python.org/projects/django/en/latest/queries/#specifying-which-fields-to-include"><code>graphene-django</code> documentation</a> for additional information.</li>
 </ul>
 </li>
 <li>Add field to model documentation with an appropriate version annotation</li>

nautobot/project-static/docs/development/core/navigation-menu.html

@@ -9218,7 +9218,7 @@
 <p>A tab object is being created with the same identifier as an existing object using the <code>name</code> attribute. Then a group is being created with a weight of <code>150</code>, which means it will appear between the already defined <code>Circuits</code> and <code>Provider</code> groups.</p>
 <div class="admonition tip">
 <p class="admonition-title">Tip</p>
-<p>Weights for already existing items can be found in the nautobot source code (in <code>navigation.py</code>) or with a web session open to your nautobot instance, you can inspect an element of the navbar using the developer tools. Each type of element will have an attribute <code>data-{type}-weight</code>. The type can be <code>tab</code>, <code>group</code>, <code>item</code> or <code>button</code>.</p>
+<p>Weights for already existing items can be found in the Nautobot source code (in <code>navigation.py</code>) or with a web session open to your Nautobot instance, you can inspect an element of the navbar using the developer tools. Each type of element will have an attribute <code>data-{type}-weight</code>. The type can be <code>tab</code>, <code>group</code>, <code>item</code> or <code>button</code>.</p>
 </div>
 <p>This pattern works for modifying all objects in the tree. New items can be added to existing groups and new buttons can be added to existing items.</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="n">menu_tabs</span> <span class="o">=</span> <span class="p">(</span>

nautobot/project-static/docs/development/core/release-checklist.html

@@ -9647,7 +9647,7 @@
 <p>Do not squash merge this branch into <code>main</code>. Make sure to select <code>Create a merge commit</code> when merging in GitHub.</p>
 </div>
 <h3 id="create-a-new-release-tag">Create a New Release Tag<a class="headerlink" href="#create-a-new-release-tag" title="Permanent link">&para;</a></h3>
-<p>You need to create a release tag locally so that you can use it later when you draft the new release for nautobot, for example, <code>v1.4.3</code>.
+<p>You need to create a release tag locally so that you can use it later when you draft the new release for Nautobot, for example, <code>v1.4.3</code>.
 To create the tag locally:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a>git<span class="w"> </span>tag<span class="w"> </span>v1.4.3
 </code></pre></div>

nautobot/project-static/docs/development/core/settings.html

@@ -9292,7 +9292,7 @@
 <h1 id="adding-and-updating-nautobot-settings">Adding and Updating Nautobot Settings<a class="headerlink" href="#adding-and-updating-nautobot-settings" title="Permanent link">&para;</a></h1>
 <p>Best practices when adding, updating, and deprecating/removing Nautobot configuration settings.</p>
 <h2 id="consider-constance">Consider Constance<a class="headerlink" href="#consider-constance" title="Permanent link">&para;</a></h2>
-<p>If the setting is one that would be desirable to configure at run time rather than install time, and the nature of the setting is such that it <em>can</em> be changed at run time without requiring a server reload or similar operations to fully take effect, consider implementing it as a <a href="https://django-constance.readthedocs.io/en/latest/">django-constance</a> setting.</p>
+<p>If the setting is one that would be desirable to configure at run time rather than install time, and the nature of the setting is such that it <em>can</em> be changed at run time without requiring a server reload or similar operations to fully take effect, consider implementing it as a <a href="https://django-constance.readthedocs.io/en/latest/"><code>django-constance</code></a> setting.</p>
 <h3 id="constance-advantages">Constance Advantages<a class="headerlink" href="#constance-advantages" title="Permanent link">&para;</a></h3>
 <ul>
 <li>Constance-enabled settings can be configured through the UI by any user with admin privileges, rather than requiring filesystem access to the Nautobot installation to modify.</li>

nautobot/project-static/docs/development/core/style-guide.html

@@ -9471,10 +9471,6 @@
 <li>
 <p>The combination of <code>nautobot.core.forms.BootstrapMixin</code>, <code>nautobot.extras.forms.CustomFieldModelFormMixin</code>, <code>nautobot.extras.forms.RelationshipModelFormMixin</code> and <code>nautobot.extras.forms.NoteModelFormMixin</code> is such a common use case throughout the code base that they have a helper class which combines all of these at <code>nautobot.extras.forms.NautobotModelForm</code>. Use this helper class if you need the functionality from these classes.</p>
 </li>
-</ul>
-<details class="version-added">
-<summary>Added in version 1.4.0</summary>
-<ul>
 <li>
 <p>Similarly, for filter forms, <code>nautobot.extras.forms.NautobotFilterForm</code> combines <code>nautobot.core.forms.BootstrapMixin</code>, <code>nautobot.extras.forms.ContactTeamModelFilterFormMixin</code> (since Nautobot 2.3.0), <code>nautobot.extras.forms.CustomFieldModelFilterFormMixin</code>, and <code>nautobot.extras.forms.RelationshipModelFilterFormMixin</code>, and should be used where appropriate.</p>
 </li>
@@ -9491,17 +9487,16 @@
 <p>API Views for most models should inherit from <code>nautobot.extras.api.views.NautobotModelViewSet</code>. Only use more abstract base classes such as <code>ModelViewSet</code> where absolutely required.</p>
 </li>
 </ul>
-</details>
 <h2 id="branding">Branding<a class="headerlink" href="#branding" title="Permanent link">&para;</a></h2>
 <ul>
-<li>When referring to Nautobot in writing, use the proper form "Nautobot," with the letter N. The lowercase form "nautobot" should be used in code, filenames, etc.</li>
+<li>When referring to Nautobot in writing, use the proper form "<code>Nautobot</code>," with the letter N. The lowercase form "<code>nautobot</code>" should be used in code, filenames, etc.</li>
 </ul>
 <!-- pyml disable-next-line NAU001 -->
 <ul>
-<li>There is an SVG form of the Nautobot logo at <a href="../../nautobot_logo.svg">nautobot/docs/nautobot_logo.svg</a>. It is preferred to use this logo for all purposes as it scales to arbitrary sizes without loss of resolution. If a raster image is required, the SVG logo should be converted to a PNG image of the prescribed size.</li>
+<li>There is an SVG form of the Nautobot logo at <a href="../../nautobot_logo.svg"><code>nautobot/docs/nautobot_logo.svg</code></a>. It is preferred to use this logo for all purposes as it scales to arbitrary sizes without loss of resolution. If a raster image is required, the SVG logo should be converted to a PNG image of the prescribed size.</li>
 </ul>
 <h2 id="importing-python-packages">Importing Python Packages<a class="headerlink" href="#importing-python-packages" title="Permanent link">&para;</a></h2>
-<p>To prevent circular dependency errors and improve code readability, the following standards should be followed when importing from other python modules.</p>
+<p>To prevent circular dependency errors and improve code readability, the following standards should be followed when importing from other Python modules.</p>
 <div class="admonition tip">
 <p class="admonition-title">Tip</p>
 <p>Some of the below rules will be applied automatically when running the <code>ruff</code> linter/formatter against your code. Specifically, you can run <code>invoke ruff --fix</code> to automatically reorder imports.</p>
@@ -9585,7 +9580,7 @@
 </code></pre></div>
 </div>
 <h4 id="convenience-imports">Convenience Imports<a class="headerlink" href="#convenience-imports" title="Permanent link">&para;</a></h4>
-<p>Nautobot uses convenience imports in the same way that <a href="https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style/#imports">django</a> implements them. These should be leveraged whenever possible.</p>
+<p>Nautobot uses convenience imports in the same way that <a href="https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style/#imports">Django</a> implements them. These should be leveraged whenever possible.</p>
 <div class="admonition example">
 <p class="admonition-title">Example</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a><span class="kn">from</span> <span class="nn">nautobot.extras</span> <span class="kn">import</span> <span class="n">forms</span>

nautobot/project-static/docs/development/core/templates.html

@@ -9308,9 +9308,6 @@ This document presents these templates and their features.</p>
 <p>You can use these templates as the basis for your templates by calling <code>{% extends '&lt;template_name&gt;' %}</code>
 at the top of your template file.</p>
 <h2 id="object-detail">Object Detail<a class="headerlink" href="#object-detail" title="Permanent link">&para;</a></h2>
-<details class="version-added">
-<summary>Added in version 1.2.0</summary>
-</details>
 <p>The most customizable template is <code>generic/object_retrieve.html</code>, as object detail views have a wide range of specific requirements to be accommodated. It provides the following blocks:</p>
 <ul>
 <li><code>header</code>: overloading this block allows for changing the entire top row of

nautobot/project-static/docs/development/core/testing.html

@@ -9549,9 +9549,6 @@
 <h3 id="troubleshooting-integration-tests">Troubleshooting Integration Tests<a class="headerlink" href="#troubleshooting-integration-tests" title="Permanent link">&para;</a></h3>
 <p>Because integration tests normally involve interacting with Nautobot through a browser via <a href="https://www.selenium.dev/selenium/docs/api/py/index.html">Selenium</a> and the <a href="https://splinter.readthedocs.io/en/latest/">Splinter</a> wrapper library, they can be difficult to troubleshoot directly from the Python code when a failure occurs. A common troubleshooting technique is to add a <code>breakpoint()</code> at the appropriate place in the Python test code (i.e., immediately prior to the observed failure). When the breakpoint is hit and the test pauses, you can then use a VNC viewer application (such as macOS's "Screen Sharing" app) to connect to the running Selenium instance (<code>localhost:15900</code> if using the Docker development environment; the default password if prompted is simply "<code>secret</code>"). This will allow you to interact live with the testing web browser in its current state and can often provide invaluable insight into the nature of any test failure.</p>
 <h2 id="factories">Factories<a class="headerlink" href="#factories" title="Permanent link">&para;</a></h2>
-<details class="version-added">
-<summary>Added in version 1.5.0</summary>
-</details>
 <p>Nautobot uses the <a href="https://factoryboy.readthedocs.io/en/stable/"><code>factory_boy</code></a> library as a way to generate randomized but plausible database data for use in unit and integration tests, or for convenience in populating a local development instance.</p>
 <p>Factories for each Nautobot app's models are defined in the corresponding <code>nautobot/APPNAME/factory.py</code> files. Helper classes and functions for certain common patterns are defined in <code>nautobot/core/factory.py</code>. Factories can be used directly from <code>nautobot-server nbshell</code> so long as you have <code>factory_boy</code> installed. Examples:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span> <span class="nn">nautobot.tenancy.factory</span> <span class="kn">import</span> <span class="n">TenantFactory</span><span class="p">,</span> <span class="n">TenantGroupFactory</span>
@@ -9580,9 +9577,6 @@
 <p>In short, we should only have one place in our tests where factories are called, and that's the <code>generate_test_data</code> management command. Individual tests should use standard <code>create()</code> or <code>save()</code> model methods, never factories.</p>
 </div>
 <h3 id="factory-caching">Factory Caching<a class="headerlink" href="#factory-caching" title="Permanent link">&para;</a></h3>
-<details class="version-added">
-<summary>Added in version 1.5.11</summary>
-</details>
 <p>To reduce the time taken between multiple test runs, a new argument has been added to the <code>nautobot-server test</code> command: <code>--cache-test-fixtures</code>. When running tests with <code>--cache-test-fixtures</code> for the first time, after the factory data has been generated it will be saved to a <code>factory_dump.json</code> file in the <code>development</code> directory. On subsequent runs of unit or integration tests, if <code>--cache-test-fixtures</code> is again specified (hint: it is included by default when running <code>invoke unittest</code> or <code>invoke integration-test</code>), the factory data will be loaded from the file instead of being generated again. This can significantly reduce the time taken to run tests.</p>
 <details class="version-changed">
 <summary>Changed in version 2.2.7 — Hashing of migrations in the factory dump</summary>
@@ -9601,9 +9595,6 @@
 </ol>
 </div>
 <h2 id="performance-tests">Performance Tests<a class="headerlink" href="#performance-tests" title="Permanent link">&para;</a></h2>
-<details class="version-added">
-<summary>Added in version 1.5.0</summary>
-</details>
 <h3 id="running-performance-tests">Running Performance Tests<a class="headerlink" href="#running-performance-tests" title="Permanent link">&para;</a></h3>
 <p>Nautobot uses <a href="https://pypi.org/project/django-slowtests/"><code>django-slowtests</code></a> to run performance tests. To run performance tests, you need to install the <code>django-slowtests</code> package.
 Once you install the package, you can do <code>invoke performance-test</code> or <code>invoke unittest --performance-test</code> to run unit tests with <code>NautobotPerformanceTestRunner</code>. The invoke commands will automatically add <code>--testrunner nautobot.core.tests.runner.NautobotPerformanceTestRunner</code> to the <code>coverage run</code> command and this flag will replace the default <code>NautobotTestRunner</code> while retaining all its functionalities with the addition of performance evaluation after test runs.</p>