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: add cdn proxy section #20408

Merged
merged 4 commits into from Apr 25, 2023

Conversation

clemcode
Copy link
Contributor

❓ 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

Some Cloudflare proxy options can lead to unexpected behavior for Nuxt. This PR integrates in the 3.x documentation the instructions documented on the 2.x docs

@codesandbox
Copy link

codesandbox bot commented Apr 20, 2023

CodeSandbox logoCodeSandbox logoΒ  Open in CodeSandbox Web Editor | VS Code | VS Code Insiders

@nuxt-studio
Copy link

nuxt-studio bot commented Apr 20, 2023

βœ… Live Preview ready!

Name Edit Preview Latest Commit
Nuxt Docs Edit on Studio β†—οΈŽ View Live Preview c559a80

Co-authored-by: Damian GΕ‚owala <48835293+DamianGlowala@users.noreply.github.com>
@danielroe
Copy link
Member

It feels like maybe this should be on a provider-specific page, maybe in the Nitro docs? Or, if there is more content like this in the docs, perhaps we could assemble it into a page on 'deployment caveats' or similar?

@clemcode
Copy link
Contributor Author

I agree this is not an ideal place. Is it possible it also affects Nitro independently of Nuxt? If so, happy to make the PR on the Nitro repository.
For now, it is the only caveat of this type that I witnessed, but if more of these should arise, a dedicated page on the Nuxt docs seems the way to go.

@Atinux
Copy link
Member

Atinux commented Apr 25, 2023

I could move this later in a deployment best practices / caveats but I think right now it is already good to have this in docs

@Atinux Atinux self-requested a review April 25, 2023 12:32
@danielroe danielroe changed the title docs(deployment): add cloudflare proxy section docs: add cdn proxy section Apr 25, 2023
@danielroe danielroe merged commit dd5f007 into nuxt:main Apr 25, 2023
1 check passed
This was referenced Apr 25, 2023
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

5 participants