[docs] bug tracker for individual projects' search pages
Hi, I'm having issues with the individual projects' doc search pages (e.g. https://docs.openstack.org/neutron/victoria/search.html?q=test) since ussuri: When searching Ussuri and Victoria docs, malformed links are returned, and for Wallaby it doesn't return any results. It seems to affect multiple projects that provide the search page, so I am not sure where to report it. Can someone point me to the correct project/bug tracker? Thanks, Erik _____ Erik Panter Systementwickler | Infrastruktur Mittwald CM Service GmbH & Co. KG Königsberger Straße 4-6 32339 Espelkamp Tel.: 05772 / 293-900 Fax: 05772 / 293-333 Mobil: 0151 / 12345678 e.panter@mittwald.de https://www.mittwald.de Geschäftsführer: Robert Meyer, Florian Jürgens St.Nr.: 331/5721/1033, USt-IdNr.: DE814773217, HRA 6640, AG Bad Oeynhausen Komplementärin: Robert Meyer Verwaltungs GmbH, HRB 13260, AG Bad Oeynhausen Informationen zur Datenverarbeitung im Rahmen unserer Geschäftstätigkeit gemäß Art. 13-14 DSGVO sind unter www.mittwald.de/ds abrufbar.
On 2021-05-05 12:16:39 +0000 (+0000), Erik Panter wrote:
I'm having issues with the individual projects' doc search pages (e.g. https://docs.openstack.org/neutron/victoria/search.html?q=test) since ussuri: When searching Ussuri and Victoria docs, malformed links are returned, and for Wallaby it doesn't return any results.
It seems to affect multiple projects that provide the search page, so I am not sure where to report it. Can someone point me to the correct project/bug tracker?
Probably https://bugs.launchpad.net/openstack-doc-tools/+filebug is the place (that's used as a catch-all for projects like OpenStackDocsTheme). -- Jeremy Stanley
On 2021-05-05 12:16:39 +0000 (+0000), Erik Panter wrote:
I'm having issues with the individual projects' doc search pages (e.g. https://docs.openstack.org/neutron/victoria/search.html?q=test) since ussuri: When searching Ussuri and Victoria docs, malformed links are returned, and for Wallaby it doesn't return any results. [...]
Looking at the way the result links are malformed, it appears ".html" in the URL is being replaced with "undefined" so perhaps this is something to do with a filename suffix variable which the Sphinx simple search expects but which we're failing to set in its conf.py? Yet even that doesn't explain the later versions just never completing the search result request. For comparison, other documentation we're publishing with similar jobs and configs (but without the OpenStackDocsTheme) is working fine for simple search: https://docs.opendev.org/opendev/infra-manual/latest/search.html?q=test -- Jeremy Stanley
On 05.05.21 14:52, Jeremy Stanley wrote:
On 2021-05-05 12:16:39 +0000 (+0000), Erik Panter wrote:
I'm having issues with the individual projects' doc search pages (e.g. https://docs.openstack.org/neutron/victoria/search.html?q=test) since ussuri: When searching Ussuri and Victoria docs, malformed links are returned, and for Wallaby it doesn't return any results. [...]
Looking at the way the result links are malformed, it appears ".html" in the URL is being replaced with "undefined" so perhaps this is something to do with a filename suffix variable which the Sphinx simple search expects but which we're failing to set in its conf.py? Yet even that doesn't explain the later versions just never completing the search result request.
For comparison, other documentation we're publishing with similar jobs and configs (but without the OpenStackDocsTheme) is working fine for simple search:
https://docs.opendev.org/opendev/infra-manual/latest/search.html?q=test
Isn't this fixed by: https://review.opendev.org/c/openstack/openstackdocstheme/+/753283 Maybe a new release needs to be done? Andreas -- Andreas Jaeger aj@suse.com Twitter: jaegerandi SUSE Software Solutions Germany GmbH, Maxfeldstr. 5, D 90409 Nürnberg (HRB 36809, AG Nürnberg) GF: Felix Imendörffer GPG fingerprint = EF18 1673 38C4 A372 86B1 E699 5294 24A3 FF91 2ACB
On 2021-05-05 15:19:16 +0200 (+0200), Andreas Jaeger wrote:
On 05.05.21 14:52, Jeremy Stanley wrote:
On 2021-05-05 12:16:39 +0000 (+0000), Erik Panter wrote:
I'm having issues with the individual projects' doc search pages (e.g. https://docs.openstack.org/neutron/victoria/search.html?q=test) since ussuri: When searching Ussuri and Victoria docs, malformed links are returned, and for Wallaby it doesn't return any results. [...]
Looking at the way the result links are malformed, it appears ".html" in the URL is being replaced with "undefined" so perhaps this is something to do with a filename suffix variable which the Sphinx simple search expects but which we're failing to set in its conf.py? [...] Isn't this fixed by:
https://review.opendev.org/c/openstack/openstackdocstheme/+/753283
Maybe a new release needs to be done?
Good find! Yeah that seems to be included in 2.2.6 from October (2.2.7 is the latest release BTW), but we constrain the versions used by branch so only stable/wallaby and master are using it. For stable/victoria we build with 2.2.5 which explains why we see that behavior on victoria and earlier branch docs. That still doesn't explain the later versions just never completing the search result request, but does point out that there's a good chance it's a regression in the theme. -- Jeremy Stanley
participants (3)
-
Andreas Jaeger
-
Erik Panter
-
Jeremy Stanley