Opened 86 minutes ago
Last modified 19 minutes ago
#37051 new Cleanup/optimization
Improve the map of documentation on Django's home page
| Reported by: | Daniele Procida | Owned by: | |
|---|---|---|---|
| Component: | Documentation | Version: | 6.0 |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Unreviewed | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description (last modified by )
In general, the documentation home page does an outstanding job of unfolding Django’s documentation content in a topographical fashion – it’s like opening a map and seeing the terrain laid out in front of you.
It's rational, compact and shows the relationship of different concerns to each other very effectively.
However some of the rationality frays at the edges, and it's not maintained all the way down.
I propose reworking this map of Django's domains of concern so that things like each other are closer together. For example: features (e.g. Admin, Forms, GeoDjango), quality demands (Security, Performance) and so on.
Here's a sketch of the new arrangement of domains of concern. It attempts to achieve a balance of rationality, pragmatism (no heavy-handed application of rules if it would produce something awkward) and aesthetics (it should provide a good experience, feel good and even look right).
It orders topics as:
- entry-point
- conceptual and functional layers
- features
- resources and interfaces (a new grouping, concerned with Django's access to the world outside it)
- quality demands
- development lifecycle activity
- contributing to Django
and sometimes uses those categories as actual titles too.
The page as it stands in 6.0
The domains the page exposes, in order, are:
- First steps : the entry-point
- Models, Views, Templates: these are key conceptual and functional layers
- Forms: forms is a feature (something that Django offers you, that isn't a core of its architecture – you could imagine Django without it)
- The development process: development lifecycle activity
- The admin: feature (it belongs with Forms)
- Security: a quality demand (something we want from Django, and want developers to achieve)
- Internationalization and localization: feature
- Performance and optimization: quality demand
- Geographic framework: feature
- Common web application tools: a collection mostly of developer-facing features in no particular order
- Other core functionalities: another collection without a strong uniting principle
- The Django open-source project: contributing to Django
Change History (2)
comment:1 by , 26 minutes ago
| Description: | modified (diff) |
|---|---|
| Has patch: | set |
comment:2 by , 19 minutes ago
| Description: | modified (diff) |
|---|