-
Notifications
You must be signed in to change notification settings - Fork 27
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
Add meilisearch for docs search #726
Conversation
Docs for 527816b are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2695/docs/artifacts/html/index.html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How would meilisearch work in development mode locally? Since the docs are public, I suppose we want to limit its use only to us, not to external contributors.
Can it be disabled and default to old-search for local dev?
|
Added search functionality. Two api keys are exposed, with limited scope. The search api, which is normal and required for basic search functionality. An additional key allows for getting the list of indexes. This allows for checking if an index matching the release exists. If no index exists, the default doc search is used. Known issues: as a limit to the number of indexes/releases will eventually present itself, older indexes will need to be deleted. As Sphinx is static, this presents a bit of an issue. However, once version selection is implemented, older versions will be rebuilt, meaning older releases with deleted search indexes will fallback to using the default Sphinx search. Additionally, local/PR CI builds will use a "dev" index. This will eventually be configured to use the most recent commit, however for now the index was created by scrapping "latest". Note this commit does NOT cover the creation of indexes, which at this time will be handled manually, and requires private keys. QA: Checked rendered output, and tested a number of cases by modifying the variables used. This commit addresses task FFTK-3215 This commit applies to task FFTK-3091 Signed-off-by: Katrina Prosise <katrina.prosise@foundries.io>
527816b
to
9bba9ee
Compare
Docs for 9bba9ee are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2698/docs/artifacts/html/index.html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks Katrina! All good to me!
Added search functionality.
Two api keys are exposed, with limited scope.
The search api, which is normal and required for basic search functionality.
An additional key allows for getting the list of indexes. This allows for checking if an index matching the release exists.
If no index exists, the default doc search is used.
Known issues: as a limit to the number of indexes/releases will eventually present itself, older indexes will need to be deleted. As Sphinx is static, this presents a bit of an issue. However, once version selection is implemented, older versions will be rebuilt, meaning older releases with deleted search indexes will fallback to using the default Sphinx search.
Additionally, local/PR CI builds will use a "dev" index. This will eventually be configured to use the most recent commit, however for now the index was created by scrapping "latest".
Note this commit does NOT cover the creation of indexes, which at this time will be handled manually, and requires private keys.
QA: Checked rendered output, and tested a number of cases by modifying the variables used.
This commit addresses task FFTK-3215
This commit applies to task FFTK-3091
PR Template and Checklist
Please complete as much as possible to speed up the reviewing process.
Readiness and adding reviewers as appropriate is required.
All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.
Readiness
Overview
DOC SEARCH
Checklist
make linkcheck
.-s, --signoff
).-S, --gpg-sign
).Comments
Additional styling and configuration will be added in the future.
I also do not do Python, so code in
conf.py
is not optimized or pretty in anyway.