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

Improve documentation of the distinction among power ports, outlets, feeds, and panels #2574

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

Originally created by @lampwins on GitHub (May 2, 2019).

Environment

  • Python version:
  • NetBox version:

Proposed Functionality

With the advent of the new power related functionality in 2.6, we need to better distinguish between the intended use of the various power components.

Use Case

As a person that is by no means an expert or even a novice when it comes to power infrastructure, I myself still get confused between the proper use of power outlets and power ports. Now that we have the concept of a power feed, that gets even more confusing. Certainly, some of this can be cleared up with more/better documentation, but I feel there may also be room to better qualify in the UI what these components are meant to do, so the UX becomes more intuitive.

I propose a couple of options:

  1. Anywhere "Power Ports" is referenced in the UI, append "(Input)" and anywhere "Power Outlets" is referenced, append "(Output)".
  2. In the UI either refer to Power Ports as "Power Supply Ports" or officially rename the model. To that end, maybe there is a better name/word to use?

Database Changes

By making changes in the UI only, no DB changes are needed, but the option of renaming a model would ensure a migration.

External Dependencies

N/A

Originally created by @lampwins on GitHub (May 2, 2019). <!-- NOTE: This form is only for proposing specific new features or enhancements. If you have a general idea or question, please post to our mailing list instead of opening an issue: https://groups.google.com/forum/#!forum/netbox-discuss NOTE: Due to an excessive backlog of feature requests, we are not currently accepting any proposals which significantly extend NetBox's feature scope. Please describe the environment in which you are running NetBox. Be sure that you are running an unmodified instance of the latest stable release before submitting a bug report. --> ### Environment * Python version: <!-- Example: 3.5.4 --> * NetBox version: <!-- Example: 2.3.6 --> <!-- Describe in detail the new functionality you are proposing. Include any specific changes to work flows, data models, or the user interface. --> ### Proposed Functionality With the advent of the new power related functionality in 2.6, we need to better distinguish between the intended use of the various power components. <!-- Convey an example use case for your proposed feature. Write from the perspective of a NetBox user who would benefit from the proposed functionality and describe how. ---> ### Use Case As a person that is by no means an expert or even a novice when it comes to power infrastructure, I myself still get confused between the proper use of power outlets and power ports. Now that we have the concept of a power feed, that gets even more confusing. Certainly, some of this can be cleared up with more/better documentation, but I feel there may also be room to better qualify in the UI what these components are meant to do, so the UX becomes more intuitive. I propose a couple of options: 1. Anywhere "Power Ports" is referenced in the UI, append "(Input)" and anywhere "Power Outlets" is referenced, append "(Output)". 2. In the UI either refer to Power Ports as "Power Supply Ports" or officially rename the model. To that end, maybe there is a better name/word to use? <!-- Note any changes to the database schema necessary to support the new feature. For example, does the proposal require adding a new model or field? (Not all new features require database changes.) ---> ### Database Changes By making changes in the UI only, no DB changes are needed, but the option of renaming a model would ensure a migration. <!-- List any new dependencies on external libraries or services that this new feature would introduce. For example, does the proposal require the installation of a new Python package? (Not all new features introduce new dependencies.) --> ### External Dependencies N/A
adam added the status: acceptedtype: documentation labels 2025-12-29 18:20:03 +01:00
adam closed this issue 2025-12-29 18:20:03 +01:00
adam commented 2025-12-29 18:20:04 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (May 2, 2019):

IMO "outlet" is a pretty common household word. ("I need to vacuum, where's the nearest outlet?") The word itself implies that power is being let out. I don't think it needs any further explanation.

Granted, "power port" is more ambiguous, but what would you rename it to? Power input? Power inlet?

Also, while I always strive to make things as intuitive as possible, I don't think that asking a user to remember that a "power port" consumes power is unreasonable.

@jeremystretch commented on GitHub (May 2, 2019): IMO "outlet" is a pretty common household word. ("I need to vacuum, where's the nearest outlet?") The word itself implies that power is being _let out_. I don't think it needs any further explanation. Granted, "power port" is more ambiguous, but what would you rename it to? Power input? Power inlet? Also, while I always strive to make things as intuitive as possible, I don't think that asking a user to remember that a "power port" consumes power is unreasonable.
adam commented 2025-12-29 18:20:04 +01:00
Author
Owner
Copy Link

@candlerb commented on GitHub (May 6, 2019):

I think "Power Inlet" is clear and unambiguous, and is the obvious counterpart to "Power Outlet" - whereas a "power port" could be in or out.

@candlerb commented on GitHub (May 6, 2019): I think "Power Inlet" is clear and unambiguous, and is the obvious counterpart to "Power Outlet" - whereas a "power port" could be in or out.
adam commented 2025-12-29 18:20:04 +01:00
Author
Owner
Copy Link

@wols commented on GitHub (Jun 5, 2019):

Let yourself be inspired eg. Rittal - Power distribution - IT power - ...

My most used 1U part is a "Socket strip for IEC 320 connectors" with eight sockets respectively 'Power Outlets' (netbox).

And the most used cable with...

  • Connector (type): IEC 320 connector C14
  • Jack/socket (type): IEC 320 socket C13
@wols commented on GitHub (Jun 5, 2019): Let yourself be inspired eg. [Rittal - Power distribution - IT power - ...](https://www.rittal.com/com-en/product/list.action?categoryPath=/PG0001/PG0229STV1/PG7274STV1) My most used 1U part is a "Socket strip for IEC 320 connectors" with _eight sockets_ respectively 'Power Outlets' (netbox). And the most used [cable](https://www.rittal.com/com-en/product/list.action?categoryPath=/PG0001/PG0229STV1/PG7274STV1) with... - _Connector_ (type): IEC 320 connector C14 - _Jack/socket_ (type): IEC 320 socket C13
adam commented 2025-12-29 18:20:04 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jun 24, 2019):

So this didn't make it into the beta; next change would be v2.7. Renaming the model would require a large amount of work for very little gain and a considerable amount of confusion and downstream work (people updating the field name in API consumer logic). Is this really worth keeping open?

@jeremystretch commented on GitHub (Jun 24, 2019): So this didn't make it into the beta; next change would be v2.7. Renaming the model would require a large amount of work for very little gain and a considerable amount of confusion and downstream work (people updating the field name in API consumer logic). Is this really worth keeping open?
adam commented 2025-12-29 18:20:04 +01:00
Author
Owner
Copy Link

@MarcHagen commented on GitHub (Aug 26, 2019):

Maybe adding this to #792? Because that's a big feature with lots off work.

@MarcHagen commented on GitHub (Aug 26, 2019): Maybe adding this to #792? Because that's a big feature with lots off work.
adam commented 2025-12-29 18:20:04 +01:00
Author
Owner
Copy Link

@flashbyte commented on GitHub (Sep 24, 2019):

HI,
as a not native speaker I am quid confused about the different power components in netbox. I don't need the models to be change, but would really much appreciate and updated in the documentation. Maybe even a small diagram to explain what goes where and it intended usage.

@flashbyte commented on GitHub (Sep 24, 2019): HI, as a not native speaker I am quid confused about the different power components in netbox. I don't need the models to be change, but would really much appreciate and updated in the documentation. Maybe even a small diagram to explain what goes where and it intended usage.
adam commented 2025-12-29 18:20:05 +01:00
Author
Owner
Copy Link

@sdktr commented on GitHub (Nov 6, 2019):

HI,
as a not native speaker I am quid confused about the different power components in netbox. I don't need the models to be change, but would really much appreciate and updated in the documentation. Maybe even a small diagram to explain what goes where and it intended usage.

Fully agree, diagrams that can be looked up in the documentation and/or referenced from the GUI would be nice for non-native speakers

@sdktr commented on GitHub (Nov 6, 2019): > HI, > as a not native speaker I am quid confused about the different power components in netbox. I don't need the models to be change, but would really much appreciate and updated in the documentation. Maybe even a small diagram to explain what goes where and it intended usage. Fully agree, diagrams that can be looked up in the documentation and/or referenced from the GUI would be nice for non-native speakers
adam commented 2025-12-29 18:20:05 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Dec 13, 2019):

Accepting this as a documentation improvement. (To be clear, none of the model names will change as that would be very disruptive.)

@jeremystretch commented on GitHub (Dec 13, 2019): Accepting this as a documentation improvement. (To be clear, none of the model names will change as that would be very disruptive.)
adam commented 2025-12-29 18:20:05 +01:00
Author
Owner
Copy Link

@hSaria commented on GitHub (Jan 10, 2020):

I'll work on a Power page under Core Functionality. Structuring it hierarchically (i.e. starting at closest to power source, ending closest to the device) should reduce confusion for the reader and hopefully allow people to model their power circuits appropriately on the first try.

@hSaria commented on GitHub (Jan 10, 2020): I'll work on a `Power` page under `Core Functionality`. Structuring it hierarchically (i.e. starting at closest to power source, ending closest to the device) should reduce confusion for the reader and hopefully allow people to model their power circuits appropriately on the first try.
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#2574
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?