#36022: Name the main command django
-------------------------------------+-------------------------------------
Reporter: Ryan Hiebert | Owner: Ryan
| Hiebert
Type: New feature | Status: assigned
Component: Core (Management | Version: dev
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Ryan Hiebert):
A little update on how this is progressing. I'm trying to be careful with
the documentation, to keep it as compatible as possible. I'm trying to
identify my best answer, but I'm not sure what the right balance is.
The current docs for the `django-admin` command are at `docs/ref/django-
admin.txt`. That's used to construct the URL. Given that we're wanting to
canonicalize on the new command, I'm looking to change that to `docs/refs
/django-cmd.txt`. This raises an interesting question of how to deal with
compatibility across different versions. It also has implications for how
we should handle historical cross references to `django-admin` that
shouldn't be changes, for example in release notes, but that we'd like to
resolve to a useful page if possible.
One option is to eliminate the cross references in the release notes. Just
say `django-admin` when we'd have a cross reference to the docs to the
`django-admin` command docs, and accept that for those historical release
notes, in the latest versions of the docs, they won't link anymore. The
cross-referencing links will still work in earlier versions of the docs.
Another option is to keep the historical directive, and do a small amount
of fancy footwork with sphinx so that the references remain visually
intact with the prior command name, but actually point to the `django-cmd`
docs.
I'm also investigating whether it might be possible to add a redirect
between the pages. So visiting `django-admin` would still work, but would
redirect to the new doc, or if that's too challenging to do with Sphinx we
could have a simple documentation page that informs the reader that the
command has been renamed and the docs have moved and give a link. Whatever
approach worked out, we could even add the inverse to historical docs. The
benefit is that the version switcher doesn't break. Maybe that's not worth
the hassle of trying to redirect, I'm not sure.
--
Ticket URL: <https://code.djangoproject.com/ticket/36022#comment:8>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion visit
https://groups.google.com/d/msgid/django-updates/0107019e0e852b68-a4a66e90-4130-4e42-8906-ef22bf85adc3-000000%40eu-central-1.amazonses.com.
