[Django] #26272: Additional Documentation on Common Features
Django
-------------------------------+------------------------------------------
Reporter: MalikRumi | Owner: nobody
Type: New feature | Status: new
Component: Documentation | Version: 1.9
Severity: Normal | Keywords: Home page, Table of Contents
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+------------------------------------------
1. Building a home page
I posted this to Django Groups, and while responding to Bob I realized
this might need to be a feature request, so I'm here making it. Here's the
link: https://mail.google.com/mail/u/0/#inbox/1530e36e323dadbf
2. Building a Table of Contents
This is another area where getting solid information is hard to come by. I
am NOT talking about using Sphinx or anything like that. This is not for
documentation, it is for a Table of Contents for end users of the site.
Such tables are typically hierarchical, which requires either a 3rd party
app or a judicious use of parent child relationships. And while we can use
ListView as a starting point, what about features that spread across
different apps, or don't have strictly hierarchical relation but that you
still want to list together somehow?
I am perfectly willing to work on this, (I have lots of non-technical
writing experience) even alone, so long as I had the ear of Django experts
who would respond to issues I run into or questions I have about how it
should all work, best practices, etc.
--
Ticket URL: <https://code.djangoproject.com/ticket/26272>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
-------------------------------------+-------------------------------------
Reporter: MalikRumi | Owner: nobody
Type: New feature | Status: closed
Component: Documentation | Version: 1.9
Severity: Normal | Resolution: needsinfo
Keywords: Home page, Table of | Triage Stage:
Contents | Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by timgraham):
* status: new => closed
* needs_better_patch: => 0
* needs_tests: => 0
* needs_docs: => 0
* resolution: => needsinfo
Old description:
> 1. Building a home page
> I posted this to Django Groups, and while responding to Bob I realized
> this might need to be a feature request, so I'm here making it. Here's
> the link: https://mail.google.com/mail/u/0/#inbox/1530e36e323dadbf
>
> 2. Building a Table of Contents
> This is another area where getting solid information is hard to come by.
> I am NOT talking about using Sphinx or anything like that. This is not
> for documentation, it is for a Table of Contents for end users of the
> site. Such tables are typically hierarchical, which requires either a 3rd
> party app or a judicious use of parent child relationships. And while we
> can use ListView as a starting point, what about features that spread
> across different apps, or don't have strictly hierarchical relation but
> that you still want to list together somehow?
>
> I am perfectly willing to work on this, (I have lots of non-technical
> writing experience) even alone, so long as I had the ear of Django
> experts who would respond to issues I run into or questions I have about
> how it should all work, best practices, etc.
New description:
1. Building a home page
I posted this to [django-users https://groups.google.com/d/topic/django-
users/EMtRahO3EYI/discussion], and while responding to Bob I realized this
might need to be a feature request, so I'm here making it. Here's the
link:
2. Building a Table of Contents
This is another area where getting solid information is hard to come by. I
am NOT talking about using Sphinx or anything like that. This is not for
documentation, it is for a Table of Contents for end users of the site.
Such tables are typically hierarchical, which requires either a 3rd party
app or a judicious use of parent child relationships. And while we can use
ListView as a starting point, what about features that spread across
different apps, or don't have strictly hierarchical relation but that you
still want to list together somehow?
I am perfectly willing to work on this, (I have lots of non-technical
writing experience) even alone, so long as I had the ear of Django experts
who would respond to issues I run into or questions I have about how it
should all work, best practices, etc.
--
Comment:
I don't see where this would fit into the docs. I think it's really too
broad a topic to give general guidance without making specific
recommendations that are usually project specific. If you want to try to
write something, but all means, feel free to propose it but until we see
the details, I don't think there's much value in keeping a ticket like
this open. Hope not to discourage you!
--
Ticket URL: <https://code.djangoproject.com/ticket/26272#comment:1>
Django
-------------------------------------+-------------------------------------
Type: New feature | Status: closed
Component: Documentation | Version: 1.9
Severity: Normal | Resolution: needsinfo
Keywords: Home page, Table of | Triage Stage:
Contents | Unreviewed
Has patch: 0 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Comment (by MalikRumi):
hmmm.... ok, what about a handful of examples for different use cases?
--
Ticket URL: <https://code.djangoproject.com/ticket/26272#comment:2>
Django
-------------------------------------+-------------------------------------
Type: New feature | Status: closed
Component: Documentation | Version: 1.9
Severity: Normal | Resolution: needsinfo
Keywords: Home page, Table of | Triage Stage:
Contents | Unreviewed
Has patch: 0 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Comment (by timgraham):
I'd have to see more specifics of what you have in mind to say whether or
not its appropriate for the Django docs.
--
Ticket URL: <https://code.djangoproject.com/ticket/26272#comment:3>