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

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

@@ -10100,9 +10100,6 @@ The checkbox to enable dryrun when executing a Job is unchecked by default in th
 <p>Default: <code>[]</code></p>
 <p>A list of strings (field names) representing the order your Job <a href="#variables">variables</a> should be rendered as form fields in the Job submission UI. If not defined, the variables will be listed in order of their definition in the code. If variables are defined on a parent class and no field order is defined, the parent class variables will appear before the subclass variables.</p>
 <h4 id="has_sensitive_variables"><code>has_sensitive_variables</code><a class="headerlink" href="#has_sensitive_variables" title="Permanent link">&para;</a></h4>
-<details class="version-added">
-<summary>Added in version 1.3.10</summary>
-</details>
 <p>Default: <code>True</code></p>
 <p>Unless set to False, it prevents the Job's input parameters from being saved to the database. This defaults to True so as to protect against inadvertent database exposure of input parameters that may include sensitive data such as passwords or other user credentials. Review whether each Job's inputs contain any such variables before setting this to False; if a Job <em>does</em> contain sensitive inputs, if possible you should consider whether the Job could be re-implemented using Nautobot's <a href="../../user-guide/platform-functionality/secret.html"><code>Secrets</code></a> feature as a way to ensure that the sensitive data is not directly provided as a Job variable at all.</p>
 <p>Important notes about Jobs with sensitive variables:</p>
@@ -10138,9 +10135,6 @@ A Boolean that if set to <code>True</code> prevents the job from running twice s
 <li>A checkbox on the job run form makes it possible to force the singleton lock to be overridden. This makes it possible to recover from failure scenarios such as the original singleton job being stopped before it can unset the lock.</li>
 </ul>
 <h4 id="read_only"><code>read_only</code><a class="headerlink" href="#read_only" title="Permanent link">&para;</a></h4>
-<details class="version-added">
-<summary>Added in version 1.1.0</summary>
-</details>
 <details class="version-changed">
 <summary>Changed in version 2.0.0 — No automatic functionality</summary>
 <p>The <code>read_only</code> flag no longer changes the behavior of Nautobot core and is up to the Job author to decide whether their Job should be considered read only.</p>
@@ -10148,9 +10142,6 @@ A Boolean that if set to <code>True</code> prevents the job from running twice s
 <p>Default: <code>False</code></p>
 <p>A boolean that can be set by the Job author to indicate that the Job does not make any changes to the environment. What behavior makes each Job "read only" is up to the individual Job author to decide. Note that user input may still be optionally collected with read-only Jobs via Job variables, as described below.</p>
 <h4 id="soft_time_limit"><code>soft_time_limit</code><a class="headerlink" href="#soft_time_limit" title="Permanent link">&para;</a></h4>
-<details class="version-added">
-<summary>Added in version 1.3.0</summary>
-</details>
 <p>An int or float value, in seconds, which can be used to override the default <a href="../../user-guide/administration/configuration/settings.html#celery_task_soft_time_limit">soft time limit</a> for a Job task to complete.</p>
 <p>The <code>celery.exceptions.SoftTimeLimitExceeded</code> exception will be raised when this soft time limit is exceeded. The Job task can catch this to clean up before the <a href="../../user-guide/administration/configuration/settings.html#celery_task_time_limit">hard time limit</a> (10 minutes by default) is reached:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="kn">from</span> <span class="nn">celery.exceptions</span> <span class="kn">import</span> <span class="n">SoftTimeLimitExceeded</span>
@@ -10171,9 +10162,6 @@ A Boolean that if set to <code>True</code> prevents the job from running twice s
 <a id="__codelineno-7-16" name="__codelineno-7-16" href="#__codelineno-7-16"></a>            <span class="n">cleanup_in_a_hurry</span><span class="p">()</span>
 </code></pre></div>
 <h4 id="task_queues"><code>task_queues</code><a class="headerlink" href="#task_queues" title="Permanent link">&para;</a></h4>
-<details class="version-added">
-<summary>Added in version 1.5.0</summary>
-</details>
 <p>Default: <code>[]</code></p>
 <p>A list of Job Queue names that the Job can be routed to. An empty list will default to only allowing the user to select the <a href="../../user-guide/administration/configuration/settings.html#celery_task_default_queue">default Celery queue</a> (<code>default</code> unless changed by an administrator). The queue specified in the Job's <code>default_job_queue</code> will be used if a queue is not specified in a Job run API call.</p>
 <details class="version-changed">
@@ -10185,9 +10173,6 @@ A Boolean that if set to <code>True</code> prevents the job from running twice s
 <p>A worker must be listening on the requested queue or the Job will not run. See the documentation on <a href="../../user-guide/administration/guides/celery-queues.html">task queues</a> for more information.</p>
 </div>
 <h4 id="template_name"><code>template_name</code><a class="headerlink" href="#template_name" title="Permanent link">&para;</a></h4>
-<details class="version-added">
-<summary>Added in version 1.4.0</summary>
-</details>
 <p>A path relative to the Job source code containing a Django template which provides additional code to customize the Job's submission form. This template should extend the existing Job template, <code>extras/job.html</code>, otherwise the base form and functionality may not be available.</p>
 <p>A template can provide additional JavaScript, CSS, or even display HTML. A good starting template would be:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>{% extends &#39;extras/job.html&#39; %}
@@ -10211,9 +10196,6 @@ A Boolean that if set to <code>True</code> prevents the job from running twice s
 </details>
 <p>For another example checkout <a href="https://github.com/nautobot/nautobot/blob/main/examples/example_app/example_app/templates/example_app/example_with_custom_template.html">the template used in the Example App</a> in the GitHub repo.</p>
 <h4 id="time_limit"><code>time_limit</code><a class="headerlink" href="#time_limit" title="Permanent link">&para;</a></h4>
-<details class="version-added">
-<summary>Added in version 1.3.0</summary>
-</details>
 <p>An int or float value, in seconds, which can be used to override the
 default <a href="../../user-guide/administration/configuration/settings.html#celery_task_time_limit">hard time limit</a> (10 minutes by default) for a Job task to complete.</p>
 <p>Unlike the <code>soft_time_limit</code> above, no exceptions are raised when a <code>time_limit</code> is exceeded. The task will just terminate silently:</p>
@@ -10427,6 +10409,7 @@ Another example of using the nested reference would be to access <a href="../../
 <li><code>skip_db_logging</code> - Log the message to the console but not to the database</li>
 </ul>
 <p>If a <code>grouping</code> is not provided it will default to the function name that logged the message. The <code>object</code> will default to <code>None</code>.</p>
+<!-- pyml disable-num-lines 10 proper-names -->
 <div class="admonition example">
 <p class="admonition-title">Example</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a><span class="kn">from</span> <span class="nn">nautobot.apps.jobs</span> <span class="kn">import</span> <span class="n">Job</span>
@@ -10437,6 +10420,7 @@ Another example of using the nested reference would be to access <a href="../../
 </code></pre></div>
 </div>
 <p>To skip writing a log entry to the database, set the <code>skip_db_logging</code> key in the "extra" kwarg to <code>True</code> when calling the log function. The output will still be written to the console.</p>
+<!-- pyml disable-num-lines 10 proper-names -->
 <div class="admonition example">
 <p class="admonition-title">Example</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-20-1" name="__codelineno-20-1" href="#__codelineno-20-1"></a><span class="kn">from</span> <span class="nn">nautobot.apps.jobs</span> <span class="kn">import</span> <span class="n">Job</span>
@@ -10447,10 +10431,10 @@ Another example of using the nested reference would be to access <a href="../../
 </code></pre></div>
 </div>
 <p>Markdown rendering is supported for log messages, as well as <a href="../../user-guide/platform-functionality/template-filters.html#render_markdown">a limited subset of HTML</a>.</p>
-<details class="version-changed">
-<summary>Changed in version 1.3.4 — Log entry sanitization</summary>
+<div class="admonition warning">
+<p class="admonition-title">Warning</p>
 <p>As a security measure, the <code>message</code> passed to any of these methods will be passed through the <code>nautobot.core.utils.logging.sanitize()</code> function in an attempt to strip out information such as usernames/passwords that should not be saved to the logs. This is of course best-effort only, and Job authors should take pains to ensure that such information is not passed to the logging APIs in the first place. The set of redaction rules used by the <code>sanitize()</code> function can be configured as <a href="../../user-guide/administration/configuration/settings.html#sanitizer_patterns"><code>settings.SANITIZER_PATTERNS</code></a>.</p>
-</details>
+</div>
 <details class="version-changed">
 <summary>Changed in version 2.0.0 — Significant API changes</summary>
 <p>The Job class logging functions (example: <code>self.log(message)</code>, <code>self.log_success(obj=None, message=message)</code>, etc) have been removed. Also, the convenience method to mark a Job as failed, <code>log_failure()</code>, has been removed. To replace the functionality of this method, you can log an error message with <code>self.logger.error()</code> and then raise an exception to fail the Job. Note that it is no longer possible to manually set the Job Result status as failed without raising an exception in the Job.</p>
@@ -10510,11 +10494,6 @@ Another example of using the nested reference would be to access <a href="../../
 <h2 id="testing-jobs">Testing Jobs<a class="headerlink" href="#testing-jobs" title="Permanent link">&para;</a></h2>
 <p>Jobs are Python code and can be tested as such, usually via <a href="https://docs.djangoproject.com/en/stable/topics/testing/">Django unit-test features</a>. That said, there are a few useful tricks specific to testing Jobs.</p>
 <p>While individual methods within your Job can and should be tested in isolation, you'll likely also want to test the entire execution of the Job.</p>
-<details class="version-added">
-<summary>Added in version 1.3.3</summary>
-<p>Entire Job execution testing was only introduced in 1.3.3 and newer.
-However the import paths used in the examples requires 1.5.2 and newer.</p>
-</details>
 <p>The simplest way to test the entire execution of Jobs is via calling the <code>nautobot.apps.testing.run_job_for_testing()</code> method, which is a helper wrapper around the <code>JobResult.enqueue_job</code> function used to execute a Job via Nautobot's Celery worker process.</p>
 <p>Because of the way <code>run_job_for_testing</code> and more specifically Celery tasks work, which is somewhat complex behind the scenes, you need to inherit from <code>nautobot.apps.testing.TransactionTestCase</code> instead of <code>django.test.TestCase</code> (Refer to the <a href="https://docs.djangoproject.com/en/stable/topics/testing/tools/#provided-test-case-classes">Django documentation</a> if you're interested in the differences between these classes - <code>TransactionTestCase</code> from Nautobot is a small wrapper around Django's <code>TransactionTestCase</code>).</p>
 <p>When using <code>TransactionTestCase</code> (whether from Django or from Nautobot) each tests runs on a completely empty database. Furthermore, Nautobot requires new Jobs to be enabled before they can run. Therefore, we need to make sure the Job is enabled before each run which <code>run_job_for_testing</code> handles for us.</p>
@@ -10526,7 +10505,7 @@ However the import paths used in the examples requires 1.5.2 and newer.</p>
 <a id="__codelineno-24-5" name="__codelineno-24-5" href="#__codelineno-24-5"></a><span class="k">class</span> <span class="nc">MyJobTestCase</span><span class="p">(</span><span class="n">TransactionTestCase</span><span class="p">):</span>
 <a id="__codelineno-24-6" name="__codelineno-24-6" href="#__codelineno-24-6"></a>    <span class="k">def</span> <span class="nf">test_my_job</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <a id="__codelineno-24-7" name="__codelineno-24-7" href="#__codelineno-24-7"></a>        <span class="c1"># Testing of Job &quot;MyJob&quot; in file &quot;my_job_file.py&quot; in $JOBS_ROOT</span>
-<a id="__codelineno-24-8" name="__codelineno-24-8" href="#__codelineno-24-8"></a>        <span class="n">job</span> <span class="o">=</span> <span class="n">Job</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">job_class_name</span><span class="o">=</span><span class="s2">&quot;MyJob&quot;</span><span class="p">,</span> <span class="n">module_name</span><span class="o">=</span><span class="s2">&quot;my_job_file&quot;</span><span class="p">,</span> <span class="n">source</span><span class="o">=</span><span class="s2">&quot;local&quot;</span><span class="p">)</span>
+<a id="__codelineno-24-8" name="__codelineno-24-8" href="#__codelineno-24-8"></a>        <span class="n">job</span> <span class="o">=</span> <span class="n">Job</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">job_class_name</span><span class="o">=</span><span class="s2">&quot;MyJob&quot;</span><span class="p">,</span> <span class="n">module_name</span><span class="o">=</span><span class="s2">&quot;my_job_file&quot;</span><span class="p">)</span>
 <a id="__codelineno-24-9" name="__codelineno-24-9" href="#__codelineno-24-9"></a>        <span class="c1"># or, job = Job.objects.get_for_class_path(&quot;local/my_job_file/MyJob&quot;)</span>
 <a id="__codelineno-24-10" name="__codelineno-24-10" href="#__codelineno-24-10"></a>        <span class="n">job_result</span> <span class="o">=</span> <span class="n">run_job_for_testing</span><span class="p">(</span><span class="n">job</span><span class="p">,</span> <span class="n">var1</span><span class="o">=</span><span class="s2">&quot;abc&quot;</span><span class="p">,</span> <span class="n">var2</span><span class="o">=</span><span class="mi">123</span><span class="p">)</span>
 <a id="__codelineno-24-11" name="__codelineno-24-11" href="#__codelineno-24-11"></a>
@@ -10535,14 +10514,16 @@ However the import paths used in the examples requires 1.5.2 and newer.</p>
 <a id="__codelineno-24-14" name="__codelineno-24-14" href="#__codelineno-24-14"></a>        <span class="k">for</span> <span class="n">log_entry</span> <span class="ow">in</span> <span class="n">log_entries</span><span class="p">:</span>
 <a id="__codelineno-24-15" name="__codelineno-24-15" href="#__codelineno-24-15"></a>            <span class="bp">self</span><span class="o">.</span><span class="n">assertEqual</span><span class="p">(</span><span class="n">log_entry</span><span class="o">.</span><span class="n">message</span><span class="p">,</span> <span class="s2">&quot;...&quot;</span><span class="p">)</span>
 </code></pre></div>
+<p>The test files should be placed under the <code>tests</code> folder in the app's directory or under JOBS_ROOT. The test can be run via <code>nautobot-server test [path to test in dotted directory format]</code> or <code>pytest [path to test in slash directory format]</code>.</p>
+<div class="admonition tip">
+<p class="admonition-title">Tip</p>
+<p>For running tests directly in the JOBS_ROOT, make sure the <code>JOBS_ROOT</code> environment variable is set.</p>
+</div>
 <div class="admonition tip">
 <p class="admonition-title">Tip</p>
 <p>For more advanced examples refer to the Nautobot source code, specifically <code>nautobot/extras/tests/test_jobs.py</code>.</p>
 </div>
 <h2 id="debugging-job-performance">Debugging Job Performance<a class="headerlink" href="#debugging-job-performance" title="Permanent link">&para;</a></h2>
-<details class="version-added">
-<summary>Added in version 1.5.17</summary>
-</details>
 <p>Debugging the performance of Nautobot Jobs can be tricky, because they are executed in the worker context. In order to gain extra visibility, <a href="https://docs.python.org/3/library/profile.html">cProfile</a> can be used to profile the Job execution.</p>
 <p>The 'profile' form field on Jobs is automatically available when the <code>DEBUG</code> settings is <code>True</code>. When you select that checkbox, a profiling report in the pstats format will be written to the file system of the environment where the Job runs. Normally, this is on the file system of the worker process, but if you are using the <code>nautobot-server runjob</code> command with <code>--local</code>, it will end up in the file system of the web application itself. The path of the written file will be logged in the Job.</p>
 <div class="admonition note">

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

@@ -9518,10 +9518,10 @@
 <li><a href="#test_-and-post_run-methods"><code>self.test_*</code> and <code>self.post_run()</code> methods were removed</a></li>
 <li><a href="#read-only-meta-attribute"><code>read_only</code> no longer changes the behavior of Nautobot core</a></li>
 <li><a href="#tracking-job-state"><code>self.job_result</code> should no longer be modified or saved from within a Job</a></li>
-<li><a href="#job-registration">Jobs must be registered in the celery task registry</a></li>
+<li><a href="#job-registration">Jobs must be registered in the Celery task registry</a></li>
 <li><a href="#tracking-job-state"><code>self.failed</code> removed</a></li>
 <li><a href="#job-logging">The job logging methods have been renamed and their signature changed</a></li>
-<li><a href="#request-property">The <code>request</code> property has been changed to a celery request instead of a Django request</a></li>
+<li><a href="#request-property">The <code>request</code> property has been changed to a Celery request instead of a Django request</a></li>
 </ul>
 <h2 id="overview">Overview<a class="headerlink" href="#overview" title="Permanent link">&para;</a></h2>
 <p>Some fundamental changes were made to Jobs in Nautobot v2.0. This document outlines the changes that were made and how to migrate your existing Jobs to work in Nautobot v2.0. For more information about the changes made to the Job class and Job model in Nautobot v2.0 see the <a href="../../../user-guide/administration/upgrading/from-v1/upgrading-from-nautobot-v1.html#job-changes">Upgrading From Nautobot v1</a> documentation.</p>
@@ -9575,6 +9575,7 @@
 </div>
 <h3 id="database-transaction-handling">Database Transaction Handling<a class="headerlink" href="#database-transaction-handling" title="Permanent link">&para;</a></h3>
 <p>Jobs no longer run in a single atomic <a href="https://docs.djangoproject.com/en/stable/topics/db/transactions/">database transaction</a> by default. If a Job needs to run in a database transaction, you can use the <code>@transaction.atomic</code> decorator on the <code>run()</code> method or wrap parts of your Job code in the <code>with transaction.atomic()</code> context manager.</p>
+<!-- pyml disable-num-lines 10 proper-names -->
 <div class="admonition example">
 <p class="admonition-title">Example</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="kn">from</span> <span class="nn">django.db</span> <span class="kn">import</span> <span class="n">transaction</span>

nautobot/project-static/docs/index.html

@@ -9183,12 +9183,13 @@
 
 
 <h1 id="nautobot">Nautobot<a class="headerlink" href="#nautobot" title="Permanent link">&para;</a></h1>
-<!-- pyml disable-num-lines 3 no-inline-html -->
+<!-- pyml disable-num-lines 5 no-inline-html,proper-names -->
 <figure>
   <img alt="Nautobot Logo" src="assets/nautobot_logo.svg" title="Welcome" width="400" />
 </figure>
 <h2 id="what-is-nautobot">What is Nautobot?<a class="headerlink" href="#what-is-nautobot" title="Permanent link">&para;</a></h2>
 <p>Nautobot is an open source Network Source of Truth and Network Automation Platform built as a web application atop the <a href="https://www.djangoproject.com/">Django</a> Python framework with a <a href="https://www.postgresql.org/">PostgreSQL</a> or <a href="https://www.mysql.com">MySQL</a> database.</p>
+<!-- pyml disable-next-line proper-names -->
 <p>Try out a live demo at <a href="https://demo.nautobot.com">https://demo.nautobot.com</a></p>
 <h2 id="key-use-cases">Key Use Cases<a class="headerlink" href="#key-use-cases" title="Permanent link">&para;</a></h2>
 <p>Nautobot enables three (3) key use cases.</p>
@@ -9204,7 +9205,7 @@
 </li>
 </ol>
 <h2 id="getting-started">Getting Started<a class="headerlink" href="#getting-started" title="Permanent link">&para;</a></h2>
-<!-- pyml disable-num-lines 30 no-inline-html -->
+<!-- pyml disable-num-lines 30 no-inline-html,proper-names -->
 <div class="grid cards">
 <ul>
 <li>

nautobot/project-static/docs/overview/application_stack.html

@@ -9248,7 +9248,7 @@
 <h1 id="application-stack">Application Stack<a class="headerlink" href="#application-stack" title="Permanent link">&para;</a></h1>
 <p>Nautobot is built on the <a href="https://djangoproject.com/">Django</a> Python Web framework and requires either a <a href="https://www.postgresql.org/">PostgreSQL</a> or <a href="https://www.mysql.com">MySQL</a> database backend. It runs as a WSGI service behind your choice of HTTP server.</p>
 <h2 id="components">Components<a class="headerlink" href="#components" title="Permanent link">&para;</a></h2>
-<!-- pyml disable-num-lines 9 no-inline-html -->
+<!-- pyml disable-num-lines 9 no-inline-html,proper-names -->
 <table>
 <thead>
 <tr>
@@ -9293,26 +9293,8 @@
 <h2 id="getting-started">Getting Started<a class="headerlink" href="#getting-started" title="Permanent link">&para;</a></h2>
 <p>See the <a href="../user-guide/administration/installation/index.html">installation guide</a> for help getting Nautobot up and running quickly.</p>
 <h2 id="dependency-history">Dependency History<a class="headerlink" href="#dependency-history" title="Permanent link">&para;</a></h2>
-<details class="version-added">
-<summary>Added in version 1.1.0 — MySQL support</summary>
-<p>MySQL support was added.</p>
-</details>
-<details class="version-changed">
-<summary>Changed in version 1.3.0 — Python 3.6, Python 3.10</summary>
-<ul>
-<li>Python 3.6 support was removed.</li>
-<li>Python 3.10 support was added.</li>
-</ul>
-</details>
-<details class="version-changed">
-<summary>Changed in version 1.6.0 — Python 3.7, Python 3.11</summary>
-<ul>
-<li>Python 3.7 support was removed.</li>
-<li>Python 3.11 support was added.</li>
-</ul>
-</details>
 <details class="version-removed">
-<summary>Removed in version 2.0.0 — django-rq and django-cacheops</summary>
+<summary>Removed in version 2.0.0 — <code>django-rq</code> and <code>django-cacheops</code></summary>
 <ul>
 <li><code>django-rq</code> support was removed.</li>
 <li><code>django-cacheops</code> usage was removed and replaced with Django's native caching features.</li>

nautobot/project-static/docs/release-notes/version-1.0.html

@@ -10781,7 +10781,7 @@
 <p>Plugins can now define additional Django apps that they require and these dependencies will be automatically enabled when the plugin is activated.</p>
 <p>Nautobot now allows and encourages plugins to make use of the generic view classes and page templates provided in <code>nautobot.core.views.generic</code> and <code>nautobot/core/templates/generic/</code> respectively.</p>
 <h4 id="single-sign-on-social-authentication-support">Single Sign-On / Social Authentication Support<a class="headerlink" href="#single-sign-on-social-authentication-support" title="Permanent link">&para;</a></h4>
-<p>Nautobot now supports single sign on as an authentication option using OAuth2, OpenID, SAML, and others, using the <a href="https://python-social-auth.readthedocs.io/en/latest/">social-auth-app-django</a> module. For more details please refer to the guide on <a href="../user-guide/administration/configuration/authentication/sso.html">SSO authentication</a>.</p>
+<p>Nautobot now supports single sign on as an authentication option using OAuth2, OpenID, SAML, and others, using the <a href="https://python-social-auth.readthedocs.io/en/latest/"><code>social-auth-app-django</code></a> module. For more details please refer to the guide on <a href="../user-guide/administration/configuration/authentication/sso.html">SSO authentication</a>.</p>
 <h4 id="user-defined-relationships">User-Defined Relationships<a class="headerlink" href="#user-defined-relationships" title="Permanent link">&para;</a></h4>
 <p>User-Defined, or "custom", <a href="../user-guide/platform-functionality/relationship.html">relationships</a> allow users to create their own relationships between models in Nautobot to best suit the needs of their specific network design.</p>
 <p>For example, a VLAN is mapped to a Site by default. After a VLAN is created today, you then assign that VLAN to an Interface on a Device. This Device should be within the initial mapped Site. However, many networks today have different requirements and relationships for VLANs (and many other models): VLANs may be limited to racks in Layer 3 DC fabrics; VLANs may be mapped to multiple buildings in a campus; they may span sites. Relationships allow you to express these additional requirements and relationships without requiring code changes to Nautobot itself. Other use cases include circuits, ASNs, or IP addressing -- just to name a few -- allowing users to define the exact relationships required for their network.</p>
@@ -11059,7 +11059,7 @@
 <li><a href="https://github.com/nautobot/nautobot/issues/83">#83</a> - Custom user model added; UserConfig model merged into User model</li>
 <li><a href="https://github.com/nautobot/nautobot/issues/98">#98</a> - Simplify MultipleContentTypeField boilerplate</li>
 <li><a href="https://github.com/nautobot/nautobot/pull/128">#128</a> - Overview of usage for the <code>nautobot-netbox-importer</code> plugin could be mistaken for full instructions</li>
-<li><a href="https://github.com/nautobot/nautobot/pull/122">#122</a> - Improved installation flow for creating nautobot user and virtualenv</li>
+<li><a href="https://github.com/nautobot/nautobot/pull/122">#122</a> - Improved installation flow for creating <code>nautobot</code> user and virtualenv</li>
 <li><a href="https://github.com/nautobot/nautobot/pull/131">#131</a> - Replaced PostgreSQL-specific ArrayField with a more generic JSONArrayField</li>
 <li><a href="https://github.com/nautobot/nautobot/issues/137">#137</a> - Explicitly disallow Custom Field Name Changes</li>
 <li><a href="https://github.com/nautobot/nautobot/pull/142">#142</a> - Converted various config validation checks into proper Django checks</li>

nautobot/project-static/docs/release-notes/version-1.1.html

@@ -10394,7 +10394,7 @@
 <p>Plugins can now define custom Jinja2 filters to be used when rendering templates defined within computed fields or custom links. To register your own filters, you may add a <code>jinja_filters.py</code> to your plugin and any filters defined there will be automatically registered and globally usable.</p>
 <p>Please see the <a href="../development/apps/api/platform-features/jinja2-filters.html">plugin development documentation on including Jinja2 filters</a> to get started.</p>
 <h4 id="read-only-jobs-200">Read Only Jobs (<a href="https://github.com/nautobot/nautobot/issues/200">#200</a>)<a class="headerlink" href="#read-only-jobs-200" title="Permanent link">&para;</a></h4>
-<p>Jobs may be optionally marked as read only by setting the <code>read_only = True</code> meta attribute. This prevents the job from making any changes to nautobot data and suppresses certain log messages. Read only jobs can be a great way to safely develop new jobs, and for working with reporting use cases. Please see the <a href="../user-guide/platform-functionality/jobs/index.html">Jobs documentation</a> for more details.</p>
+<p>Jobs may be optionally marked as read only by setting the <code>read_only = True</code> meta attribute. This prevents the job from making any changes to Nautobot data and suppresses certain log messages. Read only jobs can be a great way to safely develop new jobs, and for working with reporting use cases. Please see the <a href="../user-guide/platform-functionality/jobs/index.html">Jobs documentation</a> for more details.</p>
 <h4 id="saved-graphql-queries-3">Saved GraphQL Queries (<a href="https://github.com/nautobot/nautobot/issues/3">#3</a>)<a class="headerlink" href="#saved-graphql-queries-3" title="Permanent link">&para;</a></h4>
 <p><a href="../user-guide/platform-functionality/graphql.html#saved-queries">Saved GraphQL queries</a> offers a new model where reusable queries can be stored in Nautobot. New views for managing saved queries are available; additionally, the GraphiQL interface has been augmented to allow populating the interface from a saved query, editing and saving new queries.</p>
 <p>Saved queries can easily be imported into the GraphiQL interface by using the new navigation tab located on the right side of the navbar. Inside the new tab are also buttons for editing and saving queries directly into Nautobot's databases.</p>
@@ -10594,7 +10594,7 @@
 </ul>
 <h3 id="fixed-in-v110">Fixed in v1.1.0<a class="headerlink" href="#fixed-in-v110" title="Permanent link">&para;</a></h3>
 <ul>
-<li><a href="https://github.com/nautobot/nautobot/issues/363">#363</a> - Fixed using S3 django-storages backend requires <code>USE_TZ=False</code></li>
+<li><a href="https://github.com/nautobot/nautobot/issues/363">#363</a> - Fixed using S3 <code>django-storages</code> backend requires <code>USE_TZ=False</code>.</li>
 <li><a href="https://github.com/nautobot/nautobot/issues/466">#466</a> - Fixed improper GraphQL schema generation on fields that can be blank but not null (such as <code>Interface.mode</code>)</li>
 <li><a href="https://github.com/nautobot/nautobot/issues/663">#663</a> - Fixed <code>kombu.exceptions.EncodeError</code> when trying to execute Jobs using <code>(Multi)ObjectVar</code> objects with nested relationships</li>
 <li><a href="https://github.com/nautobot/nautobot/issues/672">#672</a> - Fixed inheritance of Celery broker/results URL settings for dev/template configs (they can now be defined using Redis env. vars)</li>

nautobot/project-static/docs/release-notes/version-1.2.html

@@ -11102,7 +11102,7 @@
 </ul>
 <h3 id="dependencies-in-v128">Dependencies in v1.2.8<a class="headerlink" href="#dependencies-in-v128" title="Permanent link">&para;</a></h3>
 <ul>
-<li><a href="https://github.com/nautobot/nautobot/issues/1432">#1432</a> - Update django-redis to <code>5.2.x</code> to address <code>5.1.x</code> blocking redis <code>4.x</code> versions.</li>
+<li><a href="https://github.com/nautobot/nautobot/issues/1432">#1432</a> - Update <code>django-redis</code> to <code>5.2.x</code> to address <code>5.1.x</code> blocking <code>redis</code> <code>4.x</code> versions.</li>
 </ul>
 <h3 id="documentation-in-v128">Documentation in v1.2.8<a class="headerlink" href="#documentation-in-v128" title="Permanent link">&para;</a></h3>
 <ul>
@@ -11110,8 +11110,8 @@
 </ul>
 <h3 id="housekeeping-in-v128">Housekeeping in v1.2.8<a class="headerlink" href="#housekeeping-in-v128" title="Permanent link">&para;</a></h3>
 <ul>
-<li><a href="https://github.com/nautobot/nautobot/issues/839">#839</a> - Add CODE_OF_CONDUCT.md to repository.</li>
-<li><a href="https://github.com/nautobot/nautobot/pull/1299">#1299</a> - Add SECURITY.md to repository.</li>
+<li><a href="https://github.com/nautobot/nautobot/issues/839">#839</a> - Add <code>CODE_OF_CONDUCT.md</code> to repository.</li>
+<li><a href="https://github.com/nautobot/nautobot/pull/1299">#1299</a> - Add <code>SECURITY.md</code> to repository.</li>
 <li><a href="https://github.com/nautobot/nautobot/pull/1348">#1348</a> - Pin Selenium Grid container version to match Python Client version.</li>
 <li><a href="https://github.com/nautobot/nautobot/pull/1388">#1388</a> - Added beta version of GitHub Issue Form style for feature request.</li>
 <li><a href="https://github.com/nautobot/nautobot/pull/1447">#1447</a> - Minor <code>nit</code> on Github Issue Form styling.</li>

nautobot/project-static/docs/release-notes/version-1.3.html

@@ -11417,7 +11417,7 @@
 </ul>
 <h3 id="changed-in-v132">Changed in v1.3.2<a class="headerlink" href="#changed-in-v132" title="Permanent link">&para;</a></h3>
 <ul>
-<li><a href="https://github.com/nautobot/nautobot/pull/1670">#1670</a> - Configure drf-spectacular schema to more closely match drf-yasg (related to: <a href="https://github.com/nautobot/nautobot-ansible/pull/135">nautobot-ansible#135</a>).</li>
+<li><a href="https://github.com/nautobot/nautobot/pull/1670">#1670</a> - Configure <code>drf-spectacular</code> schema to more closely match <code>drf-yasg</code> (related to: <a href="https://github.com/nautobot/nautobot-ansible/pull/135"><code>nautobot-ansible#135</code></a>).</li>
 </ul>
 <h3 id="fixed-in-v132">Fixed in v1.3.2<a class="headerlink" href="#fixed-in-v132" title="Permanent link">&para;</a></h3>
 <ul>

nautobot/project-static/docs/release-notes/version-1.4.html

@@ -11610,7 +11610,7 @@
 </ul>
 <h3 id="documentation-in-v148">Documentation in v1.4.8<a class="headerlink" href="#documentation-in-v148" title="Permanent link">&para;</a></h3>
 <ul>
-<li><a href="https://github.com/nautobot/nautobot/issues/2578">#2578</a> - Added a warning in the documentation about django-cryptography and changing <code>SECRET_KEY</code>.</li>
+<li><a href="https://github.com/nautobot/nautobot/issues/2578">#2578</a> - Added a warning in the documentation about <code>django-cryptography</code> and changing <code>SECRET_KEY</code>.</li>
 <li><a href="https://github.com/nautobot/nautobot/issues/2591">#2591</a> - Updated README.md to include additional information about the Nautobot project.</li>
 <li><a href="https://github.com/nautobot/nautobot/issues/2619">#2619</a> - Added notes about restarting the Nautobot server after creating relationships, custom fields, and computed fields to show them in GraphQL.</li>
 <li><a href="https://github.com/nautobot/nautobot/issues/2677">#2677</a> - Fixed a documentation error by adding an import statement to a code example in <code>nautobot/docs/plugins/development.md</code>.</li>
@@ -11685,7 +11685,7 @@
 </ul>
 <h3 id="documentation-in-v145">Documentation in v1.4.5<a class="headerlink" href="#documentation-in-v145" title="Permanent link">&para;</a></h3>
 <ul>
-<li><a href="https://github.com/nautobot/nautobot/issues/2539">#2539</a> - Updated links from nautobot.readthedocs.io to docs.nautobot.com.</li>
+<li><a href="https://github.com/nautobot/nautobot/issues/2539">#2539</a> - Updated links from <code>nautobot.readthedocs.io</code> to <code>docs.nautobot.com</code>.</li>
 </ul>
 <h3 id="housekeeping-in-v145">Housekeeping in v1.4.5<a class="headerlink" href="#housekeeping-in-v145" title="Permanent link">&para;</a></h3>
 <ul>
@@ -11869,7 +11869,7 @@
 </ul>
 <h3 id="dependencies-in-v140">Dependencies in v1.4.0<a class="headerlink" href="#dependencies-in-v140" title="Permanent link">&para;</a></h3>
 <ul>
-<li><a href="https://github.com/nautobot/nautobot/pull/2183">#2183</a> - Update dependency django to ~3.2.15.</li>
+<li><a href="https://github.com/nautobot/nautobot/pull/2183">#2183</a> - Update dependency <code>django</code> to <code>~3.2.15</code>.</li>
 </ul>
 <h3 id="documentation-in-v140">Documentation in v1.4.0<a class="headerlink" href="#documentation-in-v140" title="Permanent link">&para;</a></h3>
 <ul>
@@ -11940,7 +11940,7 @@
 </ul>
 <h3 id="dependencies-in-v140b1">Dependencies in v1.4.0b1<a class="headerlink" href="#dependencies-in-v140b1" title="Permanent link">&para;</a></h3>
 <ul>
-<li><a href="https://github.com/nautobot/nautobot/pull/2116">#2116</a> - Updated package dependencies: Pillow <code>~9.1.1</code> -&gt; <code>~9.2.0</code>, black <code>~22.3.0</code> -&gt; <code>~22.6.0</code>, coverage <code>6.4.1</code> -&gt; <code>6.4.2</code>, django-cacheops <code>6.0</code> -&gt; <code>6.1</code>, django-cryptography <code>1.0</code> -&gt; <code>1.1</code>, django-debug-toolbar <code>~3.4.0</code> -&gt; <code>~3.5.0</code>, django-extensions <code>~3.1.5</code> -&gt; <code>~3.2.0</code>, drf-yasg <code>~1.20.0</code> -&gt; <code>^1.20.0</code>, importlib-metadata <code>~4.4</code> -&gt; <code>^4.4.0</code>, jsonschema <code>~4.4.0</code> -&gt; <code>~4.8.0</code>, mkdocs <code>1.3.0</code> -&gt; <code>1.3.1</code>, mkdocs <code>==1.3.0</code> -&gt; <code>==1.3.1</code>, mkdocs-include-markdown-plugin <code>~3.2.3</code> -&gt; <code>~3.6.0</code>, mkdocs-include-markdown-plugin <code>==3.2.3</code> -&gt; <code>==3.6.1</code>, social-auth-core <code>~4.2.0</code> -&gt; <code>~4.3.0</code>, svgwrite <code>1.4.2</code> -&gt; <code>1.4.3</code></li>
+<li><a href="https://github.com/nautobot/nautobot/pull/2116">#2116</a> - Updated package dependencies: <code>Pillow</code> <code>~9.1.1</code> -&gt; <code>~9.2.0</code>, <code>black</code> <code>~22.3.0</code> -&gt; <code>~22.6.0</code>, <code>coverage</code> <code>6.4.1</code> -&gt; <code>6.4.2</code>, <code>django-cacheops</code> <code>6.0</code> -&gt; <code>6.1</code>, <code>django-cryptography</code> <code>1.0</code> -&gt; <code>1.1</code>, <code>django-debug-toolbar</code> <code>~3.4.0</code> -&gt; <code>~3.5.0</code>, <code>django-extensions</code> <code>~3.1.5</code> -&gt; <code>~3.2.0</code>, <code>drf-yasg</code> <code>~1.20.0</code> -&gt; <code>^1.20.0</code>, <code>importlib-metadata</code> <code>~4.4</code> -&gt; <code>^4.4.0</code>, <code>jsonschema</code> <code>~4.4.0</code> -&gt; <code>~4.8.0</code>, <code>mkdocs</code> <code>1.3.0</code> -&gt; <code>1.3.1</code>, <code>mkdocs</code> <code>==1.3.0</code> -&gt; <code>==1.3.1</code>, <code>mkdocs-include-markdown-plugin</code> <code>~3.2.3</code> -&gt; <code>~3.6.0</code>, <code>mkdocs-include-markdown-plugin</code> <code>==3.2.3</code> -&gt; <code>==3.6.1</code>, <code>social-auth-core</code> <code>~4.2.0</code> -&gt; <code>~4.3.0</code>, <code>svgwrite</code> <code>1.4.2</code> -&gt; <code>1.4.3</code>.</li>
 </ul>
 <h3 id="documentation-in-v140b1">Documentation in v1.4.0b1<a class="headerlink" href="#documentation-in-v140b1" title="Permanent link">&para;</a></h3>
 <ul>
@@ -11980,19 +11980,19 @@
 </ul>
 <h3 id="dependencies-in-v140a2">Dependencies in v1.4.0a2<a class="headerlink" href="#dependencies-in-v140a2" title="Permanent link">&para;</a></h3>
 <ul>
-<li><a href="https://github.com/nautobot/nautobot/pull/1908">#1908</a> - Update dependency Markdown to ~3.3.7</li>
-<li><a href="https://github.com/nautobot/nautobot/pull/1909">#1909</a> - Update dependency MarkupSafe to ~2.1.1</li>
-<li><a href="https://github.com/nautobot/nautobot/pull/1912">#1912</a> - Update dependency celery to ~5.2.7</li>
-<li><a href="https://github.com/nautobot/nautobot/pull/1913">#1913</a> - Update dependency django-jinja to ~2.10.2</li>
-<li><a href="https://github.com/nautobot/nautobot/pull/1915">#1915</a> - Update dependency invoke to ~1.7.1</li>
-<li><a href="https://github.com/nautobot/nautobot/pull/1917">#1917</a> - Update dependency svgwrite to ~1.4.2</li>
-<li><a href="https://github.com/nautobot/nautobot/pull/1919">#1919</a> - Update dependency Pillow to ~9.1.1</li>
-<li><a href="https://github.com/nautobot/nautobot/pull/1920">#1920</a> - Update dependency coverage to ~6.4.1</li>
-<li><a href="https://github.com/nautobot/nautobot/pull/1921">#1921</a> - Update dependency django-auth-ldap to ~4.1.0</li>
-<li><a href="https://github.com/nautobot/nautobot/pull/1924">#1924</a> - Update dependency django-cors-headers to ~3.13.0</li>
-<li><a href="https://github.com/nautobot/nautobot/pull/1925">#1925</a> - Update dependency django-debug-toolbar to ~3.4.0</li>
-<li><a href="https://github.com/nautobot/nautobot/pull/1928">#1928</a> - Update dependency napalm to ~3.4.1</li>
-<li><a href="https://github.com/nautobot/nautobot/pull/1929">#1929</a> - Update dependency selenium to ~4.2.0</li>
+<li><a href="https://github.com/nautobot/nautobot/pull/1908">#1908</a> - Update dependency <code>Markdown</code> to <code>~3.3.7</code></li>
+<li><a href="https://github.com/nautobot/nautobot/pull/1909">#1909</a> - Update dependency <code>MarkupSafe</code> to <code>~2.1.1</code></li>
+<li><a href="https://github.com/nautobot/nautobot/pull/1912">#1912</a> - Update dependency <code>celery</code> to <code>~5.2.7</code></li>
+<li><a href="https://github.com/nautobot/nautobot/pull/1913">#1913</a> - Update dependency <code>django-jinja</code> to <code>~2.10.2</code></li>
+<li><a href="https://github.com/nautobot/nautobot/pull/1915">#1915</a> - Update dependency <code>invoke</code> to <code>~1.7.1</code></li>
+<li><a href="https://github.com/nautobot/nautobot/pull/1917">#1917</a> - Update dependency <code>svgwrite</code> to <code>~1.4.2</code></li>
+<li><a href="https://github.com/nautobot/nautobot/pull/1919">#1919</a> - Update dependency <code>Pillow</code> to <code>~9.1.1</code></li>
+<li><a href="https://github.com/nautobot/nautobot/pull/1920">#1920</a> - Update dependency <code>coverage</code> to <code>~6.4.1</code></li>
+<li><a href="https://github.com/nautobot/nautobot/pull/1921">#1921</a> - Update dependency <code>django-auth-ldap</code> to <code>~4.1.0</code></li>
+<li><a href="https://github.com/nautobot/nautobot/pull/1924">#1924</a> - Update dependency <code>django-cors-headers</code> to <code>~3.13.0</code></li>
+<li><a href="https://github.com/nautobot/nautobot/pull/1925">#1925</a> - Update dependency <code>django-debug-toolbar</code> to <code>~3.4.0</code></li>
+<li><a href="https://github.com/nautobot/nautobot/pull/1928">#1928</a> - Update dependency <code>napalm</code> to <code>~3.4.1</code></li>
+<li><a href="https://github.com/nautobot/nautobot/pull/1929">#1929</a> - Update dependency <code>selenium</code> to <code>~4.2.0</code></li>
 </ul>
 <h3 id="housekeeping-in-v140a2">Housekeeping in v1.4.0a2<a class="headerlink" href="#housekeeping-in-v140a2" title="Permanent link">&para;</a></h3>
 <ul>

nautobot/project-static/docs/release-notes/version-1.5.html

@@ -12205,10 +12205,10 @@
 <h4 id="custom-field-grouping-899">Custom Field Grouping (<a href="https://github.com/nautobot/nautobot/issues/899">#899</a>)<a class="headerlink" href="#custom-field-grouping-899" title="Permanent link">&para;</a></h4>
 <p>Custom fields can now be assigned to a free-text "grouping" to improve usability when a large number of custom fields are defined on a given model. In the UI, fields in the same grouping will be grouped together, and groupings can be expanded/collapsed for display purposes.</p>
 <h4 id="custom-celery-task-queues-2421">Custom Celery Task Queues (<a href="https://github.com/nautobot/nautobot/pull/2421">#2421</a>)<a class="headerlink" href="#custom-celery-task-queues-2421" title="Permanent link">&para;</a></h4>
-<p>A new optional job property <code>task_queues</code> has been introduced to allow Nautobot to leverage custom celery queues for jobs. This will allow you to send jobs to specific workers based on which queue is selected. This property can be set on the job class and overridden in the job model, similar to other overridable job fields. If <code>task_queues</code> is not defined on the job class or job model, the job will only be able to use the default queue. A new field has been added to the job run form to allow you to select a queue when you run the job and  an optional field <code>task_queue</code> has been added to the REST API <a href="../user-guide/platform-functionality/jobs/index.html#via-the-rest-api">job run endpoint</a> for the same purpose.</p>
+<p>A new optional job property <code>task_queues</code> has been introduced to allow Nautobot to leverage custom Celery queues for jobs. This will allow you to send jobs to specific workers based on which queue is selected. This property can be set on the job class and overridden in the job model, similar to other overridable job fields. If <code>task_queues</code> is not defined on the job class or job model, the job will only be able to use the default queue. A new field has been added to the job run form to allow you to select a queue when you run the job and  an optional field <code>task_queue</code> has been added to the REST API <a href="../user-guide/platform-functionality/jobs/index.html#via-the-rest-api">job run endpoint</a> for the same purpose.</p>
 <div class="admonition important">
 <p class="admonition-title">Important</p>
-<p>The default celery queue name has been changed from <code>celery</code> to <code>default</code>. If you have any workers or tasks hard coded to use <code>celery</code> you will need to update those workers/tasks or change the <a href="../user-guide/administration/configuration/settings.html#celery_task_default_queue"><code>CELERY_TASK_DEFAULT_QUEUE</code></a> setting in your <code>nautobot_config.py</code>.</p>
+<p>The default Celery queue name has been changed from <code>celery</code> to <code>default</code>. If you have any workers or tasks hard coded to use <code>celery</code> you will need to update those workers/tasks or change the <a href="../user-guide/administration/configuration/settings.html#celery_task_default_queue"><code>CELERY_TASK_DEFAULT_QUEUE</code></a> setting in your <code>nautobot_config.py</code>.</p>
 </div>
 <h4 id="device-redundancy-groups-1892">Device Redundancy Groups (<a href="https://github.com/nautobot/nautobot/issues/1892">#1892</a>)<a class="headerlink" href="#device-redundancy-groups-1892" title="Permanent link">&para;</a></h4>
 <p>Device Redundancy Groups have been added to model groups of distinct devices that perform device clustering or failover high availability functions. This may be used to model whole device redundancy strategies across devices with separate control planes (ex: ASA failover), not devices that share a control plane (ex: stackwise switch stacks), or interface specific redundancy strategies (ex: hsrp). Device Redundancy Groups support grouping an arbitrary number of devices and may be assigned an optional secrets group and one or more optional failover strategies.</p>
@@ -12480,7 +12480,7 @@ relationship:</p>
 <ul>
 <li><a href="https://github.com/nautobot/nautobot/issues/3806">#3806</a> - Added instructions and examples for SAML SSO using Okta as the IdP.</li>
 <li><a href="https://github.com/nautobot/nautobot/issues/3811">#3811</a> - Added a note that addresses UWSGI buffer size concerns with Azure SSO in <code>nautobot/docs/user-guide/administration/configuration/authentication/sso.md</code>.</li>
-<li><a href="https://github.com/nautobot/nautobot/issues/3888">#3888</a> - Changed note for celery concurrency in the docs.</li>
+<li><a href="https://github.com/nautobot/nautobot/issues/3888">#3888</a> - Changed note for Celery concurrency in the docs.</li>
 </ul>
 <h2 id="v1520-2023-05-30">v1.5.20 (2023-05-30)<a class="headerlink" href="#v1520-2023-05-30" title="Permanent link">&para;</a></h2>
 <h3 id="changed-in-v1520">Changed in v1.5.20<a class="headerlink" href="#changed-in-v1520" title="Permanent link">&para;</a></h3>
@@ -12633,7 +12633,7 @@ relationship:</p>
 <h3 id="documentation-in-v1515">Documentation in v1.5.15<a class="headerlink" href="#documentation-in-v1515" title="Permanent link">&para;</a></h3>
 <ul>
 <li><a href="https://github.com/nautobot/nautobot/issues/3384">#3384</a> - Removed documentation about <code>block sidebar</code> from <code>docs/development/templates.md</code>.</li>
-<li><a href="https://github.com/nautobot/nautobot/issues/3446">#3446</a> - Added documentation links for Device Onboarding and LifeCycle Management plugins to docs.nautobot.com menu.</li>
+<li><a href="https://github.com/nautobot/nautobot/issues/3446">#3446</a> - Added documentation links for Device Onboarding and LifeCycle Management plugins to <code>docs.nautobot.com</code> menu.</li>
 </ul>
 <h3 id="housekeeping-in-v1515">Housekeeping in v1.5.15<a class="headerlink" href="#housekeeping-in-v1515" title="Permanent link">&para;</a></h3>
 <ul>
@@ -12790,7 +12790,7 @@ relationship:</p>
 <ul>
 <li><a href="https://github.com/nautobot/nautobot/issues/3114">#3114</a> - Fixed Navbar scroll through top-level menu in low resolution desktop screens.</li>
 <li><a href="https://github.com/nautobot/nautobot/issues/3155">#3155</a> - Aligned buttons on device component create page.</li>
-<li><a href="https://github.com/nautobot/nautobot/issues/3169">#3169</a> - Fixed data mismatch in <code>ScheduledJob</code> causing celery workers to fail when running scheduled jobs created in versions prior to <code>v1.5.8</code>. ⚠ <strong>NOTE</strong>: If your celery workers are failing on startup after upgrading to <code>v1.5.8</code>, you may need to purge the celery queue with <code>nautobot-server celery purge</code> or <code>nautobot-server celery purge -Q &lt;queues&gt;</code> to purge custom queues.</li>
+<li><a href="https://github.com/nautobot/nautobot/issues/3169">#3169</a> - Fixed data mismatch in <code>ScheduledJob</code> causing Celery workers to fail when running scheduled jobs created in versions prior to <code>v1.5.8</code>. ⚠ <strong>NOTE</strong>: If your Celery workers are failing on startup after upgrading to <code>v1.5.8</code>, you may need to purge the Celery queue with <code>nautobot-server celery purge</code> or <code>nautobot-server celery purge -Q &lt;queues&gt;</code> to purge custom queues.</li>
 </ul>
 <h3 id="dependencies-in-v159">Dependencies in v1.5.9<a class="headerlink" href="#dependencies-in-v159" title="Permanent link">&para;</a></h3>
 <ul>
@@ -12973,8 +12973,8 @@ relationship:</p>
 <li><a href="https://github.com/nautobot/nautobot/issues/899">#899</a> - Added support for grouping of Custom Fields.</li>
 <li><a href="https://github.com/nautobot/nautobot/issues/1468">#1468</a> - Added relationship columns to ObjectListTableView and disabled sorting.</li>
 <li><a href="https://github.com/nautobot/nautobot/issues/1892">#1892</a> - Added <code>DeviceRedundancyGroup</code> model for representing a logical grouping of physical hardware for the purposes of high-availability.</li>
-<li><a href="https://github.com/nautobot/nautobot/issues/2063">#2063</a> - Added documentation and initial support for custom celery queues.</li>
-<li><a href="https://github.com/nautobot/nautobot/issues/2064">#2064</a> - Added <code>task_queues</code> job property to support custom celery queues.</li>
+<li><a href="https://github.com/nautobot/nautobot/issues/2063">#2063</a> - Added documentation and initial support for custom Celery queues.</li>
+<li><a href="https://github.com/nautobot/nautobot/issues/2064">#2064</a> - Added <code>task_queues</code> job property to support custom Celery queues.</li>
 <li><a href="https://github.com/nautobot/nautobot/issues/2460">#2460</a> - Added search box filter form to generic list views.</li>
 <li><a href="https://github.com/nautobot/nautobot/issues/2518">#2518</a> - Added <code>base_site</code> and <code>subtree</code> filters to <code>LocationFilterSet</code>, allowing for filtering Locations by their root ancestor or its Site.</li>
 <li><a href="https://github.com/nautobot/nautobot/issues/2536">#2536</a> - Added <code>nautobot-server generate_test_data</code> command.</li>
@@ -12987,7 +12987,7 @@ relationship:</p>
 <li><a href="https://github.com/nautobot/nautobot/issues/1892">#1892</a> - Updated <code>Device</code> to have <code>device_redundancy_group</code> relationship, <code>device_redundancy_group_priority</code> numeric property.</li>
 <li><a href="https://github.com/nautobot/nautobot/issues/1892">#1892</a> - Updated <code>ConfigContext</code> to have <code>ManyToManyField</code> to <code>dcim.DeviceRedundancyGroup</code> for the purposes of applying a <code>ConfigContext</code> based upon a <code>Device</code>s <code>DeviceRedundancyGroup</code> membership.</li>
 <li><a href="https://github.com/nautobot/nautobot/issues/1998">#1998</a> - Added DynamicFilterForm to list views.</li>
-<li><a href="https://github.com/nautobot/nautobot/issues/2064">#2064</a> - Changed default celery queue name from <code>celery</code> to <code>default</code>.</li>
+<li><a href="https://github.com/nautobot/nautobot/issues/2064">#2064</a> - Changed default Celery queue name from <code>celery</code> to <code>default</code>.</li>
 <li><a href="https://github.com/nautobot/nautobot/issues/2615">#2615</a> - Changed <code>ConfigContextFilterForm</code>s <code>schema</code> filter form field to support added filter field on <code>ConfigContextFilterSet</code>.</li>
 <li><a href="https://github.com/nautobot/nautobot/issues/2615">#2615</a> - Changed <code>BaseNetworkQuerySet</code> and <code>IPAddressQuerySet</code> to search both IPv6 and IPv4 when given search string is ambiguous.</li>
 </ul>

nautobot/project-static/docs/release-notes/version-1.6.html

@@ -12141,7 +12141,7 @@
 <h3 id="security-in-v1629">Security in v1.6.29<a class="headerlink" href="#security-in-v1629" title="Permanent link">&para;</a></h3>
 <ul>
 <li><a href="https://github.com/nautobot/nautobot/issues/5911">#5911</a> - Updated <code>zipp</code> to <code>3.19.2</code> to address <code>CVE-2024-5569</code>. This is not a direct dependency so it will not auto-update when upgrading. Please be sure to upgrade your local environment.</li>
-<li><a href="https://github.com/nautobot/nautobot/issues/6625">#6625</a> - Patched <code>set_values()</code> method of Query class from django.db.models.sql.query to address <code>CVE-2024-42005</code>.</li>
+<li><a href="https://github.com/nautobot/nautobot/issues/6625">#6625</a> - Patched <code>set_values()</code> method of <code>Query</code> class from <code>django.db.models.sql.query</code> to address <code>CVE-2024-42005</code>.</li>
 </ul>
 <h3 id="fixed-in-v1629">Fixed in v1.6.29<a class="headerlink" href="#fixed-in-v1629" title="Permanent link">&para;</a></h3>
 <ul>
@@ -12358,7 +12358,7 @@
 </ul>
 <h3 id="added-in-v1611">Added in v1.6.11<a class="headerlink" href="#added-in-v1611" title="Permanent link">&para;</a></h3>
 <ul>
-<li><a href="https://github.com/nautobot/nautobot/issues/5169">#5169</a> - Added support for user session profiling via django-silk.</li>
+<li><a href="https://github.com/nautobot/nautobot/issues/5169">#5169</a> - Added support for user session profiling via <code>django-silk</code>.</li>
 </ul>
 <h3 id="fixed-in-v1611">Fixed in v1.6.11<a class="headerlink" href="#fixed-in-v1611" title="Permanent link">&para;</a></h3>
 <ul>
@@ -12587,8 +12587,8 @@
 </ul>
 <h3 id="dependencies-in-v160">Dependencies in v1.6.0<a class="headerlink" href="#dependencies-in-v160" title="Permanent link">&para;</a></h3>
 <ul>
-<li><a href="https://github.com/nautobot/nautobot/issues/4208">#4208</a> - Updated django-rq to 2.8.1.</li>
-<li><a href="https://github.com/nautobot/nautobot/issues/4209">#4209</a> - Relaxed constraint on prometheus-client minimum version to <code>0.14.1</code>.</li>
+<li><a href="https://github.com/nautobot/nautobot/issues/4208">#4208</a> - Updated <code>django-rq</code> to 2.8.1.</li>
+<li><a href="https://github.com/nautobot/nautobot/issues/4209">#4209</a> - Relaxed constraint on <code>prometheus-client</code> minimum version to <code>0.14.1</code>.</li>
 <li><a href="https://github.com/nautobot/nautobot/issues/4173">#4173</a> - Updated <code>drf-spectacular</code> to <code>0.26.4</code>.</li>
 <li><a href="https://github.com/nautobot/nautobot/issues/4199">#4199</a> - Updated <code>cryptography</code> to <code>~41.0.3</code>. As this is not a direct dependency of Nautobot, it will not auto-update when upgrading. Please be sure to upgrade your local environment.</li>
 <li><a href="https://github.com/nautobot/nautobot/issues/4215">#4215</a> - Broadened the range of acceptable <code>packaging</code> dependency versions.</li>