[Django] #32890: Consider ranking the documentation search results

7 views
Skip to first unread message

Django

unread,
Jun 29, 2021, 5:17:23 AM6/29/21
to django-...@googlegroups.com
#32890: Consider ranking the documentation search results
-------------------------------------------+------------------------
Reporter: Roland van Laar | Owner: nobody
Type: Uncategorized | Status: new
Component: Uncategorized | Version: 3.2
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-------------------------------------------+------------------------
I had this experience this morning with the search results. My goals was
to find the documentation on `on_delete`.

- I searched for `on_delete`:
https://docs.djangoproject.com/en/3.2/search/?q=on_delete

There were 10 results displayed on the first page, and 11 pages in total.
6 of those results were pre 2.x release notes.

The most promising result was result number 10: `Model instance
reference`. https://docs.djangoproject.com/en/3.2/ref/models/instances/

Model instance reference doesn't have anything for on_delete on it's page.
i.e. `Phrase not found` when searching

I think Django is helped by a good search system for their documentation.
Therefor, consider adding a ranking of sorts that ranks the documentation.

- release notes are helpful when they are recent
- pages that don't have the queried text on them is less helpful.

--
Ticket URL: <https://code.djangoproject.com/ticket/32890>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,
Jun 29, 2021, 5:34:48 AM6/29/21
to django-...@googlegroups.com
#32890: Consider ranking the documentation search results
---------------------------------+--------------------------------------

Reporter: Roland van Laar | Owner: nobody
Type: Uncategorized | Status: closed
Component: Uncategorized | Version: 3.2
Severity: Normal | Resolution: invalid

Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
---------------------------------+--------------------------------------
Changes (by Mariusz Felisiak):

* status: new => closed
* resolution: => invalid


Comment:

Thanks for this ticket, however it's rather an issue in the
`djangoproject.com` not in Django itself. You can open a new issue
[https://github.com/django/djangoproject.com/issues there].

--
Ticket URL: <https://code.djangoproject.com/ticket/32890#comment:1>

Reply all
Reply to author
Forward
0 new messages