[Django] #24070: Mention the topic of the tutorial parts beside them
Django
-------------------------------+--------------------
Reporter: iambibhas | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: master
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------
Right now the tutorial parts are mention on the front page like this -
> Tutorial: Part 1 | Part 2 | Part 3 | Part 4 | Part 5 | Part 6
Given that I have gone through them once, I'm still not sure which one of
them is the part that talks about writing views, or using the template
system. I think it'd be helpful to mention beside that part numbers what
they talk about.
This could be an issue between encouraging new users to jump between parts
and the convenience to find a certain topic. We could try to find a middle
ground. The only time a user needs to go through those parts sequentially
is the very first time. After that they may choose to jump between parts.
We could choose to make it easier in that case.
I'm attaching a patch to show what we could mention.
--
Ticket URL: <https://code.djangoproject.com/ticket/24070>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: iambibhas | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by timgraham):
* needs_better_patch: => 0
* stage: Unreviewed => Accepted
* type: Uncategorized => Cleanup/optimization
* needs_tests: => 0
* needs_docs: => 0
Comment:
How about something a little less verbose like the attached?
--
Ticket URL: <https://code.djangoproject.com/ticket/24070#comment:1>
Django
Reporter: iambibhas | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Comment (by iambibhas):
Clean and simple. I just added the nested list so that the parts
hyperlinks were next to each other, and it was a tiny bit easier to
navigate. But yeah, it took too much space. This looks good too.
--
Ticket URL: <https://code.djangoproject.com/ticket/24070#comment:2>
Django
Reporter: iambibhas | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Changes (by claudep):
* stage: Accepted => Ready for checkin
--
Ticket URL: <https://code.djangoproject.com/ticket/24070#comment:3>
Django
Reporter: iambibhas | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Comment (by iambibhas):
I created a pull request https://github.com/django/django/pull/3835
--
Ticket URL: <https://code.djangoproject.com/ticket/24070#comment:4>
Django
Reporter: iambibhas | Owner: nobody
Type: | Status: closed
Cleanup/optimization |
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Changes (by Tim Graham <timograham@…>):
* status: new => closed
* resolution: => fixed
Comment:
In [changeset:"b738178825ec9378198d77ac69699513774f0884"]:
{{{
#!CommitTicketReference repository=""
revision="b738178825ec9378198d77ac69699513774f0884"
Fixed #24070 -- Added tutorial topics to doc index.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/24070#comment:5>
Django
Reporter: iambibhas | Owner: nobody
Type: | Status: closed
Cleanup/optimization |
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Comment (by Tim Graham <timograham@…>):
In [changeset:"3b76a82a266d7f96019445a9189ac9b129328e25"]:
{{{
#!CommitTicketReference repository=""
revision="3b76a82a266d7f96019445a9189ac9b129328e25"
[1.6.x] Fixed #24070 -- Added tutorial topics to doc index.
Backport of b738178825ec9378198d77ac69699513774f0884 from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/24070#comment:6>
Django
Reporter: iambibhas | Owner: nobody
Type: | Status: closed
Cleanup/optimization |
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Comment (by Tim Graham <timograham@…>):
In [changeset:"5f8761c6396f0d27b8948f55700ec176fedbf5d5"]:
{{{
#!CommitTicketReference repository=""
revision="5f8761c6396f0d27b8948f55700ec176fedbf5d5"
[1.7.x] Fixed #24070 -- Added tutorial topics to doc index.
Backport of b738178825ec9378198d77ac69699513774f0884 from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/24070#comment:7>