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(cloudflare): update deployment guide #2074

Merged
merged 4 commits into from
Jan 23, 2024

Conversation

dario-piotrowicz
Copy link
Contributor

@dario-piotrowicz dario-piotrowicz commented Jan 14, 2024

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme, or JSdoc annotations)

πŸ“š Description

This PR updates the Cloudflare deployment docs by:
- making the cloudflare_pages preset the recommended one
- making the worker presets deprecated
- giving more information regarding Bindings
- applying other cleanups

Besides the Cloudflare docs update this PR also includes small changes to the deployment overview doc to hopefully slightly clarify things

Copy link
Contributor

nuxt-studio bot commented Jan 14, 2024

βœ… Live Preview ready!

Name Edit Preview Latest Commit
nitro Edit on Studio β†—οΈŽ View Live Preview 59fee11

@dario-piotrowicz dario-piotrowicz force-pushed the update-cloudflare-deploy-docs branch 3 times, most recently from 50187a4 to c4ded8c Compare January 14, 2024 23:51
@@ -300,26 +242,20 @@ NITRO_HELLO_THERE="captain"
SECRET="top-secret"
```

## Advanced
## Cloudflare Bindings
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Here I just included the Bindings and not the rest of the Cloudflare context (so the request and ctx object), I wonder if I should πŸ€” (on one hand it would make these docs more comprehensive, on the other I wouldn't want to make these too overwhelming)

@pi0 pi0 changed the title Update Cloudflare deploy docs docs(cloudflare): update deployment guide Jan 15, 2024
as part of these changes:
 - make the `cloudflare_pages` preset the recommended one
 - make the worker presets deprecated
 - give more information regarding Bindings
@dario-piotrowicz dario-piotrowicz marked this pull request as ready for review January 20, 2024 19:41
@Barbapapazes Barbapapazes added the documentation Improvements or additions to documentation label Jan 23, 2024
@Barbapapazes Barbapapazes self-requested a review January 23, 2024 23:38
@@ -27,19 +27,25 @@ When deploying to the production using CI/CD, Nitro tries to automatically detec
- [vercel](/deploy/providers/vercel)
- [zeabur](/deploy/providers/zeabur)

::alert{type="info"}
**Note:** Even with these presets, if you need to build your application locally (for development or testing purposes) targeting the provider environment, you still need to tell Nitro what preset it needs to use (you can see below how).
Copy link
Member

Choose a reason for hiding this comment

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

Preview is not applied for all presets so for now at least it cannot be a general advice

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 merged commit aff9e59 into nitrojs:main Jan 23, 2024
4 checks passed
@dario-piotrowicz dario-piotrowicz deleted the update-cloudflare-deploy-docs branch January 23, 2024 23:53
@pi0 pi0 mentioned this pull request Feb 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants