Opened 8 years ago

Closed 8 years ago

Last modified 8 years ago

#27680 closed Cleanup/optimization (fixed)

Recommend ccbv.co.uk in class-based views docs

Reported by: James Pic Owned by: nobody
Component: Documentation Version: 1.10
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description (last modified by James Pic)

Some users have reported difficulties using CBV, and there's a thread about deprecating them: https://groups.google.com/forum/#!topic/django-developers/u1aLYz3fAUw

The root cause seems to be that users have hard time finding their way in the class hierarchy and a website has been made specially for that: ccbv.co.uk

However, that website is so far only mentioned in the team page (in Marc Tamlyn's section). This ticket proposes to try harder to spread the word about it and help reducing the amount of users in difficulty when trying to find their way in the hierarchy.

https://github.com/django/django/pull/7785

Change History (8)

comment:1 by James Pic, 8 years ago

Description: modified (diff)
Has patch: set

comment:2 by Tim Graham, 8 years ago

Summary: Advertise ccbv.co.uk in CBV/introRecommend ccbv.co.uk in class-based views docs
Triage Stage: UnreviewedAccepted
Type: New featureCleanup/optimization

comment:3 by Emett Speer, 8 years ago

It may just be worth updating the documentation to make it more clear rather then relying on a 3rd party website no matter how good that site is.

comment:4 by Tim Graham, 8 years ago

We're very conservative about endorsing third-party websites in the documentation, however, I don't think the interactive functionality that site provides can be duplicated in our documentation. If it were to stop being maintained, I think there's a good chance the Django Software Foundation would adopt it.

comment:5 by Emett Speer, 8 years ago

I do believe that the site is well done and a really good resource. With that being said there is a real issue with the Django documentation for this if it requires a 3rd party website for people to understand them. I do not clam to have the answer but think its worth talking about how we could make the class based views documentation better.

in reply to:  5 comment:6 by James Pic, 8 years ago

ccbv is not "required", per say, but it's really well done and helpful indeed. This ticket is not about rewriting the cbv documentation, it's about providing users with ccbv.

If you think its worth talking about how we could make the class based views documentation better then feel free to start a thread on the django-developer mailing list.

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

Resolution: fixed
Status: newclosed

In f582db12:

[1.10.x] Fixed #27680 -- Linked to "Classy Class-Based Views" in docs.

Backport of 944610a86c81f90c3c79e5440a5e2c706aa0ef62 from master

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

In 944610a:

Fixed #27680 -- Linked to "Classy Class-Based Views" in docs.

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