[PR #19046] [MERGED] Fixes #18733: Add Dependency Version Matrix for NetBox Versions to the Upgrade Documentation #15510

Closed
opened 2025-12-30 00:22:23 +01:00 by adam · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/netbox-community/netbox/pull/19046
Author: @pheus
Created: 4/1/2025
Status: Merged
Merged: 4/7/2025
Merged by: @bctiemann

Base: mainHead: docs/18733-add-version-requirements-matrix


📝 Commits (4)

  • a5106b8 docs(upgrading): Add dependency matrix for NetBox versions
  • 45779a2 docs(release): Update checklist with dependency requirements
  • f8f5ab8 docs(release): Correct formatting in release checklist
  • 10e1ae8 docs(release): Update Dependency Requirements Matrix header

📊 Changes

2 files changed (+86 additions, -12 deletions)

View changed files

📝 docs/development/release-checklist.md (+40 -7)
📝 docs/installation/upgrading.md (+46 -5)

📄 Description

Fixes: #18733

Summary

This PR introduces a dependency version matrix to the Upgrade Guide, providing a structured reference for verifying compatibility before upgrading. The matrix outlines the supported versions of Python, PostgreSQL, and Redis for each NetBox release, helping users avoid installation issues due to unsupported dependencies.

Changes

  • Added a toggleable version matrix to the upgrade guide, allowing users to switch between Current Version and All Versions instead of the initially proposed Current Version and Previous Versions. This makes it clearer and more useful for users looking for historical compatibility data.
  • Ensures that system requirements for each NetBox version are clearly documented in one place.

Screenshots

Screenshot 2025-04-01 at 08-54-46 Upgrading NetBox - NetBox Documentation

Screenshot 2025-04-01 at 08-55-17 Upgrading NetBox - NetBox Documentation

Would love any feedback on placement or formatting! 🚀


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/netbox-community/netbox/pull/19046 **Author:** [@pheus](https://github.com/pheus) **Created:** 4/1/2025 **Status:** ✅ Merged **Merged:** 4/7/2025 **Merged by:** [@bctiemann](https://github.com/bctiemann) **Base:** `main` ← **Head:** `docs/18733-add-version-requirements-matrix` --- ### 📝 Commits (4) - [`a5106b8`](https://github.com/netbox-community/netbox/commit/a5106b858d626f5dabaff8c49fc971b08db07089) docs(upgrading): Add dependency matrix for NetBox versions - [`45779a2`](https://github.com/netbox-community/netbox/commit/45779a24a40b4feefa9ed7bfd8eeffbfd7f902c2) docs(release): Update checklist with dependency requirements - [`f8f5ab8`](https://github.com/netbox-community/netbox/commit/f8f5ab8d611e21f64df0e12c2a7844418438b9f6) docs(release): Correct formatting in release checklist - [`10e1ae8`](https://github.com/netbox-community/netbox/commit/10e1ae8292c9efbfd39ef5634f5442e1a07c6fc8) docs(release): Update Dependency Requirements Matrix header ### 📊 Changes **2 files changed** (+86 additions, -12 deletions) <details> <summary>View changed files</summary> 📝 `docs/development/release-checklist.md` (+40 -7) 📝 `docs/installation/upgrading.md` (+46 -5) </details> ### 📄 Description ### Fixes: #18733 #### Summary This PR introduces a dependency version matrix to the **Upgrade Guide**, providing a structured reference for verifying compatibility before upgrading. The matrix outlines the supported versions of **Python, PostgreSQL, and Redis** for each NetBox release, helping users avoid installation issues due to unsupported dependencies. #### Changes - Added a **toggleable version matrix** to the upgrade guide, allowing users to switch between **Current Version** and **All Versions** instead of the initially proposed **Current Version** and **Previous Versions**. This makes it clearer and more useful for users looking for historical compatibility data. - Ensures that system requirements for each NetBox version are clearly documented in one place. #### Screenshots ![Screenshot 2025-04-01 at 08-54-46 Upgrading NetBox - NetBox Documentation](https://github.com/user-attachments/assets/67feac11-f337-4b03-87a8-605f2e7bf689) ![Screenshot 2025-04-01 at 08-55-17 Upgrading NetBox - NetBox Documentation](https://github.com/user-attachments/assets/07efae55-8565-44e7-bd05-b1ffce3968d6) Would love any feedback on placement or formatting! 🚀 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2025-12-30 00:22:23 +01:00
adam closed this issue 2025-12-30 00:22:23 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#15510