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

`AV-56565 Docsearch - handle results from the new Algolia docsearch #179

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

osfameron
Copy link
Contributor

The new Algolia docsearch is hosted on https://docsearch.algolia.com/ and uses the Algolia crawler infrastructure.

While it's similar to "Legacy Docsearch v2" which we run on AWS EC2, it doesn't seem to return the records in exactly the format that the client .js library was expecting.
(This might be my bad for misconfiguring it? Either way, we have to handle the results arriving in an unexpected shape which:

  1. broke the JS entirely
  2. or caused it to show bad/incomplete results )

This commit:

  • Fix filter of records with no title

  • simplifies the Component Version parsing (e.g. "java-sdk", 3.1).
    I didn't really understand the existing logic, and in the meantime, our UI is exporting the data in more easily parseable structures.
    So, though this doesn't look like a like-for-like translation, I think we'll retain the same features...

  • Change slash to right chevron, as requested by Website team (to be consistent with how the other index sources are showing breadcrumbs)

Uses U+203A Single Right-Pointing Angle Quotation Mark
(instead of >, partly to avoid escaping it in HTML/meta tag...)

Fix filter of records with no title

Change slash to right chevron

U+203A Single Right-Pointing Angle Quotation Mark
(instead of `>`, partly to avoid escaping it in HTML/meta tag...)
@osfameron osfameron requested a review from a team April 4, 2024 13:53
Copy link
Contributor

@dgnicholson dgnicholson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is slightly out of my depth, but from a cursory review I don't see any obvious issues. 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants