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

Rewrite documentation for custom pagination with field policies #7175

Merged
merged 7 commits into from
Oct 27, 2020

Conversation

benjamn
Copy link
Member

@benjamn benjamn commented Oct 16, 2020

This is a long-overdue rewrite of the https://www.apollographql.com/docs/react/data/pagination/ documentation (the first item in #6711), to reflect the new tools that Apollo Client 3 provides.

I welcome your feedback in the form of comments, but I'm not looking for a PR review just yet, because the rewriting is still very much in progress!

Quick link to the deploy preview: https://deploy-preview-7175--apollo-client-docs.netlify.app/docs/react/data/pagination/

@MarkellRichards
Copy link

MarkellRichards commented Oct 20, 2020

Hi Benjamin,

Thanks for posting the preview. I'm trying to make sense of it. I'm running into the same issue where I have two separate entries in the cache based on the args. Maybe you could provide guidance?

https://stackoverflow.com/questions/64421566/data-not-merging-apollo-3-pagination-with-field-policies

@benjamn benjamn force-pushed the docs-for-custom-pagination branch from 8dea866 to 5731c38 Compare October 20, 2020 22:09
@benjamn benjamn marked this pull request as ready for review October 21, 2020 21:27
@benjamn benjamn force-pushed the docs-for-custom-pagination branch from 211fdd4 to 88d95b3 Compare October 21, 2020 21:28
@benjamn benjamn force-pushed the docs-for-custom-pagination branch from 967c321 to 8e78ce3 Compare October 26, 2020 15:34
@hwillson
Copy link
Member

@StephenBarlow can you let me know when you're done with your edits? I'll hold off on reviewing until your changes are in. Thanks!

@hwillson
Copy link
Member

Disregard @StephenBarlow - I talked to @benjamn and know the plan is to hold off on further edits until after this is merged.

@benjamn benjamn force-pushed the docs-for-custom-pagination branch from eecbc19 to 96a2dbe Compare October 26, 2020 18:27
@benjamn
Copy link
Member Author

benjamn commented Oct 26, 2020

@StephenBarlow @hwillson I split the content about keyArgs out into a separate page, and added some additional context as an introduction to that page. I feel like the new text I added may be unnecessarily complicated, but I'm not sure how to simplify it without discarding useful information. Please feel free to leave comments or propose changes, though I expect we will continue iterating on this documentation even after this PR has been merged.

@StephenBarlow
Copy link
Contributor

@benjamn The keyArgs split-out looks good! If you're happy with the content-completeness of these docs, I think we should go ahead and get them out there. I think a steady stream of improvements over the next few weeks will do the trick.

Copy link
Member

@hwillson hwillson left a comment

Choose a reason for hiding this comment

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

This is really great @benjamn!

@benjamn benjamn force-pushed the docs-for-custom-pagination branch from 96a2dbe to ad01a34 Compare October 27, 2020 16:14
@benjamn benjamn merged commit 4fe5762 into main Oct 27, 2020
@StephenBarlow StephenBarlow deleted the docs-for-custom-pagination branch October 4, 2021 19:28
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 15, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants