Skip to content

Conversation

@Oxyjun
Copy link
Contributor

@Oxyjun Oxyjun commented Jan 24, 2025

Summary

Recently, C3 has been updated to produce a wrangler.json, rather than wrangler.toml. This means our references to wrangler.toml is now partially out of date. This PR cleans up references to wrangler.toml in the appropriate way.

In this PR:

  1. Every instance of "wrangler.toml file" has been replaced with "Wrangler configuration file" (i.e. file-extension agnostic). "wrangler.toml / wrangler.json.
  2. Every instance of "wrangler.toml" has been reviewed, and has been treated appropriately.
    • For instances referring to the file produced by C3, or specifically referring to a specific file as part of a process (such as a tutorial), wrangler.toml has been replaced with wrangler.json.
    • If generally referring to the Wrangler configuration, this has been edited to "Wrangler configuration file", or "Wrangler configuration", depending on grammar/naturalness of speech. wrangler.toml / wrangler.json.
  3. If the WranglerConfig component was imported halfway down a page, this has been moved up to the beginning of the page for consistency.
  4. In some headings, to avoid heading slug from becoming too long, "Wrangler configuration file" has been used rather than "wrangler.toml / wrangler.json.

Notable exceptions:

  1. If I couldn't verify (from context) whether the replacement was warranted, this has been left as wrangler.toml.
  2. CMD response snippets referring to wrangler.toml has been left alone.
  3. References to specific behaviours in wrangler.toml in changelogs have been left alone for a clear audit (however, mentions of wrangler.toml as a general reference to "Wrangler configuration" have been updated to "Wrangler configuration file" wrangler.toml / wrangler.json).

Screenshots (optional)

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Jan 24, 2025

Deploying cloudflare-docs with  Cloudflare Pages  Cloudflare Pages

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

View logs

@github-actions
Copy link
Contributor

github-actions bot commented Jan 24, 2025

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/pages/functions/wrangler-configuration/ https://jun-wrangler-toml-json.cloudflare-docs-7ou.pages.dev/pages/functions/wrangler-configuration/
https://developers.cloudflare.com/workers/wrangler/commands/ https://jun-wrangler-toml-json.cloudflare-docs-7ou.pages.dev/workers/wrangler/commands/
https://developers.cloudflare.com/workers/wrangler/migration/v1-to-v2/wrangler-legacy/commands/ https://jun-wrangler-toml-json.cloudflare-docs-7ou.pages.dev/workers/wrangler/migration/v1-to-v2/wrangler-legacy/commands/
https://developers.cloudflare.com/pages/functions/bindings/ https://jun-wrangler-toml-json.cloudflare-docs-7ou.pages.dev/pages/functions/bindings/
https://developers.cloudflare.com/workers-ai/tutorials/build-ai-interview-practice-tool/ https://jun-wrangler-toml-json.cloudflare-docs-7ou.pages.dev/workers-ai/tutorials/build-ai-interview-practice-tool/
https://developers.cloudflare.com/workers/testing/ https://jun-wrangler-toml-json.cloudflare-docs-7ou.pages.dev/workers/testing/
https://developers.cloudflare.com/workers/wrangler/migration/v1-to-v2/wrangler-legacy/configuration/ https://jun-wrangler-toml-json.cloudflare-docs-7ou.pages.dev/workers/wrangler/migration/v1-to-v2/wrangler-legacy/configuration/
https://developers.cloudflare.com/workers/wrangler/configuration/ https://jun-wrangler-toml-json.cloudflare-docs-7ou.pages.dev/workers/wrangler/configuration/
https://developers.cloudflare.com/d1/best-practices/local-development/ https://jun-wrangler-toml-json.cloudflare-docs-7ou.pages.dev/d1/best-practices/local-development/
https://developers.cloudflare.com/queues/get-started/ https://jun-wrangler-toml-json.cloudflare-docs-7ou.pages.dev/queues/get-started/
https://developers.cloudflare.com/workers/wrangler/environments/ https://jun-wrangler-toml-json.cloudflare-docs-7ou.pages.dev/workers/wrangler/environments/
https://developers.cloudflare.com/workers/static-assets/routing/ https://jun-wrangler-toml-json.cloudflare-docs-7ou.pages.dev/workers/static-assets/routing/
https://developers.cloudflare.com/d1/examples/query-d1-from-python-workers/ https://jun-wrangler-toml-json.cloudflare-docs-7ou.pages.dev/d1/examples/query-d1-from-python-workers/
https://developers.cloudflare.com/d1/get-started/ https://jun-wrangler-toml-json.cloudflare-docs-7ou.pages.dev/d1/get-started/
https://developers.cloudflare.com/d1/tutorials/build-a-staff-directory-app/ https://jun-wrangler-toml-json.cloudflare-docs-7ou.pages.dev/d1/tutorials/build-a-staff-directory-app/

Copy link
Contributor

@irvinebroque irvinebroque left a 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?

@Oxyjun
Copy link
Contributor Author

Oxyjun commented Jan 29, 2025

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?

Hey @irvinebroque, thanks for the feedback - I'm happy to change it to your suggestion of wrangler.toml / wrangler.json.

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

@Oxyjun Oxyjun merged commit d9f03c0 into production Jan 29, 2025
12 checks passed
@Oxyjun Oxyjun deleted the jun/wrangler-toml-json branch January 29, 2025 12:28
deadlypants1973 pushed a commit that referenced this pull request Jan 29, 2025
* 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]>
kodster28 pushed a commit that referenced this pull request Jan 30, 2025
* 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:ai-gateway AI Gateway: https://developers.cloudflare.com/ai-gateway/ product:analytics Related to Analytics product product:browser-rendering product:cloudflare-for-platforms product:cloudflare-one product:constellation product:d1 D1: https://developers.cloudflare.com/d1/ product:developer-spotlight product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ product:email-routing product:hyperdrive Hyperdrive: https://developers.cloudflare.com/hyperdrive/ product:kv product:learning-paths product:pages product:pub-sub Pub/Sub: https://developers.cloudflare.com/pub-sub product:queues Cloudflare Queues: https://developers.cloudflare.com/queues product:r2 R2 object storage: https://developers.cloudflare.com/r2 product:radar product:style-guide product:turnstile product:vectorize Vectorize: https://developers.cloudflare.com/vectorize/ product:workers Related to Workers product product:workers-ai Workers AI: https://developers.cloudflare.com/workers-ai/ product:workflows Workflows: https://developers.cloudflare.com/workflows/ size/xl

Projects

None yet

Development

Successfully merging this pull request may close these issues.