Issue #4648
closed
'reset-admin-password' django-admin command is listed under 'app' section of help text
Description
Django Admin commands are broken up into sections based on their app label. Commands from 'drf_yasg' are under a section header called 'drf_yasg'. I would expect pulp commands to be under a 'pulp' or 'pulpcore' label.
django-admin help
[app]
reset-admin-password
stage-profile-summary
.....
- Description updated (diff)
- Sprint/Milestone set to 3.0.0
- Triaged changed from No to Yes
- Sprint/Milestone changed from 3.0.0 to 71
- Sprint/Milestone changed from 71 to 3.0.0
I looked into this a bit, and the reason it's listed this way is because Django uses the "last package name" as the label, not the actual "app name". Our app name is "pulpcore.app", but the command lives at "pulpcore.app.managemend.command.xxx" so those get listed under "app".
What I realized is that with this pattern every plugin will have it's commands living at [app] which is not a good user experience. I can see two options:
a) add a subdir of the plugin name, so for pulpcore it would be "pulpcore.app.pulpcore.management.command.xxx" this would place it visually under pulpcore. This is kind of a hack though.
b) make "pulpcore" the app, not "pulpcore.app". I think this would be simpler overall in terms of code layout. We could also adopt this in the plugin_template. I know this is kind of a big change, but it's also a straightforward one.
- Sprint/Milestone deleted (
3.0.0)
Removing since this label isn't part of the command or API, we could fix this later.
- Status changed from NEW to CLOSED - WONTFIX
Also available in: Atom
PDF
.