Replaced default search with Google #1667
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Default search is full of issues: https://github.com/sphinx-doc/sphinx/labels/html%20search
I think Google search is our best bet.
I have created a rst page to show the results but didn't add it in
toc
so build throwschecking consistency... getodk-docs/docs/google-search.rst: WARNING: document isn't included in any toctree
. Is there any better way? or is it ok to ignore this warning. (if we go with this route then we need to add this page to ignore list of robot.txt)Google provides many layouts, I am using "result only", which gives us ability to use custom search box and show results in a separate page. The reason to choose this approach is that default search-box of Google doesn't match our theme, especially it contains search button that takes significant space. And I am trying to avoid hacky customization.
Alternative approach is to use "overlay" layout, which shows search result in a modal box. That way we won't need a separate search rst page.
nb: I have created "Programmable Search Engine" under my getodk account to generate
cx
. Is that okay or another account should be used?https://programmablesearchengine.google.com/u/4/controlpanel/all
What is left to be done in the addressed issue?