-
Notifications
You must be signed in to change notification settings - Fork 10.4k
[All] Cleaning up references to wrangler.toml. #19403
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
Conversation
Deploying cloudflare-docs with
|
| Latest commit: |
1ca3ec5
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://96c6de48.cloudflare-docs-7ou.pages.dev |
| Branch Preview URL: | https://jun-wrangler-toml-json.cloudflare-docs-7ou.pages.dev |
irvinebroque
left a comment
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 get the intent of "Wrangler configuration file" — but it makes things less specific.
- "
wrangler.toml / wrangler.json" - "
wrangler.toml or wrangler.json
Seems like we can have fewer characters and still be concrete and specific?
Co-authored-by: marciocloudflare <[email protected]>
Co-authored-by: marciocloudflare <[email protected]>
…lare-docs into jun/wrangler-toml-json
Hey @irvinebroque, thanks for the feedback - I'm happy to change it to your suggestion of Initial reasoning was: I thought I'd choose a more future-proof term (e.g. in case the file format ever changes in the future), and thought it was clear enough within the context, as these terms were often followed by the explicit Wrangler code snippets. Edit: done |
* Cleaning up references to wrangler.toml. * Removing erroneous import line. * Making sure all imports are at the top of the page. * Catching more instances of wrangler.toml. * Fixing typo * Update src/content/docs/workers/platform/pricing.mdx Co-authored-by: marciocloudflare <[email protected]> * Update src/content/docs/workers/languages/python/index.mdx Co-authored-by: marciocloudflare <[email protected]> * Syntax formatting and edit for accuracy. * Updating language to `wrangler.toml / wrangler.json` --------- Co-authored-by: marciocloudflare <[email protected]>
* Cleaning up references to wrangler.toml. * Removing erroneous import line. * Making sure all imports are at the top of the page. * Catching more instances of wrangler.toml. * Fixing typo * Update src/content/docs/workers/platform/pricing.mdx Co-authored-by: marciocloudflare <[email protected]> * Update src/content/docs/workers/languages/python/index.mdx Co-authored-by: marciocloudflare <[email protected]> * Syntax formatting and edit for accuracy. * Updating language to `wrangler.toml / wrangler.json` --------- Co-authored-by: marciocloudflare <[email protected]>
Summary
Recently, C3 has been updated to produce a
wrangler.json, rather thanwrangler.toml. This means our references towrangler.tomlis now partially out of date. This PR cleans up references towrangler.tomlin the appropriate way.In this PR:
wrangler.tomlfile" has been replaced with"Wrangler configuration file" (i.e. file-extension agnostic)."wrangler.toml / wrangler.json.wrangler.toml" has been reviewed, and has been treated appropriately.wrangler.tomlhas been replaced withwrangler.json."Wrangler configuration file", or "Wrangler configuration", depending on grammar/naturalness of speech.wrangler.toml / wrangler.json.WranglerConfigcomponent was imported halfway down a page, this has been moved up to the beginning of the page for consistency.wrangler.toml / wrangler.json.Notable exceptions:
wrangler.toml.wrangler.tomlhas been left alone.wrangler.tomlin changelogs have been left alone for a clear audit (however, mentions ofwrangler.tomlas a general reference to "Wrangler configuration" have been updated to"Wrangler configuration file"wrangler.toml / wrangler.json).Screenshots (optional)
Documentation checklist