Opened 8 minutes ago
#37501 new Cleanup/optimization
Update, Move, Consolidate, Archive, or Remove Cookbook Wiki page from Trac?
| Reported by: | Stephanie Goulet | Owned by: | |
|---|---|---|---|
| Component: | Documentation | Version: | 6.1 |
| Severity: | Low | Keywords: | |
| Cc: | Triage Stage: | Unreviewed | |
| Has patch: | no | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
I was reading a deep cut forum post and someone linked to Django's Cookbook Wiki (https://code.djangoproject.com/wiki/CookBook).
I haven't looked through all the links, but a few things jumped out at me at first glance on the main table of contents page as potentials to update:
- Text at the top that says "Can someone 'in the know' please check which recipes are still relevant? Thanks."
- Two broken links:
- FreeComment app?
- Making User info available outside requests?
Relatedly, I'm not sure about how much this is used (or updated) by others. If it's still useful as a common reference, we might consider improving its discoverability in some way, e.g. consolidating these into the main documentation site or moving them there wholesale. This is one of the only times I've come across it, and I've poked around the Django community a decent amount.
Alternatively, if they're not useful or out of date, updating, archiving or removing them might be considered.
PS: when I went to copy/paste the link for the Cookbook page in this ticket, I found that I actually couldn't get to it from the "Wiki" tab in the top menu (I previously expected that I could and they were the same because when you're on the Cookbook page, the menu looks like its selecting "Wiki" in dark green). So the Wiki page (https://code.djangoproject.com/wiki) is both not the Cookbook page and also doesn't link to the Cookbook page either. This might be because it's been intentionally or unintentionally pseudo-archived in the past by removing links to it. If that was intentional, we might consider adding a note at the top of the Cookbook page that gives a heads up to stray wanderers that it's archived and not being maintained/updated.