#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 )
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.
Change History (8)
comment:1 by , 8 years ago
| Description: | modified (diff) |
|---|---|
| Has patch: | set |
comment:2 by , 8 years ago
| Summary: | Advertise ccbv.co.uk in CBV/intro → Recommend ccbv.co.uk in class-based views docs |
|---|---|
| Triage Stage: | Unreviewed → Accepted |
| Type: | New feature → Cleanup/optimization |
comment:3 by , 8 years ago
comment:4 by , 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.
follow-up: 6 comment:5 by , 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.
comment:6 by , 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.
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.