Asking input for changing documentation how to change site header in tutorial02 (1.7 version)

85 views
Skip to first unread message

Vajrasky Kok

unread,
Nov 7, 2013, 10:39:21 AM11/7/13
to django-d...@googlegroups.com
Greetings, friends!

I found a bug (https://code.djangoproject.com/ticket/21378) in tutorial02 (dev/1.7 version) which can be found here: https://docs.djangoproject.com/en/dev/intro/tutorial02/. To change site header, I was told to override the "generic Django text" in the template. But in Django 1.7, we have site_header attribute in AdminSite which we can implement (https://docs.djangoproject.com/en/dev/releases/1.7/).

So I already created a pull request to modify this document. But there was a gentleman who raised objection that the ability to override site header was really not that important and was better skipped in tutorial02 because my modification lengthen the documentation.

So I ask your opinions here. Once we have agreement, I'll modify the pull request. Thanks.

Aymeric Augustin

unread,
Nov 7, 2013, 5:27:58 PM11/7/13
to django-d...@googlegroups.com
On 7 nov. 2013, at 16:39, Vajrasky Kok <sky...@speaklikeaking.com> wrote:

> So I already created a pull request to modify this document. But there was a gentleman who raised objection that the ability to override site header was really not that important and was better skipped in tutorial02 because my modification lengthen the documentation.
>
> So I ask your opinions here. Once we have agreement, I'll modify the pull request. Thanks.

I appreciate the effort you put in this pull request. However, I agree that it’s too long. We’re trying very hard to keep the tutorial focused on the absolute basics, and we’re removing every sentence we can remove.

Adrian considered this issue when he committed the feature, see https://github.com/django/django/commit/a962286b74f1e8c8cb19fb45a057800da8c2fb56#commitcomment-4035321
> Not sure yet whether I'll change the tutorial bit, because that section appears to double as an introduction to template overriding, so it may not be worth removing.

But it isn’t clear whether he made a decision to leave the tutorial as is or just moved on!

If you’re going change the tutorial, here’s my advice:
- make sure the concept of template inheritance is introduced somewhere else.
- make the new version shorter than the old one — it’s supposed to be easier, isn’t it?


Aymeric.
Reply all
Reply to author
Forward
0 new messages