Project

Profile

Help

Issue #4648

'reset-admin-password' django-admin command is listed under 'app' section of help text

Added by dkliban@redhat.com 6 months ago. Updated 7 days ago.

Status:
NEW
Priority:
Normal
Assignee:
-
Category:
-
Sprint/Milestone:
-
Start date:
Due date:
Severity:
2. Medium
Version:
Platform Release:
Blocks Release:
OS:
Backwards Incompatible:
No
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
QA Contact:
Complexity:
Smash Test:
Verified:
No
Verification Required:
No
Sprint:

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
.....

History

#1 Updated by dkliban@redhat.com 6 months ago

  • Description updated (diff)

#2 Updated by amacdona@redhat.com 6 months ago

  • Sprint/Milestone set to 3.0
  • Triaged changed from No to Yes

#3 Updated by bmbouter 6 months ago

  • Tags deleted (Pulp 3)

#4 Updated by daviddavis about 1 month ago

  • Sprint/Milestone changed from 3.0 to 71

#5 Updated by bmbouter about 1 month ago

  • Sprint/Milestone changed from 71 to 3.0

#6 Updated by bmbouter 7 days ago

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.

#7 Updated by bmbouter 7 days ago

  • Sprint/Milestone deleted (3.0)

Removing since this label isn't part of the command or API, we could fix this later.

Please register to edit this issue

Also available in: Atom PDF