Bug 15459

Summary: docs.yoctoproject.org breaks search queries
Product: [Documentation] General Docs Reporter: Rob Woolley <rob.woolley>
Component: docs-generalAssignee: Antonin Godard <antonin.godard>
Status: RESOLVED DUPLICATE QA Contact:
Severity: normal    
Priority: Medium+ CC: randy.macleod
Version: unspecified   
Target Milestone: 5.2 M4   
Hardware: x86   
OS: Multiple   
Whiteboard:
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: No (bug/feature does not impact docs)

Description Rob Woolley 2024-03-26 18:31:35 UTC
There are many terms in the documentation that have non-alphanumeric characters.  When searching for these terms on docs.yoctoproject.org, it eliminates these characters and splits the term into separate words which results in poor search results.

Take the send-error-report script as an example.  Searching for send-error-report (with or without double quotes) gives many search results that are not helpful because send, error, and report are common words:  https://docs.yoctoproject.org/search.html?q=send-error-report&check_keywords=yes&area=default

What it should have brought up was the page about using the script to send error reports: eg. https://docs.yoctoproject.org/dev-manual/error-reporting-tool.html  Which does appear as the second result, but largely because the tool is named similarly to the topic.

Searching for sstate-cache-management.py, also brings up a relevant page as the second entry, however it also brings up a lot of false positives that match "py".

Another example is the "bitbake-layers" tool which has many matches for "bitbake" and "layers", but has difficulty zeroing in on hits for the bitbake-layers tool.
Comment 1 Randy MacLeod 2024-10-24 15:04:01 UTC
Bulk move of 5.1 M4 to 5.2 M2 as approved by AlexB.
Comment 2 Antonin Godard 2024-12-24 10:28:02 UTC
Hi Rob,

Indeed, I can also reproduce what you describe.

For now, searching exact matches in Sphinx (what we use to generate the doc) is not supported and is a known issue: https://github.com/sphinx-doc/sphinx/issues/3301.

There is a pull request from July on GitHub that attempts to solve the issue: https://github.com/sphinx-doc/sphinx/pull/12552.

As you can see, it is currently under discussion. I will keep track of the issue to see if this gets merged and report here once we benefit from it.

Antonin
Comment 3 Antonin Godard 2025-01-02 10:29:02 UTC
Hello Rob,

I noticed this is actually a duplicate of 14534. I will propagate the info stored here in 14534, add you in CC to it and close this ticket.

Antonin

*** This bug has been marked as a duplicate of bug 14534 ***