Jelajahi Sumber

Refresh the documentation landing page & README (#23545)

Jeremy Stretch 1 hari lalu
induk
melakukan
64253e00ce

+ 1 - 1
CHANGELOG.md

@@ -1 +1 @@
-The changelog has been moved to the [project release notes](https://docs.netbox.dev/en/stable/release-notes/).
+The changelog has been moved to the [project release notes](https://netboxlabs.com/docs/netbox/release-notes/).

+ 2 - 2
CONTRIBUTING.md

@@ -111,12 +111,12 @@ intake policy](https://github.com/netbox-community/netbox/wiki/Issue-Intake-Poli
 
 
 * Some other tips to keep in mind:
 * Some other tips to keep in mind:
   * If you'd like to volunteer for someone else's issue, please post a comment on that issue letting us know. (GitHub allows only people who have commented on an issue to be assigned as its owner.)
   * If you'd like to volunteer for someone else's issue, please post a comment on that issue letting us know. (GitHub allows only people who have commented on an issue to be assigned as its owner.)
-  * Check out our [developer docs](https://docs.netbox.dev/en/stable/development/getting-started/) for tips on setting up your development environment.
+  * Check out our [developer docs](https://netboxlabs.com/docs/netbox/development/getting-started/) for tips on setting up your development environment.
   * All new functionality must include relevant tests where applicable.
   * All new functionality must include relevant tests where applicable.
 
 
 ## :jigsaw: Creating Plugins
 ## :jigsaw: Creating Plugins
 
 
-Do you have an idea for something you'd like to build in NetBox, but might not be right for the core project? NetBox includes a powerful and extensive [plugins framework](https://docs.netbox.dev/en/stable/plugins/) that enables users to develop their own custom data models and integrations.
+Do you have an idea for something you'd like to build in NetBox, but might not be right for the core project? NetBox includes a powerful and extensive [plugins framework](https://netboxlabs.com/docs/netbox/plugins/) that enables users to develop their own custom data models and integrations.
 
 
 Check out our [plugin development tutorial](https://github.com/netbox-community/netbox-plugin-tutorial) to get started!
 Check out our [plugin development tutorial](https://github.com/netbox-community/netbox-plugin-tutorial) to get started!
 
 

+ 18 - 11
README.md

@@ -14,7 +14,7 @@
   </p>
   </p>
 </div>
 </div>
 
 
-NetBox exists to empower network engineers. Since its release in 2016, it has become the go-to solution for modeling and documenting network infrastructure for thousands of organizations worldwide. As a successor to legacy IPAM and DCIM applications, NetBox provides a cohesive, extensive, and accessible data model for all things networked. By providing a single robust user interface and programmable APIs for everything from cable maps to device configurations, NetBox serves as the central source of truth for the modern network.
+NetBox exists to empower network engineers. For over a decade, it has been the go-to solution for modeling and documenting network infrastructure for thousands of organizations worldwide. NetBox offers a cohesive, extensive, and accessible data model for all things networked. By providing a single robust user interface and programmable APIs for everything from cable maps to device configurations, NetBox serves as the central source of truth for the modern network. It also forms the heart of the [NetBox Labs](https://netboxlabs.com/) platform, alongside [network discovery](https://netboxlabs.com/products/netbox-discovery/), [assurance](https://netboxlabs.com/products/netbox-assurance/), and [observability](https://netboxlabs.com/products/netbox-observability/).
 
 
 <p align="center">
 <p align="center">
   <a href="#netboxs-role">NetBox's Role</a> |
   <a href="#netboxs-role">NetBox's Role</a> |
@@ -43,11 +43,11 @@ The diagram above illustrates the recommended deployment architecture for an aut
 
 
 ### Comprehensive Data Model
 ### Comprehensive Data Model
 
 
-Racks, devices, cables, IP addresses, VLANs, circuits, power, VPNs, and lots more: NetBox is built for networks. Its comprehensive and thoroughly inter-linked data model provides for natural and highly structured modeling of myriad network primitives that just isn't possible using general-purpose tools. And there's no need to waste time contemplating how to build out a database: Everything is ready to go upon installation.
+Racks, devices, cables, IP addresses, VLANs, circuits, power, cooling, VPNs, and lots more: NetBox is built for networks. Its comprehensive and thoroughly inter-linked data model provides for natural and highly structured modeling of myriad network primitives that just isn't possible using general-purpose tools. And there's no need to waste time contemplating how to build out a database: Everything is ready to go upon installation.
 
 
 ### Focused Development
 ### Focused Development
 
 
-NetBox strives to meet a singular goal: Provide the best available solution for making network infrastructure programmatically accessible. Unlike "all-in-one" tools which awkwardly bolt on half-baked features in an attempt to check every box, NetBox is committed to its core function. NetBox provides the best possible solution for modeling network infrastructure, and provides rich APIs for integrating with tools that excel in other areas of network automation.
+NetBox strives to meet a singular goal: Provide the best available solution for making network infrastructure programmatically accessible. Unlike "all-in-one" tools which awkwardly bolt on half-baked features in an attempt to check every box, NetBox is committed to its core function. It focuses on modeling network infrastructure, and provides rich APIs for integrating with tools that excel in other areas of network automation.
 
 
 ### Extensible and Customizable
 ### Extensible and Customizable
 
 
@@ -63,7 +63,7 @@ The data you put into NetBox is crucial to network operations. In addition to it
 
 
 ### Device Configuration Rendering
 ### Device Configuration Rendering
 
 
-NetBox can render user-created Jinja2 templates to generate device configurations from its own data. Configuration templates can be uploaded individually or pulled automatically from an external source, such as a git repository. Rendered configurations can be retrieved via the REST API for application directly to network devices via a provisioning tool such as Ansible or Salt.
+NetBox can render user-created Jinja2 templates to generate device configurations from its own data. Configuration templates can be uploaded individually or pulled automatically from an external source, such as a Git repository. Rendered configurations can be retrieved via the REST API for application directly to network devices via a provisioning tool such as Ansible or Salt.
 
 
 ### Custom Scripts
 ### Custom Scripts
 
 
@@ -78,27 +78,34 @@ Users can define event rules to automatically trigger a custom script or outboun
 NetBox automatically logs the creation, modification, and deletion of all managed objects, providing a thorough change history. Changes can be attributed to the executing user, and related changes are grouped automatically by request ID.
 NetBox automatically logs the creation, modification, and deletion of all managed objects, providing a thorough change history. Changes can be attributed to the executing user, and related changes are grouped automatically by request ID.
 
 
 > [!NOTE]
 > [!NOTE]
-> A complete list of NetBox's myriad features can be found in [the introductory documentation](https://docs.netbox.dev/en/stable/introduction/).
+> A complete list of NetBox's myriad features can be found in [the introductory documentation](https://netboxlabs.com/docs/netbox/introduction/).
 
 
 ## Getting Started
 ## Getting Started
 
 
 * Just want to explore? Check out [our public demo](https://demo.netbox.dev/) right now!
 * Just want to explore? Check out [our public demo](https://demo.netbox.dev/) right now!
-* The [official documentation](https://docs.netbox.dev) offers a comprehensive introduction.
-* Check out [our wiki](https://github.com/netbox-community/netbox/wiki/Community-Contributions) for even more projects to get the most out of NetBox!
+* Ready to dive in? Grab your own [NetBox Cloud Free Tier](https://signup.netboxlabs.com/) instance in just a few minutes.
+* The [installation guide](https://netboxlabs.com/docs/netbox/installation/) will help you get your own deployment up and running.
+* Or try the community [Docker image](https://github.com/netbox-community/netbox-docker) for a low-touch, containerized approach.
+* The [official documentation](https://netboxlabs.com/docs/netbox/) offers a comprehensive introduction.
 
 
 ## Plugins
 ## Plugins
 
 
-NetBox's functionality can be extended through plugins, which add new models, views, and integrations on top of the core application. A few of the most popular plugins include:
+NetBox's functionality can be extended through plugins, which add new models, views, and integrations on top of the core application. A few notable plugins include:
 
 
-* [NetBox Branching](https://github.com/netboxlabs/netbox-branching) — Work with isolated, mergeable branches of your NetBox data
-* [NetBox Custom Objects](https://github.com/netboxlabs/netbox-custom-objects) — Define entirely new object types directly in the UI
+* [NetBox Branching](https://netboxlabs.com/docs/branching/) — Work with isolated, mergeable branches of your NetBox data
+* [NetBox Change Management](https://netboxlabs.com/docs/changes/) — Enforce review and approval policies on changes proposed in branches (Cloud & Enterprise)
+* [NetBox Custom Objects](https://netboxlabs.com/docs/custom-objects/) — Dynamically create new object types to extend the NetBox schema
+* [NetBox Asset Lifecycle](https://netboxlabs.com/docs/asset-lifecycle/) — Track equipment procurement from bills of materials through purchase orders and shipments (Cloud & Enterprise)
+* [NetBox NDX](https://netboxlabs.com/docs/ndx/) — Automatically import devices, modules, and more from the [NetBox Data Exchange](https://netboxlabs.com/ndx/) (Cloud & Enterprise)
 * [NetBox DNS](https://github.com/sys4/netbox-plugin-dns) — Manage DNS zones and records as an authoritative source of truth
 * [NetBox DNS](https://github.com/sys4/netbox-plugin-dns) — Manage DNS zones and records as an authoritative source of truth
 * [NetBox BGP](https://github.com/netbox-community/netbox-bgp) — Document and manage BGP sessions and routing policies
 * [NetBox BGP](https://github.com/netbox-community/netbox-bgp) — Document and manage BGP sessions and routing policies
+* [NetBox WDM](https://github.com/jsenecal/netbox-wdm) — Manage WDM wavelengths, ITU channel plans, and wavelength services
+* [NetBox Security](https://github.com/andy-shady-org/netbox-security/) — Model firewall, security, and NAT policies
 * [Browse all plugins](https://netboxlabs.com/plugins/) — Discover the full catalog of available plugins
 * [Browse all plugins](https://netboxlabs.com/plugins/) — Discover the full catalog of available plugins
 
 
 ## Get Involved
 ## Get Involved
 
 
-* Follow [@NetBoxOfficial](https://twitter.com/NetBoxOfficial) on Twitter!
+* Follow [@NetBoxOfficial](https://x.com/NetBoxOfficial) on X!
 * Join the conversation on [the discussion forum](https://github.com/netbox-community/netbox/discussions) and [Slack](https://netdev.chat/)!
 * Join the conversation on [the discussion forum](https://github.com/netbox-community/netbox/discussions) and [Slack](https://netdev.chat/)!
 * Already a power user? You can [suggest a feature](https://github.com/netbox-community/netbox/issues/new?assignees=&labels=type%3A+feature&template=feature_request.yaml) or [report a bug](https://github.com/netbox-community/netbox/issues/new?assignees=&labels=type%3A+bug&template=bug_report.yaml) on GitHub.
 * Already a power user? You can [suggest a feature](https://github.com/netbox-community/netbox/issues/new?assignees=&labels=type%3A+feature&template=feature_request.yaml) or [report a bug](https://github.com/netbox-community/netbox/issues/new?assignees=&labels=type%3A+bug&template=bug_report.yaml) on GitHub.
 * Contributions from the community are encouraged and appreciated! Check out our [contributing guide](CONTRIBUTING.md) to get started.
 * Contributions from the community are encouraged and appreciated! Check out our [contributing guide](CONTRIBUTING.md) to get started.

+ 1 - 1
contrib/netbox-rq.service

@@ -1,6 +1,6 @@
 [Unit]
 [Unit]
 Description=NetBox Request Queue Worker
 Description=NetBox Request Queue Worker
-Documentation=https://docs.netbox.dev/
+Documentation=https://netboxlabs.com/docs/netbox/
 After=network-online.target
 After=network-online.target
 Wants=network-online.target
 Wants=network-online.target
 
 

+ 1 - 1
contrib/netbox.service

@@ -1,6 +1,6 @@
 [Unit]
 [Unit]
 Description=NetBox WSGI Service
 Description=NetBox WSGI Service
-Documentation=https://docs.netbox.dev/
+Documentation=https://netboxlabs.com/docs/netbox/
 After=network-online.target
 After=network-online.target
 Wants=network-online.target
 Wants=network-online.target
 
 

+ 57 - 15
docs/index.md

@@ -3,54 +3,96 @@
 
 
 # The Premier Network Source of Truth
 # The Premier Network Source of Truth
 
 
-NetBox is the leading solution for modeling and documenting modern networks. By combining the traditional disciplines of IP address management (IPAM) and datacenter infrastructure management (DCIM) with powerful APIs and extensions, NetBox provides the ideal "source of truth" to power network automation. Read on to discover why thousands of organizations worldwide put NetBox at the heart of their infrastructure.
+NetBox is the leading solution for modeling and documenting modern networks. It forms the core of the [NetBox Labs](https://netboxlabs.com/) platform, alongside [network discovery](https://netboxlabs.com/products/netbox-discovery/), [assurance](https://netboxlabs.com/products/netbox-assurance/), and [observability](https://netboxlabs.com/products/netbox-observability/). By combining the traditional disciplines of IP address management (IPAM) and datacenter infrastructure management (DCIM) with powerful APIs and extensions, NetBox provides the ideal "source of truth" to power network automation. Read on to discover why thousands of organizations worldwide put NetBox at the heart of their infrastructure.
+
+NetBox is available in three editions:
+
+* [**NetBox Community**](https://netboxlabs.com/community/) - The free, open source edition, which you deploy and manage yourself
+* [**NetBox Cloud**](https://netboxlabs.com/netbox-cloud/) - A fully managed service hosted by NetBox Labs
+* [**NetBox Enterprise**](https://netboxlabs.com/netbox-enterprise/) - A self-hosted deployment of the NetBox Labs platform
 
 
 [![NetBox UI](./media/screenshots/home-light.png)](./media/screenshots/home-light.png)
 [![NetBox UI](./media/screenshots/home-light.png)](./media/screenshots/home-light.png)
 
 
 ## :material-server-network: Built for Networks
 ## :material-server-network: Built for Networks
 
 
-Unlike general-purpose configuration management databases (CMDBs), NetBox has curated a data model which caters specifically to the needs of network engineers and operators. It delivers a wide assortment of object types carefully crafted to best serve the needs of infrastructure design and documentation. These cover all facets of network technology, from IP address managements to cabling to overlays and more:
+Unlike general-purpose configuration management databases (CMDBs), NetBox has curated a data model which caters specifically to the needs of network engineers and operators. It delivers a wide assortment of object types carefully crafted to best serve the needs of infrastructure design and documentation. These cover all facets of network technology, from IP address management to cabling to overlays and more:
 
 
 * Hierarchical regions, sites, and locations
 * Hierarchical regions, sites, and locations
 * Racks, devices, and device components
 * Racks, devices, and device components
-* Cables and wireless connections
+* Device and module types for modular hardware
+* Virtual chassis and virtual device contexts
+* Cables and cable bundles
+* Wireless LANs and point-to-point links
 * Power distribution tracking
 * Power distribution tracking
-* Data circuits and providers
+* Data center cooling infrastructure
+* Physical and virtual circuits and providers
 * Virtual machines and clusters
 * Virtual machines and clusters
 * IP prefixes, ranges, and addresses
 * IP prefixes, ranges, and addresses
+* MAC addresses
 * VRFs and route targets
 * VRFs and route targets
 * FHRP groups (VRRP, HSRP, etc.)
 * FHRP groups (VRRP, HSRP, etc.)
-* AS numbers
-* VLANs and scoped VLAN groups
+* AS numbers and ranges
+* VLANs, scoped VLAN groups, and VLAN translation
 * L2VPN overlays
 * L2VPN overlays
+* VPN tunnels and IKE/IPSec policies
+* Application services
 * Tenancy assignments
 * Tenancy assignments
+* Resource ownership
 * Contact management
 * Contact management
 
 
 ## :material-hammer-wrench: Customizable & Extensible
 ## :material-hammer-wrench: Customizable & Extensible
 
 
-In addition to its expansive and robust data model, NetBox offers myriad mechanisms through which it can be customized and extended. Its powerful plugins architecture enables users to extend the application to meet their needs with minimal development effort.
+In addition to its expansive and robust data model, NetBox offers myriad mechanisms through which it can be customized and extended. Its powerful plugin architecture enables users to extend the application to meet their needs with minimal development effort.
 
 
 * Custom fields
 * Custom fields
-* Custom model validation
+* Tags
+* Custom links
+* Custom validation & protection rules
 * Export templates
 * Export templates
-* Event rules
+* Configuration contexts & templates
+* Custom scripts
+* Event rules & webhooks
+* Data synchronization from Git and S3
 * Plugins
 * Plugins
 * REST & GraphQL APIs
 * REST & GraphQL APIs
 
 
 ## :material-lock-open: Always Open
 ## :material-lock-open: Always Open
 
 
-Because NetBox is an open source application licensed under [Apache 2](https://www.apache.org/licenses/LICENSE-2.0.html), its entire code base is completely accessible to the end user, and there's never a risk of vendor lock-in. Additionally, NetBox development is an entirely public, community-driven process to which everyone can provide input.
+Because the core NetBox application is open source and licensed under [Apache 2](https://www.apache.org/licenses/LICENSE-2.0.html), its entire code base is completely accessible to the end user, and there's never a risk of vendor lock-in. Additionally, NetBox development is an entirely public, community-driven process to which everyone can provide input.
 
 
 !!! tip "NetBox Development"
 !!! tip "NetBox Development"
     Interested in contributing to NetBox? Check out our [GitHub repository](https://github.com/netbox-community/netbox) to get started!
     Interested in contributing to NetBox? Check out our [GitHub repository](https://github.com/netbox-community/netbox) to get started!
 
 
 ## :material-language-python: Powered by Python
 ## :material-language-python: Powered by Python
 
 
-NetBox is built on the enormously popular [Django](http://www.djangoproject.com/) framework for the Python programming language, already a favorite among network engineers. Users can leverage their existing skills coding Python tools to extend NetBox's already vast functionality via custom scripts and plugins.
+NetBox is built on the enormously popular [Django](https://www.djangoproject.com/) framework for the Python programming language, already a favorite among network engineers. Users can leverage their existing skills coding Python tools to extend NetBox's already vast functionality via custom scripts and plugins.
 
 
 ## :material-flag: Getting Started
 ## :material-flag: Getting Started
 
 
-* Try out our [public demo](https://demo.netbox.dev/) if you want to jump right in
-* The [installation guide](./installation/index.md) will help you get your own deployment up and running
-* Or try the community [Docker image](https://github.com/netbox-community/netbox-docker) for a low-touch approach
-* [NetBox Cloud](https://netboxlabs.com/netbox-cloud) is a managed solution offered by [NetBox Labs](https://netboxlabs.com/)
+<div class="grid cards" markdown>
+
+-   :material-cloud-outline:{ .lg .middle } __NetBox Cloud Free Tier__
+
+    ---
+
+    Skip the installation process and grab your own NetBox Cloud instance, preconfigured and ready to go in minutes. Completely free!
+
+    :octicons-arrow-right-24: [Sign Up](https://signup.netboxlabs.com/)
+
+-   :material-download:{ .lg .middle } __Install NetBox__
+
+    ---
+
+    Follow the installation guide to deploy NetBox Community on your own infrastructure.
+
+    :octicons-arrow-right-24: [Installation Guide](./installation/index.md)
+
+-   :material-docker:{ .lg .middle } __Docker Image__
+
+    ---
+
+    Use the community-maintained Docker image for a low-touch, containerized deployment.
+
+    :octicons-arrow-right-24: [NetBox Docker](https://github.com/netbox-community/netbox-docker)
+
+</div>

+ 1 - 1
docs/installation/4a-gunicorn.md

@@ -45,7 +45,7 @@ You should see output similar to the following:
 ● netbox.service - NetBox WSGI Service
 ● netbox.service - NetBox WSGI Service
      Loaded: loaded (/etc/systemd/system/netbox.service; enabled; preset: enabled)
      Loaded: loaded (/etc/systemd/system/netbox.service; enabled; preset: enabled)
      Active: active (running) since Mon 2026-01-26 11:00:00 CST; 7s ago
      Active: active (running) since Mon 2026-01-26 11:00:00 CST; 7s ago
-       Docs: https://docs.netbox.dev/
+       Docs: https://netboxlabs.com/docs/netbox/
    Main PID: 7283 (gunicorn)
    Main PID: 7283 (gunicorn)
       Tasks: 6 (limit: 4545)
       Tasks: 6 (limit: 4545)
      Memory: 556.1M (peak: 556.3M)
      Memory: 556.1M (peak: 556.3M)

+ 1 - 1
docs/installation/4b-uwsgi.md

@@ -68,7 +68,7 @@ You should see output similar to the following:
 ● netbox.service - NetBox WSGI Service
 ● netbox.service - NetBox WSGI Service
      Loaded: loaded (/etc/systemd/system/netbox.service; enabled; vendor preset: enabled)
      Loaded: loaded (/etc/systemd/system/netbox.service; enabled; vendor preset: enabled)
      Active: active (running) since Mon 2021-08-30 04:02:36 UTC; 14h ago
      Active: active (running) since Mon 2021-08-30 04:02:36 UTC; 14h ago
-       Docs: https://docs.netbox.dev/
+       Docs: https://netboxlabs.com/docs/netbox/
    Main PID: 1140492 (uwsgi)
    Main PID: 1140492 (uwsgi)
       Tasks: 19 (limit: 4683)
       Tasks: 19 (limit: 4683)
      Memory: 666.2M
      Memory: 666.2M

TEMPAT SAMPAH
docs/media/misc/reference_architecture.png


+ 1 - 1
mkdocs.yml

@@ -1,7 +1,7 @@
 # Note: NetBox has migrated from MkDocs to Zensical
 # Note: NetBox has migrated from MkDocs to Zensical
 site_name: NetBox Documentation
 site_name: NetBox Documentation
 site_dir: netbox/project-static/docs
 site_dir: netbox/project-static/docs
-site_url: https://docs.netbox.dev/
+site_url: https://netboxlabs.com/docs/netbox/
 repo_name: netbox-community/netbox
 repo_name: netbox-community/netbox
 repo_url: https://github.com/netbox-community/netbox
 repo_url: https://github.com/netbox-community/netbox
 theme:
 theme:

+ 1 - 1
netbox/templates/home.html

@@ -14,7 +14,7 @@
         <div>
         <div>
           <h4 class="alert-title">{% trans "New Release Available" %}</h4>
           <h4 class="alert-title">{% trans "New Release Available" %}</h4>
           <a href="{{ new_release.url }}">NetBox v{{ new_release.version }}</a> {% trans "is available" %}.
           <a href="{{ new_release.url }}">NetBox v{{ new_release.version }}</a> {% trans "is available" %}.
-          <a href="https://docs.netbox.dev/en/stable/installation/upgrading/" target="_blank">
+          <a href="https://netboxlabs.com/docs/netbox/installation/upgrading/" target="_blank">
             {% trans "Upgrade Instructions" context "Document title" %}
             {% trans "Upgrade Instructions" context "Document title" %}
             <i class="mdi mdi-open-in-new"></i>
             <i class="mdi mdi-open-in-new"></i>
           </a>
           </a>

+ 1 - 1
netbox/templates/media_failure.html

@@ -32,7 +32,7 @@
               {% endblocktrans %}
               {% endblocktrans %}
             </li>
             </li>
             <li class="tip">
             <li class="tip">
-              {% blocktrans trimmed with docs_url="https://docs.netbox.dev/en/stable/installation/" %}
+              {% blocktrans trimmed with docs_url="https://netboxlabs.com/docs/netbox/installation/" %}
                 The HTTP service (e.g. nginx or Apache) is configured to serve files from the <code>STATIC_ROOT</code>
                 The HTTP service (e.g. nginx or Apache) is configured to serve files from the <code>STATIC_ROOT</code>
                 path. Refer to <a href="{{ docs_url }}">the installation documentation</a> for further guidance.
                 path. Refer to <a href="{{ docs_url }}">the installation documentation</a> for further guidance.
               {% endblocktrans %}
               {% endblocktrans %}