Add support for Mkdocs search #6937
Conversation
stsewd
added
PR: work in progress
stsewd
removed
Needed: tests
|
Some comparisons (letft RTD search, right MkDocs search). |
|
To make the search available to all projects, we need to trigger a build or crawl all mkdocs projects (and versions) on storage and copy it's |
|
@stsewd I wonder if it makes more sense to just read the |
There was a problem hiding this comment.
This looks like a good change. I'd like to:
- Remove the json builder, so we can automatically reindex all existing mkdocs projects. It isn't needed, I don't think?
- Start by indexing the files first, so that our site search works, but we don't override the in-doc search results quite yet. This will let us roll this out in a nice staged way instead of breaking all mkdocs projects.
- Probably add a way to opt out of our search for mkdocs users as well
| function init() { | ||
| var data = rtddata.get(); | ||
| attach_elastic_search_query(data); | ||
| if (data.builder === 'mkdocs') { | ||
| attach_elastic_search_query_mkdocs(data); |
There was a problem hiding this comment.
This scares me a little bit, overwriting the users search content. Can we ship the indexing code and let it settle in before we try overriding the actual results for users?
There was a problem hiding this comment.
Sure, I can revert the js change and put it in another PR respecting the "skip search" flag.
Don't inject our search just yet
|
Changed to index directly from the html artifacts in storage and reverted the js changes, this is ready for review. |
Closes #1088
Related to #4588
Things to do:
Override the search js with ours to call ESCache the processed index file per projectAdd testsBut currently is working if someone wants to test it :)