starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Create better upgrade documentation and clear link to release notes #2791

New Issue
Closed
opened 2025-12-29 18:22:12 +01:00 by adam · 2 comments
adam commented 2025-12-29 18:22:12 +01:00
Owner
Copy Link

Originally created by @lampwins on GitHub (Aug 7, 2019).

Change Type

[ x ] Addition
[ x ] Correction
[ ] Deprecation
[ x ] Cleanup (formatting, typos, etc.)

Proposed Changes

The official documentation for upgrading NetBox is quite generic and does nothing to account for the many important considerations and action items included in the last several major releases.

Currently, all of our release notes are contained within a GitHub release. This creates a separate source of pertinent information that is not included in our official documentation.

I propose two things here:

  1. Move our changelog to be a part of the official documentation. Since the file is already markdown, should not be very hard. We can retain the CHANGELOG.md file in the root of the repo, and simply provide a link to the docs from there. This also does not hinder the ability to include changelog items in a GitHub release, since those are just copy/pasted.
  2. Revamp the upgrade section to ensure users account for important changes and action items in a given release. This includes making the aforementioned changelog more readily apparent from this section. I would also like to see this section discuss specific upgrade steps for users moving a recent version of NetBox with new dependencies. I.e. moving to 2.6 when Redis became required.
Originally created by @lampwins on GitHub (Aug 7, 2019). <!-- Please indicate the nature of the change by placing an X in one of the boxes below. --> ### Change Type [ x ] Addition [ x ] Correction [ ] Deprecation [ x ] Cleanup (formatting, typos, etc.) <!-- Describe the proposed change(s). --> ### Proposed Changes The official documentation for upgrading NetBox is quite generic and does nothing to account for the many important considerations and action items included in the last several major releases. Currently, all of our release notes are contained within a GitHub release. This creates a separate source of pertinent information that is not included in our official documentation. I propose two things here: 1. Move our changelog to be a part of the official documentation. Since the file is already markdown, should not be very hard. We can retain the CHANGELOG.md file in the root of the repo, and simply provide a link to the docs from there. This also does not hinder the ability to include changelog items in a GitHub release, since those are just copy/pasted. 2. Revamp the upgrade section to ensure users account for important changes and action items in a given release. This includes making the aforementioned changelog more readily apparent from this section. I would also like to see this section discuss specific upgrade steps for users moving a recent version of NetBox with new dependencies. I.e. moving to 2.6 when Redis became required.
adam added the status: acceptedtype: documentation labels 2025-12-29 18:22:12 +01:00
adam closed this issue 2025-12-29 18:22:12 +01:00
adam commented 2025-12-29 18:22:13 +01:00
Author
Owner
Copy Link

@hellerve commented on GitHub (Aug 8, 2019):

I love step 2 especially, since I’ve been a little careless when updating in the past and sometimes missed important updates. Having them highlighted for me would be a huge help!

@hellerve commented on GitHub (Aug 8, 2019): I love step 2 especially, since I’ve been a little careless when updating in the past and sometimes missed important updates. Having them highlighted for me would be a huge help!
adam commented 2025-12-29 18:22:13 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Sep 17, 2019):

Removing the the 2.7 milestone; happy to implement this under v2.6.x.

@jeremystretch commented on GitHub (Sep 17, 2019): Removing the the 2.7 milestone; happy to implement this under v2.6.x.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label status: accepted type: documentation
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#2791
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?