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

Fix search input for latest version of Algolia #985

Merged
merged 7 commits into from
Apr 30, 2022
Merged

Fix search input for latest version of Algolia #985

merged 7 commits into from
Apr 30, 2022

Conversation

LisaFC
Copy link
Collaborator

@LisaFC LisaFC commented Apr 22, 2022

@LisaFC
Copy link
Collaborator Author

LisaFC commented Apr 22, 2022

Docs now done!

@LisaFC
Copy link
Collaborator Author

LisaFC commented Apr 22, 2022

I've marked this as breaking as it will not work with Algolia DocSearch v2 - on the other hand, per #845 the old version of Algolia DocSearch doesn't work any more (v2 indexes are no longer being updated) so I'm not sure if it will make v2 users any more broken....

@chalin @geriom @emckean ideas for publicizing this? I presume we will have some v2 users who possibly haven't noticed their new content hasn't been indexed. Migration from v2 should be pretty trivial, I think the index name and search API key are the same, just the format of the snippet is different: https://docsearch.algolia.com/docs/migrating-from-v2

@LisaFC
Copy link
Collaborator Author

LisaFC commented Apr 26, 2022

@chalin ready for review!

@chalin chalin self-requested a review April 26, 2022 18:44
Copy link
Collaborator

@chalin chalin left a comment

Choose a reason for hiding this comment

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

Thanks for the update. See inline comments.

Have you tested out the instructions?

userguide/content/en/docs/Adding content/navigation.md Outdated Show resolved Hide resolved
layouts/partials/search-input.html Outdated Show resolved Hide resolved
@chalin
Copy link
Collaborator

chalin commented Apr 26, 2022

@LisaFC - Oh, just remembered: as we discussed during the PSC meeting, could you add an entry to the CHANGELOG?

@LisaFC
Copy link
Collaborator Author

LisaFC commented Apr 27, 2022

Yes, instructions tested, I added DocSearch to a test site here (using the Algolia site index): https://tender-beaver-c94732.netlify.app/

Copy link
Collaborator

@chalin chalin left a comment

Choose a reason for hiding this comment

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

LGTM

Will you be adding to the CHANGELOG file via this or a separate PR?

@LisaFC
Copy link
Collaborator Author

LisaFC commented Apr 27, 2022

I can add it in this PR - what format do we want, should we put it under a new 0.3.0 release?

@chalin
Copy link
Collaborator

chalin commented Apr 27, 2022

put it under a new 0.3.0 release?

Yes.

@LisaFC
Copy link
Collaborator Author

LisaFC commented Apr 28, 2022

Should I merge this now or do we need to do more release-y things?

@chalin
Copy link
Collaborator

chalin commented Apr 30, 2022

Should I merge this now or do we need to do more release-y things?

Thanks for your patience. I wanted to adjust the CHANGELOG a bit. That's been done.

@chalin chalin merged commit 93dbdcc into main Apr 30, 2022
@chalin chalin deleted the LisaFC-algolia branch April 30, 2022 18:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants