<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<!DOCTYPE bugzilla SYSTEM "https://bugzilla.yoctoproject.org/page.cgi?id=bugzilla.dtd">

<bugzilla version="5.0.6"
          urlbase="https://bugzilla.yoctoproject.org/"
          
          maintainer="it-coreprojects-helpdesk@linuxfoundation.org"
>

    <bug>
          <bug_id>15459</bug_id>
          
          <creation_ts>2024-03-26 18:31:35 +0000</creation_ts>
          <short_desc>docs.yoctoproject.org breaks search queries</short_desc>
          <delta_ts>2025-01-02 10:29:02 +0000</delta_ts>
          <reporter_accessible>1</reporter_accessible>
          <cclist_accessible>1</cclist_accessible>
          <classification_id>9</classification_id>
          <classification>Documentation</classification>
          <product>General Docs</product>
          <component>docs-general</component>
          <version>unspecified</version>
          <rep_platform>x86</rep_platform>
          <op_sys>Multiple</op_sys>
          <bug_status>RESOLVED</bug_status>
          <resolution>DUPLICATE</resolution>
          <dup_id>14534</dup_id>
          
          <bug_file_loc></bug_file_loc>
          <status_whiteboard></status_whiteboard>
          <keywords></keywords>
          <priority>Medium+</priority>
          <bug_severity>normal</bug_severity>
          <target_milestone>5.2 M4</target_milestone>
          
          
          <everconfirmed>1</everconfirmed>
          <reporter name="Rob Woolley">rob.woolley</reporter>
          <assigned_to name="Antonin Godard">antonin.godard</assigned_to>
          <cc>randy.macleod</cc>
          
          
          <cf_os>---</cf_os>
          <cf_regression_type>---</cf_regression_type>
          
          <cf_docchange>No (bug/feature does not impact docs)</cf_docchange>

      

      

      

          <comment_sort_order>oldest_to_newest</comment_sort_order>  
          <long_desc isprivate="0" >
    <commentid>98623</commentid>
    <comment_count>0</comment_count>
    <who name="Rob Woolley">rob.woolley</who>
    <bug_when>2024-03-26 18:31:35 +0000</bug_when>
    <thetext>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&amp;check_keywords=yes&amp;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 &quot;py&quot;.

Another example is the &quot;bitbake-layers&quot; tool which has many matches for &quot;bitbake&quot; and &quot;layers&quot;, but has difficulty zeroing in on hits for the bitbake-layers tool.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>100017</commentid>
    <comment_count>1</comment_count>
    <who name="Randy MacLeod">randy.macleod</who>
    <bug_when>2024-10-24 15:04:01 +0000</bug_when>
    <thetext>Bulk move of 5.1 M4 to 5.2 M2 as approved by AlexB.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>100498</commentid>
    <comment_count>2</comment_count>
    <who name="Antonin Godard">antonin.godard</who>
    <bug_when>2024-12-24 10:28:02 +0000</bug_when>
    <thetext>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</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>100517</commentid>
    <comment_count>3</comment_count>
    <who name="Antonin Godard">antonin.godard</who>
    <bug_when>2025-01-02 10:29:02 +0000</bug_when>
    <thetext>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 ***</thetext>
  </long_desc>
      
      

    </bug>

</bugzilla>