Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Searching documentation returns no results for pinned versions #8159

Closed
Tracked by #10139
wimfeijen opened this issue Mar 17, 2022 · 3 comments
Closed
Tracked by #10139

Searching documentation returns no results for pinned versions #8159

wimfeijen opened this issue Mar 17, 2022 · 3 comments
Assignees
Labels
Documentation Infrastructure Issues that relate to online tools we use to develop Wagtail type:Bug
Milestone

Comments

@wimfeijen
Copy link

Searching the Wagtail documentation regularly returns no results, while it should.

For example, when I search on image, I get no results.

https://docs.wagtail.org/en/v2.16.1/search.html?q=image#

I am using Firefox 98.0.1 as a browser
Screenshot 2022-03-17 at 11 37 38
.

@lb-
Copy link
Member

lb- commented Mar 17, 2022

Yeah, looks like the search does not work for versions but it does for stable/latest

Not sure if it is a limitation of our usage of read the docs?

Also, if you use the search field in the versions popup you get taken to a completely different version of the docs.
https://readthedocs.org/projects/wagtail/search/?q=image

Screen Shot 2022-03-17 at 8 47 10 pm

Screen Shot 2022-03-17 at 8 47 18 pm

@lb- lb- added Documentation Infrastructure Issues that relate to online tools we use to develop Wagtail labels Mar 17, 2022
@loicteixeira loicteixeira changed the title Bug in searching documentation Searching documentation returns no results for pinned versions Jul 28, 2022
@gasman gasman added this to the 4.2 milestone Dec 16, 2022
@gasman gasman modified the milestones: 4.2, 4.3 Jan 18, 2023
@thibaudcolas
Copy link
Member

This is now fixed as of #10207 for versions released since last Friday. I’ve tested with the recently-released v4.2.1, which doesn’t contain the documentation for "StreamField validation" added in latest.

Unfortunately I believe it’s impossible for us to make search work for past versions – I’m checking just to be sure before closing this, and will add any notes to the Documentation search wiki page.

@thibaudcolas thibaudcolas self-assigned this Mar 13, 2023
@thibaudcolas
Copy link
Member

Here is documentation from Read The Docs on this: How we envision versions working.

Since we use tags for each version, it’s currently not possible for us to rebuild past versions of the docs. If we wanted to do this, we’d need to switch from tags to branches. They would either need to be named the same in git, or we could switch to 4.2.x-type patterns and set up redirects.

This would be quite a lot of work to do if we kept publishing separate versions of the docs for each patch release, so I’m going to guess this is too much work for us to consider. If we only published documentation for major and minor releases in the future, it might be more manageable for each of them to have a long-lived branch which we could update when needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Infrastructure Issues that relate to online tools we use to develop Wagtail type:Bug
Projects
No open projects
Status: Done
Development

No branches or pull requests

4 participants