-
Notifications
You must be signed in to change notification settings - Fork 2.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve documentation of the distinction among power ports, outlets, feeds, and panels #3135
Comments
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. |
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. |
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...
|
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? |
Maybe adding this to #792? Because that's a big feature with lots off work. |
HI, |
Fully agree, diagrams that can be looked up in the documentation and/or referenced from the GUI would be nice for non-native speakers |
Accepting this as a documentation improvement. (To be clear, none of the model names will change as that would be very disruptive.) |
I'll work on a |
Fixes #3135: Documented power modelling
Environment
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:
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
The text was updated successfully, but these errors were encountered: