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

[docs] Revert hits per page change #17458

Merged
merged 1 commit into from
Sep 17, 2019

Conversation

eps1lon
Copy link
Member

@eps1lon eps1lon commented Sep 17, 2019

The change of hitsPerPage in #17450 had some unintended side-effects. The goal was to make large resultsets pageable but it also changed how these resultsets are created. It is the documented, recommended approach for pagination of algolia results but I would never expect pagination to change what results are displayed or in which order. It should only add more i.e. if I had 5 before and extend it to 10 the first 5 should stay the same.

For example all results for icons linked to https://material-ui.netlify.com/components/icons/. Extending to hitsPerPage should've made it possible to scroll past a single page. Unfortunately it changed the resultset of e.g. input which now links to https://material-ui.netlify.com/api/input/ in the first 6 results where it only displayed 2 previously.

Looks like the default is 2 which would've made it clear that this is no pure pagination option.

@eps1lon eps1lon added the docs Improvements or additions to the documentation label Sep 17, 2019
@mui-pr-bot
Copy link

Details of bundle changes.

Comparing: daac056...7268555

bundle parsed diff gzip diff prev parsed current parsed prev gzip current gzip
@material-ui/core 0.00% 0.00% 331,674 331,674 90,549 90,549
@material-ui/core/Paper 0.00% 0.00% 68,659 68,659 20,458 20,458
@material-ui/core/Paper.esm 0.00% 0.00% 62,098 62,098 19,203 19,203
@material-ui/core/Popper 0.00% 0.00% 28,397 28,397 10,159 10,159
@material-ui/core/Textarea 0.00% 0.00% 5,082 5,082 2,132 2,132
@material-ui/core/TrapFocus 0.00% 0.00% 3,766 3,766 1,596 1,596
@material-ui/core/styles/createMuiTheme 0.00% 0.00% 16,348 16,348 5,818 5,818
@material-ui/core/useMediaQuery 0.00% 0.00% 2,488 2,488 1,050 1,050
@material-ui/lab 0.00% 0.00% 154,735 154,735 46,915 46,915
@material-ui/styles 0.00% 0.00% 51,420 51,420 15,288 15,288
@material-ui/system 0.00% 0.00% 15,581 15,581 4,351 4,351
Button 0.00% 0.00% 78,633 78,633 24,021 24,021
Modal 0.00% 0.00% 14,542 14,542 5,114 5,114
Portal 0.00% 0.00% 2,907 2,907 1,318 1,318
Rating 0.00% 0.00% 69,963 69,963 21,856 21,856
Slider 0.00% 0.00% 75,084 75,084 23,184 23,184
colorManipulator 0.00% 0.00% 3,835 3,835 1,519 1,519
docs.landing 0.00% 0.00% 52,232 52,232 13,768 13,768
docs.main -0.00% -0.01% 597,770 597,755 190,863 190,851
packages/material-ui/build/umd/material-ui.production.min.js 0.00% 0.00% 302,583 302,583 86,985 86,985

Generated by 🚫 dangerJS against 7268555

@eps1lon
Copy link
Member Author

eps1lon commented Sep 17, 2019

Yeah I don't understand how these resultsets are agregated. Setting it to 5 will display 2 links to the input API but setting it to 40 will display all. Couldn't find any documentation for that and don't want to spend more time on it. I would just recommend to use another search engine for searching the docs.

@oliviertassinari
Copy link
Member

oliviertassinari commented Sep 17, 2019

I start to wonder if most people don't query on Google directly. The query "material-ui" accounts for 10% of our SEO traffic. The usage of Algolia, from the stats, is strange. About 25% of our users, for a given month, do at least one search. Shouldn't this number be higher? 🤔 I'm wondering what value this metric has on the other projects.

@oliviertassinari oliviertassinari merged commit 4007898 into mui:master Sep 17, 2019
@eps1lon eps1lon deleted the docs/revert-search-results branch September 18, 2019 06:32
nrkroeker added a commit to nrkroeker/material-ui that referenced this pull request Sep 18, 2019
* [docs] Batch small changes (mui#17435)

* [docs] Add synonyms for brand icons (mui#17455)

* [docs] Add synonyms for brand icons

* Remove Ic prefixed icons

* [docs] Improve in-site search (mui#17450)

* [ButtonBase] Fix blurry text issue (mui#17453)

* [docs] Revert hits per page change (mui#17458)

* [docs] Fix heading format in CONTRIBUTING.md (mui#17460)

* [Chip] Load the right version of Avatar (mui#17469)

* [TablePagination] Merge root classes properly (mui#17467)

* [Breadcrumbs] Improve API docs (mui#17468)

* [TextField] Handle Chrome autofill (mui#17436)

* [docs] Clarify props spread for ListItem when button flag is set (mui#17466)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants