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

New version of Algolia search breaks DOCSY search #845

Closed
prdsoftware opened this issue Jan 18, 2022 · 9 comments · Fixed by #985
Closed

New version of Algolia search breaks DOCSY search #845

prdsoftware opened this issue Jan 18, 2022 · 9 comments · Fixed by #985
Labels
duplicate This issue or pull request already exists search Site search / search engines

Comments

@prdsoftware
Copy link

There is a new version of Algolia search that has a different interface that doesn't seem to work with Docsy.

The new Algolia DocSearch no longer uses the ".td-search-input" as an input parameter in the new javascript.
https://www.docsy.dev/docs/adding-content/navigation/#configure-algolia-docsearch

The new v3 Algolia JS doco is here and uses "container" instead
https://docsearch.algolia.com/docs/docsearch-v3/

This seems like something Docsy has to update to? Not sure what the implications are here, but posting here for someone who might know a bit more about this.

Thanks Docsy team!

@deining deining added the search Site search / search engines label Jan 18, 2022
@LisaFC
Copy link
Collaborator

LisaFC commented Jan 19, 2022

Yes, looks like we'd need to update if we wanted to use v3. @alexearnshaw added our Algolia integration but I don't know how free she is to look at it - does anyone else fancy taking a look?

@LisaFC
Copy link
Collaborator

LisaFC commented Jan 19, 2022

Duplicate of #738

@LisaFC LisaFC marked this as a duplicate of #738 Jan 19, 2022
@deining deining added the duplicate This issue or pull request already exists label Jan 19, 2022
@Symbolics
Copy link

Just wonder where this is in the priority queue. Algolia isn't updating the search index for the sites after their transition, and new content is no longer being captured.

@LisaFC
Copy link
Collaborator

LisaFC commented Mar 7, 2022

So is it the case that if you move to v3 it stops working, or are earlier versions of Algolia not working either?

@Symbolics
Copy link

I haven't moved to v3 yet because the only site I maintain is using Docsy. It appears that if you don't move, then the old version has stopped working.

@prdsoftware
Copy link
Author

My understanding is that v2 indexes are no longer be updated, meaning that new content is not searchable, and DOCSY currently doesn't support moving to v3 because of the not supporting the new interface. This means that Algolia is no longer a viable search option for DOCSY until the v3 interface is supported.

@LisaFC
Copy link
Collaborator

LisaFC commented Mar 7, 2022

Ah right, I thought v2 was still working so it was only urgent if users needed v3 features, if it's entirely broken then yes, we should get it fixed ASAP.

@LisaFC
Copy link
Collaborator

LisaFC commented Mar 7, 2022

Seems simple enough to update it - here is a (slightly broken) test site with a new Algolia box (using the search index for the Docsearch docs as I didn't have one for this site): https://tender-beaver-c94732.netlify.app/docs/overview/

Q: that's the standard Algolia CSS for the search box, do we want something different? I can play around with it and our styling.

@prdsoftware
Copy link
Author

The new Algolia search box is different from v2, but it's fine the way it is IMO. It's got more functionality, and uses the latest index, so I say go for it. Thanks for your work on this.

Looking forward to seeing this change make it into Docsy.

LisaFC added a commit that referenced this issue Apr 22, 2022
chalin pushed a commit that referenced this issue Apr 27, 2022
chalin added a commit that referenced this issue Apr 30, 2022
* Fix search input for latest version of Algolia

Fixes #845

* Document how to configure
* Add note about migration
* Implementing chalin's edits
* Update CHANGELOG.md

* CHANGELOG: mark 0.3.0 as unpublished, and other tweaks

Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
duplicate This issue or pull request already exists search Site search / search engines
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants