Opened 6 months ago

Closed 10 days ago

#37051 closed Cleanup/optimization (fixed)

Improve the map of documentation on Django's home page

Reported by: Daniele Procida Owned by: Daniele Procida
Component: Documentation Version: 6.0
Severity: Normal Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description (last modified by Daniele Procida)

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:

Change History (9)

comment:1 by Daniele Procida, 6 months ago

Description: modified (diff)
Has patch: set

comment:2 by Daniele Procida, 6 months ago

Description: modified (diff)

comment:3 by Jacob Walls, 6 months ago

Owner: set to Daniele Procida
Status: new → assigned
Triage Stage: Unreviewed → Accepted

comment:4 by Jacob Walls, 4 months ago

Patch needs improvement: set

comment:5 by blighj, 4 months ago

Patch needs improvement: unset

comment:6 by James Beard, 3 months ago

Patch needs improvement: set

comment:7 by Daniele Procida, 10 days ago

Patch needs improvement: unset

Following conversations and reviews with Carlton Gibson and Jacob Walls, I think this is ready to be merged.

comment:8 by Carlton Gibson, 10 days ago

Triage Stage: Accepted → Ready for checkin

comment:9 by Jacob Walls <jacobtylerwalls@…>, 10 days ago

Resolution: → fixed
Status: assigned → closed

In 9d977aa:

Fixed #37051 -- Improved organisation of documentation home page.

The various domains of concern expressed on the home page (not
always explicitly) have been re-ordered and the topics within
them reorganised where appropriate.

The new order is:

  • entry-point (installation, tutorial)
  • conceptual and functional layers (models, views, templates, other core functionality)
  • features (divided in to user-facing and developer-facing features)
  • resources and interfaces (database, storage, etc)
  • quality demands (security, performance, etc)
  • developing with Django
  • contributing to Django

Two sections ("How the documentation is organized" and "Getting
help") have been moved lower down the page; they don't need to
appear above the main map of contents).

Thanks James Bligh, James Beard, and Carlton Gibson for reviews.

Note: See TracTickets for help on using tickets.
Back to Top