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

Improve documentation Response Caching documentation #3019

Open
8 tasks
EmrysMyrddin opened this issue Sep 27, 2023 · 2 comments
Open
8 tasks

Improve documentation Response Caching documentation #3019

EmrysMyrddin opened this issue Sep 27, 2023 · 2 comments

Comments

@EmrysMyrddin
Copy link
Collaborator

EmrysMyrddin commented Sep 27, 2023

Response Caching documentation is too light. It only describe the specific differences with the Envelop plugin and links to it for more informations, which is not handy for the reader.

It is even less appropriate now that more and more options slightly differs between Yoga and Envelop plugin.

This issue aims to keep track of the actions to improve this documentation page.

  • Copy and adapt the recipe section from the envelop's plugin documentation
  • API style documentation, with an entry for each option.
  • Migration guides from popular alternative (like Apollo's response cahing)
  • Knowledge base about caching.
    • Why is it needed
    • How does it works
    • Which strategy are possible, and when to use them
    • Advices about cache invalidation, how to properly do it, what common edge cases and pitfalls are and how to avoid them.
@AdiRishi
Copy link

I'm really curious about this tbh, is it possible to give a brief explanation on the differences between yoga response cache and the envelop plugin?

@EmrysMyrddin
Copy link
Collaborator Author

@AdiRishi The Envelop plugin is the base one, handling cache at a GraphQL level, without any assumption about the transport layer that will be used.

The Yoga plugin rely on the Envelop plugin, notably for the cache write part, but adds support for HTTP specific caching techniques using E-Tags header requests for example.

This allows us to achieve even better performance in yoga by skipping entirely the GraphQL pipeline when possible.

This was referenced May 7, 2024
This was referenced May 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants