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

More clearly define the current version and target version in upgrade documentation #8287

New Issue
Closed
opened 2025-12-29 20:34:47 +01:00 by adam · 6 comments
adam commented 2025-12-29 20:34:47 +01:00
Owner
Copy Link

Originally created by @lethargosapatheia on GitHub (Jul 3, 2023).

Originally assigned to: @abhi1693, @jeremystretch on GitHub.

Change Type

Correction

Area

Installation/upgrade

Proposed Changes

I've done several (successful) upgrades for netbox, but whenever I do them, I always get a little bit confused about what directories I'm supposed to copy and where I'm supposed to copy them and then I realise that the instructions here are rather confusing and that this is isn't just my fault 🙂
https://demo.netbox.dev/static/docs/installation/upgrading/
The reason for that is that X.Y.Z refers both to the newly downloaded version and the current version you're using in two different consecutive code snippets. This refers to the newly downloaded version:

sudo ln -sfn /opt/netbox-X.Y.Z/ /opt/netbox

And this to the current version:

sudo cp /opt/netbox-X.Y.Z/local_requirements.txt /opt/netbox/

I mean, sure, it is logical, because you've just created that symlink in /opt/netbox, but it's still rather confusing and you have to look and check several times until you figure out 🙂

It might be one of those small changes that can increase the readability of the documentation, but let me know if I'm reading this wrong :)

Originally created by @lethargosapatheia on GitHub (Jul 3, 2023). Originally assigned to: @abhi1693, @jeremystretch on GitHub. ### Change Type Correction ### Area Installation/upgrade ### Proposed Changes I've done several (successful) upgrades for netbox, but whenever I do them, I always get a little bit confused about what directories I'm supposed to copy and where I'm supposed to copy them and then I realise that the instructions here are rather confusing and that this is isn't just my fault :slightly_smiling_face: https://demo.netbox.dev/static/docs/installation/upgrading/ The reason for that is that `X.Y.Z` refers both to the newly downloaded version and the current version you're using in two different consecutive code snippets. This refers to the newly downloaded version: ``` sudo ln -sfn /opt/netbox-X.Y.Z/ /opt/netbox ``` And this to the current version: ``` sudo cp /opt/netbox-X.Y.Z/local_requirements.txt /opt/netbox/ ``` I mean, sure, it is logical, because you've just created that symlink in `/opt/netbox`, but it's still rather confusing and you have to look and check several times until you figure out :slightly_smiling_face: It might be one of those small changes that can increase the readability of the documentation, but let me know if I'm reading this wrong :)
adam added the status: acceptedtype: documentation labels 2025-12-29 20:34:47 +01:00
adam closed this issue 2025-12-29 20:34:48 +01:00
adam commented 2025-12-29 20:34:48 +01:00
Author
Owner
Copy Link

@jsenecal commented on GitHub (Jul 3, 2023):

Hi @lethargosapatheia, would you mind wording the changes based on the current documentation ? How would you do it? Would you be able to submit a PR with those changes ?

@jsenecal commented on GitHub (Jul 3, 2023): Hi @lethargosapatheia, would you mind wording the changes based on the current documentation ? How would you do it? Would you be able to submit a PR with those changes ?
adam commented 2025-12-29 20:34:49 +01:00
Author
Owner
Copy Link

@lethargosapatheia commented on GitHub (Jul 3, 2023):

Unfortunately I've no idea how to submit a PR, maybe you can point me to it, but what I'd suggest, I guess, would be to replace this:

sudo cp /opt/netbox-X.Y.Z/local_requirements.txt /opt/netbox/
sudo cp /opt/netbox-X.Y.Z/netbox/netbox/configuration.py /opt/netbox/netbox/netbox/
sudo cp /opt/netbox-X.Y.Z/netbox/netbox/ldap_config.py /opt/netbox/netbox/netbox/

with this:

sudo cp /opt/netbox-current-installation/local_requirements.txt /opt/netbox/
sudo cp /opt/netbox-current-installation/netbox/netbox/configuration.py /opt/netbox/netbox/netbox/
sudo cp /opt/netbox-current-installation/netbox/netbox/ldap_config.py /opt/netbox/netbox/netbox/

The same thing with the following three code snippets:

sudo cp -pr /opt/netbox-current-installation/netbox/media/ /opt/netbox/netbox/

sudo cp -r /opt/netbox-current-installation/netbox/scripts /opt/netbox/netbox/
sudo cp -r /opt/netbox-current-installation/netbox/reports /opt/netbox/netbox/

sudo cp /opt/netbox-current-installation/gunicorn.py /opt/netbox/

Or let me know how I can submit the PR. I've identified the file at least: 3307bd200c/docs/installation/upgrading.md

It can basically be anything that marks the difference between the new and the current version.

@lethargosapatheia commented on GitHub (Jul 3, 2023): Unfortunately I've no idea how to submit a PR, maybe you can point me to it, but what I'd suggest, I guess, would be to replace this: ``` sudo cp /opt/netbox-X.Y.Z/local_requirements.txt /opt/netbox/ sudo cp /opt/netbox-X.Y.Z/netbox/netbox/configuration.py /opt/netbox/netbox/netbox/ sudo cp /opt/netbox-X.Y.Z/netbox/netbox/ldap_config.py /opt/netbox/netbox/netbox/ ``` with this: ``` sudo cp /opt/netbox-current-installation/local_requirements.txt /opt/netbox/ sudo cp /opt/netbox-current-installation/netbox/netbox/configuration.py /opt/netbox/netbox/netbox/ sudo cp /opt/netbox-current-installation/netbox/netbox/ldap_config.py /opt/netbox/netbox/netbox/ ``` The same thing with the following three code snippets: ``` sudo cp -pr /opt/netbox-current-installation/netbox/media/ /opt/netbox/netbox/ ``` ``` sudo cp -r /opt/netbox-current-installation/netbox/scripts /opt/netbox/netbox/ sudo cp -r /opt/netbox-current-installation/netbox/reports /opt/netbox/netbox/ ``` ``` sudo cp /opt/netbox-current-installation/gunicorn.py /opt/netbox/ ``` Or let me know how I can submit the PR. I've identified the file at least: https://github.com/netbox-community/netbox/blob/3307bd200c38d2c548022917292c5f8db37c5541/docs/installation/upgrading.md It can basically be anything that marks the difference between the new and the current version.
adam commented 2025-12-29 20:34:49 +01:00
Author
Owner
Copy Link

@jsenecal commented on GitHub (Jul 3, 2023):

I would argue that introducing vA.B.C, and explaining the difference between vA.B.C and vX.Y.Z would be better.
Either that or netbox-[CURRENT-VERSION] and netbox-[TARGET-VERSION]. What do you think ?

@jsenecal commented on GitHub (Jul 3, 2023): I would argue that introducing vA.B.C, and explaining the difference between vA.B.C and vX.Y.Z would be better. Either that or `netbox-[CURRENT-VERSION]` and `netbox-[TARGET-VERSION]`. What do you think ?
adam commented 2025-12-29 20:34:49 +01:00
Author
Owner
Copy Link

@lethargosapatheia commented on GitHub (Jul 3, 2023):

I think either of your suggestions is better than what I said because they're symmetrical. If you were to ask me personally, I'd go for [CURRENT-VERSION]/[TARGET-VERSION], but that's just because I bumped into this and wanted to know clearly which is supposed to be the current version. But I'm not sure how objective this is :) Either is good!

@lethargosapatheia commented on GitHub (Jul 3, 2023): I think either of your suggestions is better than what I said because they're symmetrical. If you were to ask me personally, I'd go for `[CURRENT-VERSION]`/`[TARGET-VERSION]`, but that's just because I bumped into this and wanted to know clearly which is supposed to be the current version. But I'm not sure how objective this is :) Either is good!
adam commented 2025-12-29 20:34:50 +01:00
Author
Owner
Copy Link

@gdprdatasubect commented on GitHub (Jul 4, 2023):

Having stumbled across this before, X.Y.Y and X.Y.Z seems kinda fitting to me, because most people just upgrade whenever a new one is available

@gdprdatasubect commented on GitHub (Jul 4, 2023): Having stumbled across this before, X.Y.Y and X.Y.Z seems kinda fitting to me, because most people just [upgrade whenever a new one is available](https://github.com/netbox-community/netbox/discussions/12876)
adam commented 2025-12-29 20:34:50 +01:00
Author
Owner
Copy Link

@lethargosapatheia commented on GitHub (Jul 5, 2023):

It's hard to say, I'd instinctively say they look too similar (and in reality they actually are :) ), but as long as they are different, it will be a step forward.

@lethargosapatheia commented on GitHub (Jul 5, 2023): It's hard to say, I'd instinctively say they look too similar (and in reality they actually are :) ), but as long as they are different, it will be a step forward.
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#8287
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?