#35335: Update "Enabling the sites framework" documentation to reiterate the
ability to use `get_current_site`
-------------------------------------+-------------------------------------
Reporter: Sam Darwin | Owner: sam
Type: | darwin
Cleanup/optimization | Status: assigned
Component: contrib.sites | Version: 5.0
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Sam Darwin):
The sites framework is unusual and a bit challenging to document, because
of the following reason. Typically, if there is a feature, you'd explain
how to use the functionality to an audience who is planning on using it.
The instructions are aimed at that group: the actual users. For those who
aren't going to use the feature, they can skip the page entirely.
Conversely, with the "sites" framework, 90% of users aren't going to use
the "sites" framework in the sense of having multiple sites, however they
may reference the documentation because it is recommended for most or all
Django deployments to enable "sites" as a best-practice.
Documentation should be geared toward the main, largest, set of users who
will need to read it.
In this case, that would be the not-actual-users of the sites framework,
who are enabling it because of best-practices, but not running multiple
sites.
Ultimately the docs ought to assist both of these groups: the "real
users", and the most common group of users.
With that in mind, in the pull request, I added an "Installation
Scenarios" section, with two different scenarios, corresponding to the
above mentioned groups.
Your feedback has been helpful. I think that it's not a situation where
one method is always recommended, or the other, but it depends on the
case.
--
Ticket URL: <https://code.djangoproject.com/ticket/35335#comment:3>
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/010701948f4ce5d4-ecd3be40-0b3a-4a91-9fea-39177e3f7ff7-000000%40eu-central-1.amazonses.com.
