-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
fix: update cloudflare integration guide #11506
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
base: main
Are you sure you want to change the base?
Conversation
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
✅ Deploy Preview for astro-docs-2 ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Amazing updates, @jsparkdev ! Thank you so much for this PR! I appreciate the consistency, and love the definitions being turned into... definitions!
See my comments below for some specifics, which are mostly "I guess we're going to have to make some decisions and standardize throughout" 😅
You've identified some great improvements here, which are going to force us to do more work... but then have even greater improvements! 💪
**Default:** `true` | ||
</p> | ||
|
||
Enables [imports of `.wasm`, `.bin`, and `.txt` modules](#cloudflare-module-imports). | ||
|
||
This functionality is enabled by default. If you'd like to disable it, set `cloudflareModules: false`. | ||
This functionality is enabled by default. If you'd like to disable it, set `false`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This might be the only change I wouldn't necessarily make? We do commonly repeat the value within the description, maybe more often than not? So it's not a hard rule to follow to never refer to it within its own definition:
https://docs.astro.build/en/reference/configuration-reference/#compresshtml
https://docs.astro.build/en/reference/configuration-reference/#checkorigin
https://docs.astro.build/en/reference/configuration-reference/#markdowngfm
Admittedly, it's not standardized, and we can discuss our preferred way of doing this. We currently have a mix of:
- "to disable, set
false
" - "to disable, set
propertyName: false
" - "to disable, set
propertyName
tofalse
"
We should probably make a docs Discussion to figure out how we want to standardize on this!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the good point!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ugh, did GitHub eat my comment? Unresolving to make this easier to see on Talking and Doc'ing tomorrow, too!
</p> | ||
|
||
The `enabled` property allows you to enable the Cloudflare runtime in `astro dev`. | ||
Determine whether to enable the Cloudflare runtime in development mode. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Determine whether to enable the Cloudflare runtime in development mode. | |
Determines whether to enable the Cloudflare runtime in development mode. |
We typically (although I just checked, not always! 😅 ) use this form of the verb.
My thinking is that a definition answers either:
"What is this?" when the point is to say what something is
- An array of allowed hosts
- The base path to deploy to
OR
"What does this do?" often with an assumed ["This"]:
- [This] Specifies the output target for builds
- [This] Enables security measures for an Astro website
I'm checking in config reference and of course I see right next to each other:
- Specify a mapping of redirects
- Specifies the output target for builds
So, clearly we have some work to do here, too! I see both in use on this page. (Enables, Determines... but then later Configure routes, Configure identical routes...
Let's make THIS page all verbs with the (s) for now, so that this one page is internally consistent, and we'll add this to our pile of "let's go through all the docs and standardize..." pile 😄
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the great information!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just "unresolved" the conversation for two reasons @jsparkdev 👍
- I think there are more "no-s" verbs on this page we could standardize while we're here! Can you e.g. get the "Configure routes" while you're already here?
- I'd like to use this comment tomorrow on Talking & Doc'ing, and this makes it easier to see. 😄
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A tiny nit regarding a default, otherwise great job! 🙌🏽
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK, I think this looks great! And we can use it to update more going forward! Thank you again!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good work @jsparkdev, I have just a small comment/nit for you!
Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
Description (required)
update cloudflare integration guide