Opened 8 years ago

Closed 8 years ago

Last modified 8 years ago

#24070 closed Cleanup/optimization (fixed)

Mention the topic of the tutorial parts beside them

Reported by: Bibhas C Debnath Owned by: nobody
Component: Documentation Version: dev
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

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.

Attachments (2)

tutorial_parts.patch (1.0 KB) - added by Bibhas C Debnath 8 years ago.
24070.diff (899 bytes) - added by Tim Graham 8 years ago.

Download all attachments as: .zip

Change History (9)

Changed 8 years ago by Bibhas C Debnath

Attachment: tutorial_parts.patch added

comment:1 Changed 8 years ago by Tim Graham

Triage Stage: UnreviewedAccepted
Type: UncategorizedCleanup/optimization

How about something a little less verbose like the attached?

Changed 8 years ago by Tim Graham

Attachment: 24070.diff added

comment:2 Changed 8 years ago by Bibhas C Debnath

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.

comment:3 Changed 8 years ago by Claude Paroz

Triage Stage: AcceptedReady for checkin

comment:4 Changed 8 years ago by Bibhas C Debnath

comment:5 Changed 8 years ago by Tim Graham <timograham@…>

Resolution: fixed
Status: newclosed

In b738178825ec9378198d77ac69699513774f0884:

Fixed #24070 -- Added tutorial topics to doc index.

comment:6 Changed 8 years ago by Tim Graham <timograham@…>

In 3b76a82a266d7f96019445a9189ac9b129328e25:

[1.6.x] Fixed #24070 -- Added tutorial topics to doc index.

Backport of b738178825ec9378198d77ac69699513774f0884 from master

comment:7 Changed 8 years ago by Tim Graham <timograham@…>

In 5f8761c6396f0d27b8948f55700ec176fedbf5d5:

[1.7.x] Fixed #24070 -- Added tutorial topics to doc index.

Backport of b738178825ec9378198d77ac69699513774f0884 from master

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