Skip to content

Commit a6a1bec

Browse files
committed
Closes #9218: Update documentation links with docs.netbox.dev
1 parent 562d1bf commit a6a1bec

16 files changed

+20
-20
lines changed

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
The changelog has been moved to the [project release notes](https://netbox.readthedocs.io/en/stable/release-notes/).
1+
The changelog has been moved to the [project release notes](https://docs.netbox.dev/en/stable/release-notes/).

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ appropriate labels will be applied for categorization.
9999
## Submitting Pull Requests
100100

101101
* If you're interested in contributing to NetBox, be sure to check out our
102-
[getting started](https://netbox.readthedocs.io/en/stable/development/getting-started/)
102+
[getting started](https://docs.netbox.dev/en/stable/development/getting-started/)
103103
documentation for tips on setting up your development environment.
104104

105105
* Be sure to open an issue **before** starting work on a pull request, and
@@ -171,7 +171,7 @@ an effort to circumvent the bot: Doing so will not remove the stale label.
171171
the understanding that all contributions are submitted under the Apache 2.0
172172
license and that your employer may not make claim to any contributions.
173173
Contributions include code work, issue management, and community support. All
174-
development must be in accordance with our [development guidance](https://netbox.readthedocs.io/en/stable/development/).
174+
development must be in accordance with our [development guidance](https://docs.netbox.dev/en/stable/development/).
175175

176176
* Maintainers are expected to attend (where feasible) our biweekly ~30-minute
177177
sync to review agenda items. This meeting provides opportunity to present and

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ NetBox runs as a web application atop the [Django](https://www.djangoproject.com
4949
Python framework with a [PostgreSQL](https://www.postgresql.org/) database. For a
5050
complete list of requirements, see `requirements.txt`. The code is available [on GitHub](https://github.com/netbox-community/netbox).
5151

52-
The complete documentation for NetBox can be found at [Read the Docs](https://netbox.readthedocs.io/en/stable/). A public demo instance is available at https://demo.netbox.dev.
52+
The complete documentation for NetBox can be found at [docs.netbox.dev](https://docs.netbox.dev/). A public demo instance is available at https://demo.netbox.dev.
5353

5454
<div align="center">
5555
<h4>Thank you to our sponsors!</h4>
@@ -71,7 +71,7 @@ The complete documentation for NetBox can be found at [Read the Docs](https://ne
7171

7272
### Installation
7373

74-
Please see [the documentation](https://netbox.readthedocs.io/en/stable/) for
74+
Please see [the documentation](https://docs.netbox.dev/) for
7575
instructions on installing NetBox. To upgrade NetBox, please download the
7676
[latest release](https://github.com/netbox-community/netbox/releases) and
7777
run `upgrade.sh`.

contrib/netbox-rq.service

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[Unit]
22
Description=NetBox Request Queue Worker
3-
Documentation=https://netbox.readthedocs.io/en/stable/
3+
Documentation=https://docs.netbox.dev/
44
After=network-online.target
55
Wants=network-online.target
66

contrib/netbox.service

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[Unit]
22
Description=NetBox WSGI Service
3-
Documentation=https://netbox.readthedocs.io/en/stable/
3+
Documentation=https://docs.netbox.dev/
44
After=network-online.target
55
Wants=network-online.target
66

docs/installation/4-gunicorn.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ You should see output similar to the following:
4040
● netbox.service - NetBox WSGI Service
4141
Loaded: loaded (/etc/systemd/system/netbox.service; enabled; vendor preset: enabled)
4242
Active: active (running) since Mon 2021-08-30 04:02:36 UTC; 14h ago
43-
Docs: https://netbox.readthedocs.io/en/stable/
43+
Docs: https://docs.netbox.dev/
4444
Main PID: 1140492 (gunicorn)
4545
Tasks: 19 (limit: 4683)
4646
Memory: 666.2M

docs/installation/migrating-to-systemd.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ You can use the command `systemctl status netbox` to verify that the WSGI servic
3939
● netbox.service - NetBox WSGI Service
4040
Loaded: loaded (/etc/systemd/system/netbox.service; enabled; vendor preset: enabled)
4141
Active: active (running) since Sat 2020-10-24 19:23:40 UTC; 25s ago
42-
Docs: https://netbox.readthedocs.io/en/stable/
42+
Docs: https://docs.netbox.dev/
4343
Main PID: 11993 (gunicorn)
4444
Tasks: 6 (limit: 2362)
4545
CGroup: /system.slice/netbox.service

docs/release-notes/version-2.1.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ A new API endpoint has been added at `/api/ipam/prefixes/<pk>/available-ips/`. A
121121

122122
#### NAPALM Integration ([#1348](https://github.com/netbox-community/netbox/issues/1348))
123123

124-
The [NAPALM automation](https://github.com/napalm-automation/napalm) library provides an abstracted interface for pulling live data (e.g. uptime, software version, running config, LLDP neighbors, etc.) from network devices. The NetBox API has been extended to support executing read-only NAPALM methods on devices defined in NetBox. To enable this functionality, ensure that NAPALM has been installed (`pip install napalm`) and the `NETBOX_USERNAME` and `NETBOX_PASSWORD` [configuration parameters](https://netbox.readthedocs.io/en/stable/configuration/optional-settings/#netbox_username) have been set in configuration.py.
124+
The [NAPALM automation](https://github.com/napalm-automation/napalm) library provides an abstracted interface for pulling live data (e.g. uptime, software version, running config, LLDP neighbors, etc.) from network devices. The NetBox API has been extended to support executing read-only NAPALM methods on devices defined in NetBox. To enable this functionality, ensure that NAPALM has been installed (`pip install napalm`) and the `NETBOX_USERNAME` and `NETBOX_PASSWORD` [configuration parameters](https://docs.netbox.dev/en/stable/configuration/optional-settings/#netbox_username) have been set in configuration.py.
125125

126126
### Enhancements
127127

docs/release-notes/version-2.2.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ Our second-most popular feature request has arrived! NetBox now supports the cre
196196

197197
#### Custom Validation Reports ([#1511](https://github.com/netbox-community/netbox/issues/1511))
198198

199-
Users can now create custom reports which are run to validate data in NetBox. Reports work very similar to Python unit tests: Each report inherits from NetBox's Report class and contains one or more test method. Reports can be run and retrieved via the web UI, API, or CLI. See [the docs](https://netbox.readthedocs.io/en/stable/miscellaneous/reports/) for more info.
199+
Users can now create custom reports which are run to validate data in NetBox. Reports work very similar to Python unit tests: Each report inherits from NetBox's Report class and contains one or more test method. Reports can be run and retrieved via the web UI, API, or CLI. See [the docs](https://docs.netbox.dev/en/stable/miscellaneous/reports/) for more info.
200200

201201
### Enhancements
202202

docs/release-notes/version-2.5.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,7 @@ This release upgrades the Django framework to version 2.2.
295295

296296
#### Python 3 Required
297297

298-
As promised, Python 2 support has been completed removed. Python 3.5 or higher is now required to run NetBox. Please see [our Python 3 migration guide](https://netbox.readthedocs.io/en/stable/installation/migrating-to-python3/) for assistance with upgrading.
298+
As promised, Python 2 support has been completed removed. Python 3.5 or higher is now required to run NetBox. Please see [our Python 3 migration guide](https://docs.netbox.dev/en/stable/installation/migrating-to-python3/) for assistance with upgrading.
299299

300300
#### Removed Deprecated User Activity Log
301301

docs/release-notes/version-2.6.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@
218218

219219
#### Custom Scripts ([#3415](https://github.com/netbox-community/netbox/issues/3415))
220220

221-
Custom scripts allow for the execution of arbitrary code via the NetBox UI. They can be used to automatically create, manipulate, or clean up objects or perform other tasks within NetBox. Scripts are defined as Python files which contain one or more subclasses of `extras.scripts.Script`. Variable fields can be defined within scripts, which render as form fields within the web UI to prompt the user for input data. Scripts are executed and information is logged via the web UI. Please see [the docs](https://netbox.readthedocs.io/en/stable/customization/custom-scripts/) for more detail.
221+
Custom scripts allow for the execution of arbitrary code via the NetBox UI. They can be used to automatically create, manipulate, or clean up objects or perform other tasks within NetBox. Scripts are defined as Python files which contain one or more subclasses of `extras.scripts.Script`. Variable fields can be defined within scripts, which render as form fields within the web UI to prompt the user for input data. Scripts are executed and information is logged via the web UI. Please see [the docs](https://docs.netbox.dev/en/stable/customization/custom-scripts/) for more detail.
222222

223223
Note: There are currently no API endpoints for this feature. These are planned for the upcoming v2.7 release.
224224

docs/release-notes/version-2.7.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767

6868
## v2.7.9 (2020-03-06)
6969

70-
**Note:** This release will deploy a Python virtual environment on upgrade in the `venv/` directory. This will require modifying the paths to your Python and gunicorn executables in the systemd service files. For more detail, please see the [upgrade instructions](https://netbox.readthedocs.io/en/stable/installation/upgrading/).
70+
**Note:** This release will deploy a Python virtual environment on upgrade in the `venv/` directory. This will require modifying the paths to your Python and gunicorn executables in the systemd service files. For more detail, please see the [upgrade instructions](https://docs.netbox.dev/en/stable/installation/upgrading/).
7171

7272
### Enhancements
7373

@@ -418,7 +418,7 @@ to another source before upgrading NetBox to v2.7, as any existing topology maps
418418

419419
#### Supervisor Replaced with systemd ([#2902](https://github.com/netbox-community/netbox/issues/2902))
420420

421-
The NetBox [installation documentation](https://netbox.readthedocs.io/en/stable/installation/) has been updated to
421+
The NetBox [installation documentation](https://docs.netbox.dev/en/stable/installation/) has been updated to
422422
provide instructions for managing the WSGI and RQ services using systemd instead of supervisor. This removes the need to
423423
install supervisor and simplifies administration of the processes.
424424

docs/release-notes/version-2.8.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -235,14 +235,14 @@ This release introduces support for custom plugins, which can be used to extend
235235
* Introduce new API endpoints
236236
* Add custom request/response middleware
237237

238-
For NetBox plugins to be recognized, they must be installed and added by name to the `PLUGINS` configuration parameter. (Plugin support is disabled by default.) Plugins can be configured under the `PLUGINS_CONFIG` parameter. More information can be found the in the [plugins documentation](https://netbox.readthedocs.io/en/stable/plugins/).
238+
For NetBox plugins to be recognized, they must be installed and added by name to the `PLUGINS` configuration parameter. (Plugin support is disabled by default.) Plugins can be configured under the `PLUGINS_CONFIG` parameter. More information can be found the in the [plugins documentation](https://docs.netbox.dev/en/stable/plugins/).
239239

240240
### Enhancements
241241

242242
* [#1754](https://github.com/netbox-community/netbox/issues/1754) - Added support for nested rack groups
243243
* [#3939](https://github.com/netbox-community/netbox/issues/3939) - Added support for nested tenant groups
244244
* [#4078](https://github.com/netbox-community/netbox/issues/4078) - Standardized description fields across all models
245-
* [#4195](https://github.com/netbox-community/netbox/issues/4195) - Enabled application logging (see [logging configuration](https://netbox.readthedocs.io/en/stable/configuration/optional-settings/#logging))
245+
* [#4195](https://github.com/netbox-community/netbox/issues/4195) - Enabled application logging (see [logging configuration](https://docs.netbox.dev/en/stable/configuration/optional-settings/#logging))
246246

247247
### Bug Fixes
248248

mkdocs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
site_name: NetBox Documentation
22
site_dir: netbox/project-static/docs
3-
site_url: https://netbox.readthedocs.io/
3+
site_url: https://docs.netbox.dev/
44
repo_name: netbox-community/netbox
55
repo_url: https://github.com/netbox-community/netbox
66
theme:

netbox/templates/home.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ <h6 class="alert-heading">
1313
<small><a href="{{ new_release.url }}">NetBox v{{ new_release.version }}</a> is available.</small>
1414
<hr class="my-2" />
1515
<small class="mb-0">
16-
<a href="https://netbox.readthedocs.io/en/stable/installation/upgrading/">Upgrade Instructions</a>
16+
<a href="https://docs.netbox.dev/en/stable/installation/upgrading/">Upgrade Instructions</a>
1717
</small>
1818
</div>
1919
</div>

netbox/templates/media_failure.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ <h3>
2929
</li>
3030
<li class="tip">
3131
The HTTP service (e.g. nginx or Apache) is configured to serve files from the <code>STATIC_ROOT</code> path.
32-
Refer to <a href="https://netbox.readthedocs.io/en/stable/installation/">the installation
32+
Refer to <a href="https://docs.netbox.dev/en/stable/installation/">the installation
3333
documentation</a> for further guidance.
3434
<ul>
3535
{% if request.user.is_staff or request.user.is_superuser %}

0 commit comments

Comments
 (0)