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

fix: wrong code example for persist in cloudflare.mdx #10601

Merged
merged 2 commits into from
Jan 6, 2025

Conversation

Rados51
Copy link
Contributor

@Rados51 Rados51 commented Jan 3, 2025

Description

I was following docs and did not realize it was wrongly documented until I looked through types.

Copy link

netlify bot commented Jan 3, 2025

Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 7df56ee
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/677c57f1e06e9f0008fbcea1
😎 Deploy Preview https://deploy-preview-10601--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@astrobot-houston
Copy link
Contributor

Hello! Thank you for opening your first PR to Astro’s Docs! 🎉

Here’s what will happen next:

  1. Our GitHub bots will run to check your changes.
    If they spot any broken links you will see some error messages on this PR.
    Don’t hesitate to ask any questions if you’re not sure what these mean!

  2. In a few minutes, you’ll be able to see a preview of your changes on Netlify 🥳.

  3. One or more of our maintainers will take a look and may ask you to make changes.
    We try to be responsive, but don’t worry if this takes a few days.

@astrobot-houston
Copy link
Contributor

astrobot-houston commented Jan 3, 2025

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
en/guides/integrations-guide/cloudflare.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@Rados51 Rados51 changed the title fix: wrong code example for persist in cloudflare.mdx (en) i18n(en): wrong code example for persist in cloudflare.mdx Jan 3, 2025
@Rados51 Rados51 changed the title i18n(en): wrong code example for persist in cloudflare.mdx fix: wrong code example for persist in cloudflare.mdx Jan 3, 2025
@sarah11918
Copy link
Member

Thank you @Rados51 for letting us know what worked for you! I was not able to find this myself in the Cloudflare docs to confirm, so I'll ask @alexanderniebuhr if he is able to confirm this for us!

@sarah11918 sarah11918 added help - confirm behaviour Walk through the example/issue and confirm this is a general behaviour, or a correct update to make. code snippet update Updates a code sample: typo, outdated code etc. labels Jan 6, 2025
@Rados51
Copy link
Contributor Author

Rados51 commented Jan 6, 2025

@sarah11918

https://developers.cloudflare.com/workers/wrangler/api/

image

type GetPlatformProxyOptions in wrangler/wrangler-dist/cli.d.ts

persist?: boolean | {
    path: string;
};

By passing just string in persist, it would never work correctly as it would use default location instead of custom path for persist storage.

@sarah11918
Copy link
Member

@Rados51 Thank you, that's really helpful! Looks good to me! Really appreciate you taking the time and effort to contribute, and happy to welcome you to Team Docs! 🥳

Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

Confirmed with Cloudflare docs!

@sarah11918 sarah11918 added Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! and removed help - confirm behaviour Walk through the example/issue and confirm this is a general behaviour, or a correct update to make. labels Jan 6, 2025
@Rados51
Copy link
Contributor Author

Rados51 commented Jan 6, 2025

Thank you too @sarah11918 🙌🏻

@sarah11918 sarah11918 merged commit 2b0b55c into withastro:main Jan 6, 2025
10 checks passed
@alexanderniebuhr
Copy link
Member

Thanks @Rados51. We updated the code, due to a breaking change by Cloudflare, but forgot the docs!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code snippet update Updates a code sample: typo, outdated code etc. Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants