docs(algolia): add methods from backend pages to algolia index #9608
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gforsyth
force-pushed
the
algolia_backend_docs
branch
2 times, most recently
from
79892d8 to
50ac036
Compare
cpcloud
approved these changes
Jul 16, 2024
gforsyth
force-pushed
the
algolia_backend_docs
branch
from
50ac036 to
c840ca5
Compare
cpcloud
reviewed
Jul 16, 2024
| for record_json in glob.glob("docs/backends/*.json"): | ||
| with open(record_json) as f: | ||
| records = json.load(f) | ||
| index.save_objects(records) |
There was a problem hiding this comment.
How expensive are these calls? Is it worth trying to make a single call?
There was a problem hiding this comment.
If there's any effort required, I'd say let's leave it until we notice a massive slowdown caused by this (which may never actually occur!)
There was a problem hiding this comment.
nah, pretty easy to smoosh them together
The backend-specific methods are added to the backend pages programmatically using `quarto`. That seems to lead to them not showing up in our Algolia search, because they aren't being scraped. It's a little gross, but I've added in a section to our api docs rendering scripts to also dump the corresponding records for each method into a backend-specific json file during `quarto` rendering. Then those backend-specific records files are loaded and added to the Algolia index in `upload-algolia-api.py`
gforsyth
force-pushed
the
algolia_backend_docs
branch
from
c840ca5 to
3db807c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description of changes
The backend-specific methods are added to the backend pages
programmatically using
quarto. That seems to lead to them not showingup in our Algolia search, because they aren't being scraped.
It's a little gross, but I've added in a section to our api docs
rendering scripts to also dump the corresponding records for each method
into a backend-specific json file during
quartorendering.Then those backend-specific records files are loaded and added to the
Algolia index in
upload-algolia-api.pyIssues closed
Resolves #9600