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(cache): add example usage for cache.varies #2241

Merged
merged 1 commit into from
Mar 15, 2024

Conversation

adamdehaven
Copy link
Contributor

@adamdehaven adamdehaven commented Mar 11, 2024

πŸ”— Linked issue

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme, or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

The cache.varies option for routeRules needs to be better documented to help understand the cache behavior and discarded headers, especially related to multi-tenant implementations.

The explanation is not currently obvious when reading through the docs; however, was better explained in nuxt/nuxt#26102 (comment) by @pi0. This PR surfaces the explanation and provides docs visitors a keyword of "tenant" they can search for as a hint. (It took me 3 days to figure out why my host headers were returning localhost πŸ˜… )

I also created a corresponding PR for the Nuxt docs: nuxt/nuxt#26197

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

The cache.varies option needs to be better documented to help understand multi-tenant implementation
and discarded headers.
@pi0 pi0 changed the title docs(nitro): improve cache.varies property documentation docs(cache): add example description for cache.varies Mar 15, 2024
Copy link
Member

@pi0 pi0 left a comment

Choose a reason for hiding this comment

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

Thanks!

@pi0 pi0 changed the title docs(cache): add example description for cache.varies docs(cache): add example usage for cache.varies Mar 15, 2024
@pi0 pi0 merged commit cc24c20 into unjs:main Mar 15, 2024
@adamdehaven adamdehaven deleted the docs/improve-varies-option-documentation branch March 15, 2024 17:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants