Document use of management command for initial admin user setup #4733
Conversation
This command is simpler than a DB shell and helps new developers get familiar with a useful tool. I’ve used the -s switch instead of --staff-area-administrator for ease of typing and memorability. Once familiar with the short form, developers may not need to refer back to these docs.
There was a problem hiding this comment.
Good spot! IIRC Steve proposed an admin command for adding this role to a user in #4552, but we decided against it.
| >>> user = User.objects.get(username="<your_username>") | ||
| >>> user.roles.append(StaffAreaAdministrator) | ||
| >>> user.save() | ||
| > python manage.py create_user <your_username> -s |
There was a problem hiding this comment.
Nitpick: As the rationale for this change is to support a new developer, then I'd suggest using the long-form of the argument (--staff-area-administrator) to make it absolutely clear what type of user create_user is creating.
There was a problem hiding this comment.
I think that's clear from the preceding line that explains the purpose of running the command.
I’ve used the -s switch instead of --staff-area-administrator for ease of typing and memorability. Once familiar
with the short form, developers may not need to refer back to these docs.
There was a problem hiding this comment.
IIRC Steve proposed an admin command for adding this role to a user in #4552, but we decided against it.
It's been there since the command was added in #4096 for Airlock purposes. It's definitely easy to overlook -- at one point I started writing one myself until I realized create_user can also do updates. I might have called it create_or_update_user, though that's a bit of a mouthful. But no less convenient if you have manage.py autocomplete on, and probably less confusing. Hmm.
I support having Create-Update and Delete management commands for models that developers commonly manage locally. More convenient that writing SQL queries, for me at least. Automating common development tasks is useful, and adding or removing admin to myself is something I do all the time.
This command is simpler than a DB shell and helps new developers get familiar with a useful tool. I’ve used the -s switch instead of --staff-area-administrator for ease of typing and memorability. Once familiar with the short form, developers may not need to refer back to these docs.