Skip to content

Commit

Permalink
Restructured how-to docs landing page.
Browse files Browse the repository at this point in the history
Previously, this was a bare list of sub-pages, not in any discernible
order, and hard to parse.

Now the sub-pages are grouped in sections by topic. It's unlikely to be
the final word on how this material is arranged, but it's a clear
improvement on the existing arrangement and provides a good basis for
next steps.
  • Loading branch information
evildmp authored Oct 22, 2024
1 parent df6013b commit dd0a116
Showing 1 changed file with 50 additions and 22 deletions.
72 changes: 50 additions & 22 deletions docs/howto/index.txt
Original file line number Diff line number Diff line change
@@ -1,38 +1,66 @@
===============
"How-to" guides
===============
=============
How-to guides
=============

Here you'll find short answers to "How do I....?" types of questions. These
how-to guides don't cover topics in depth -- you'll find that material in the
:doc:`/topics/index` and the :doc:`/ref/index`. However, these guides will help
you quickly accomplish common tasks.
Practical guides covering common tasks and problems.

Models, data and databases
==========================

.. toctree::
:maxdepth: 1

auth-remote-user
csrf
custom-management-commands
custom-model-fields
custom-lookups
custom-template-backend
custom-template-tags
custom-file-storage
deployment/index
upgrade-version
error-reporting
initial-data
legacy-databases
logging
custom-model-fields
writing-migrations
custom-lookups

Templates and output
====================

.. toctree::
:maxdepth: 1

outputting-csv
outputting-pdf
overriding-templates
custom-template-backend
custom-template-tags

Project configuration and management
====================================

.. toctree::
:maxdepth: 1

static-files/index
static-files/deployment
windows
writing-migrations
logging
error-reporting
delete-app

Installing, deploying and upgrading
===================================

.. toctree::
:maxdepth: 1

upgrade-version
windows
deployment/index
static-files/deployment

Other guides
============

.. toctree::
:maxdepth: 1

auth-remote-user
csrf
custom-management-commands
custom-file-storage

.. seealso::

The `Django community aggregator`_, where we aggregate content from the
Expand Down

0 comments on commit dd0a116

Please sign in to comment.