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

Enhance search performance of algolia plugin #2406

Merged
merged 10 commits into from Feb 15, 2024

Conversation

KevinEyo1
Copy link
Contributor

@KevinEyo1 KevinEyo1 commented Feb 5, 2024

What is the purpose of this pull request?

  • Documentation update
  • Bug fix
  • Feature addition or enhancement
  • Code maintenance
  • DevOps
  • Improve developer experience
  • Others, please explain:

Overview of changes:
Resolves #2015
Added snippet to the head of your website when using Algolia for performance optimization.

Anything you'd like to highlight/discuss:

Testing instructions:

Proposed commit message: (wrap lines at 72 characters)
Enhance search performance. It would allow user to make the
first query faster, especially on mobile, making their user
experience better.

Let's hint the browser that the website will load data from
Algolia, allowing it to preconnect to the DocSearch cluster.


Checklist: ☑️

  • Updated the documentation for feature additions and enhancements
  • Added tests for bug fixes or features
  • Linked all related issues
  • No unrelated changes

Reviewer checklist:

Indicate the SEMVER impact of the PR:

  • Major (when you make incompatible API changes)
  • Minor (when you add functionality in a backward compatible manner)
  • Patch (when you make backward compatible bug fixes)

At the end of the review, please label the PR with the appropriate label: r.Major, r.Minor, r.Patch.

Breaking change release note preparation (if applicable):

  • To be included in the release note for any feature that is made obsolete/breaking

Give a brief explanation note about:

  • what was the old feature that was made obsolete
  • any replacement feature (if any), and
  • how the author should modify his website to migrate from the old feature to the replacement feature (if possible).

Copy link

codecov bot commented Feb 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a265c73) 48.87% compared to head (4272f81) 48.87%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2406   +/-   ##
=======================================
  Coverage   48.87%   48.87%           
=======================================
  Files         124      124           
  Lines        5238     5238           
  Branches     1109     1109           
=======================================
  Hits         2560     2560           
  Misses       2371     2371           
  Partials      307      307           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@KevinEyo1 KevinEyo1 marked this pull request as ready for review February 11, 2024 15:53
Copy link
Contributor

@kaixin-hc kaixin-hc left a comment

Choose a reason for hiding this comment

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

In my testing, this seems to work and preview links SEEM to load faster as opposed to when this is not there (comparing the netlify preview on master and on this PR)

It would be great if you could show any testing you've done to verify this PR!

Copy link
Contributor

@yucheng11122017 yucheng11122017 left a comment

Choose a reason for hiding this comment

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

LGTM!

@kaixin-hc
Copy link
Contributor

@all-contributors please add @KevinEyo1 for code

Copy link
Contributor

@kaixin-hc

I've put up a pull request to add @KevinEyo1! 🎉

@kaixin-hc kaixin-hc merged commit 080527c into MarkBind:master Feb 15, 2024
8 checks passed
@yucheng11122017 yucheng11122017 added r.Patch Version resolver: increment by 0.0.1 r.Minor Version resolver: increment by 0.1.0 and removed r.Patch Version resolver: increment by 0.0.1 labels Feb 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
r.Minor Version resolver: increment by 0.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhance search performance of algolia plugin
3 participants