v0.28: Pagination guide

[guimachiavelli]

Closes #561

[guimachiavelli]

@dichotommy: I know you're short on time, so these are the areas I'm mostly interested in receiving feedback:

1. Structure: is the structure of intro > limitations > recommended solution > workarounds satisfactory? Will we help users who are having problems with building a page selection UI?
2. Terminology: I often use "page selection" and "page selector" to refer to the classic pagination UI. Is it clear what I'm talking about?
3. Length: I feel this is still too big, but perhaps I'm wrong?
4. Code samples: are the ones we currently have enough? Do they clearly illustrate our points?

Of course, any feedback is appreciated, especially if you identify any other major areas of concern I'm not aware of because I'm too much inside the subject atm.

[dichotommy]

This seems like a solid start to me. The implementation sections should probably be broken up a bit. Curious about why infinite scroll wasn't offered as an option. Too much labor to create code samples for it?

[guimachiavelli]

@bidoubiwa and @gmourier: This is the first draft of the pagination guide. As we discussed, I adapted your original article into something a bit more focussed on explaining why page selectors are not a good fit for Meilisearch and directing users to a recommended solution.

Instructions for reviewers

As usual, all feedback is welcome, but if you're on a rush, what I need the most from you is:

• Is all the information there correct? Code samples very much included;
• Do you think we need a code sample for the limit workaround (L#112)?
• @dichotommy has started a couple of discussions regarding the workarounds (one asking about using maxTotalHits instead of limit and another regarding whether we should suggest users create page selection UIs with estimatedTotalHits when the experience can be subpar). Any thoughts?
• Is there any critical info missing? I had to cut a lot of relevant content to keep the guide relatively concise. It's possible I went too far.

Other pagination methods

@dichotommy has suggested adding the other pagination methods (e.g. infinite scrolling). While I'm not opposed to it, I am concerned that this guide might already be too long. Perhaps we could make smaller guides with instructions on how to implement other UIs in the future?

CI errors

You can safely ignore those, as they're related to links to pages created in another PR.

[gmourier]

Some remarks to consider for SEO and internal knowledge and some very light rephrasing suggestions. You do what you want with it Gui, you are the master on board.

Thank you very much for this guide. 🏆

Is all the information there correct? Code samples very much included;

I didn't look at the code samples in detail. @bidoubiwa will have a better eye than me. Other than that, everything seems correct!

Do you think we need a code sample for the limit workaround (L#112)?

I don't think so but again @bidoubiwa will have a better suggestion than me since she experienced a lot of back and forth with struggling users over time around this subject.

@dichotommy has suggested adding the other pagination methods (e.g. infinite scrolling). While I'm not opposed to it, I am concerned that this guide might already be too long. Perhaps we could make smaller guides with instructions on how to implement other UIs in the future?

The main goal as we discussed @guimachiavelli is to indicate to users that a page selection is to be avoided while giving a workaround. It seems to me to be brilliantly done.

We can absolutely add other methods in the future and why not in a much more advanced guide within a resource center.

[bidoubiwa]

🔥

[gmourier]

Just pointing out that the images are still in the file changes.

Thank you for this guide @guimachiavelli and thanks to you @bidoubiwa for the code snippets. Well done!

[maryamsulemani97]

Looks good! 🦅 Just a few changes

1. I think you forgot to add '/learn/advanced/pagination', to config.js
2. Should we use "Previous" and "Next" buttons instead of previous and next buttons

[curquiza]

This guide is exactly what I expected to help the users do the migration btw v0.27.0 and v0.28.0, following the nbHits change! Thank you very much! Will be definitely helpful!

[curquiza]

Will this guide's link be https://docs.meilisearch.com/learn/advanced/pagination.html?

[guimachiavelli]

@maryamsulemani97: thanks for both suggestions 👍

@curquiza: yes, the final link should be https://docs.meilisearch.com/learn/advanced/pagination.html

Also, the good stuff here can be directly attributed to @gmourier and @bidoubiwa ❤️. I only cleaned up things a bit and made the text shorter to make it less intimidating for users.

[guimachiavelli]

bors merge

[bors]

Build failed:

• check-links