Skip to content

[Workers] Add getting started guide for API and IaC #21008

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Jun 17, 2025
Merged

[Workers] Add getting started guide for API and IaC #21008

merged 3 commits into from
Jun 17, 2025

Conversation

markjmiller
Copy link
Contributor

Summary

There are no official documented examples of how to properly upload a workers script with content and metadata. This is a non-starter for API users. Ideally these examples could live in the API docs themselves, but we can't make custom examples there yet. This doc serves as a practical guide in the meantime that will unblock users.

Documentation checklist

@github-actions github-actions bot added size/m product:workers Related to Workers product labels Mar 20, 2025
hyperlint-ai[bot]
hyperlint-ai bot reviewed Mar 20, 2025
View reviewed changes
@hyperlint-ai Hyperlint AI
Copy link
Contributor

hyperlint-ai bot commented Mar 20, 2025 •
edited
Loading

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.

PR Change Summary

Added a comprehensive getting started guide for API and Infrastructure as Code (IaC) to assist users in uploading Workers scripts with content and metadata.

  • Introduced a new guide for uploading Workers scripts via API and IaC tools.
  • Added examples for using Terraform and Cloudflare API libraries for script uploads.
  • Included notes on metadata usage and compatibility flags for Python Workers.

Modified Files

  • src/content/docs/cloudflare-for-platforms/workers-for-platforms/get-started/user-workers.mdx
  • src/content/docs/workers/configuration/multipart-upload-metadata.mdx

Added Files

  • src/content/docs/terraform/additional-configurations/link-workers.mdx
  • src/content/docs/workers/platform/infrastructure-as-code.mdx
How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Mar 20, 2025 •
edited
Loading

Preview URL: https://0996c28b.preview.developers.cloudflare.com
Preview Branch URL: https://markmiller-workers-api-iac.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/workers/platform/infrastructure-as-code/ https://markmiller-workers-api-iac.preview.developers.cloudflare.com/workers/platform/infrastructure-as-code/
https://developers.cloudflare.com/terraform/additional-configurations/link-workers/ https://markmiller-workers-api-iac.preview.developers.cloudflare.com/terraform/additional-configurations/link-workers/
https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/ https://markmiller-workers-api-iac.preview.developers.cloudflare.com/workers/configuration/multipart-upload-metadata/
https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/get-started/user-workers/ https://markmiller-workers-api-iac.preview.developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/get-started/user-workers/

@markjmiller markjmiller force-pushed the markmiller/workers-api-iac branch from 50b9991 to 741a430 Compare March 20, 2025 21:30
markjmiller
markjmiller commented Mar 20, 2025
View reviewed changes
@markjmiller markjmiller force-pushed the markmiller/workers-api-iac branch from 741a430 to 958e08f Compare March 20, 2025 22:33
irvinebroque
irvinebroque requested changes Mar 21, 2025
View reviewed changes
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.

Let's find right home for this content and do bit more here

@markjmiller markjmiller force-pushed the markmiller/workers-api-iac branch 2 times, most recently from c7df2be to 60ec915 Compare March 21, 2025 16:52
@markjmiller
Copy link
Contributor Author

Let's find right home for this content and do bit more here

@irvinebroque moved to Platform > Managing Workers which feels appropriate

korinne
korinne approved these changes Mar 24, 2025
View reviewed changes
Copy link
Contributor

@korinne korinne left a comment

Choose a reason for hiding this comment

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

Looks good!

irvinebroque
irvinebroque reviewed Mar 24, 2025
View reviewed changes
jacobbednarz
jacobbednarz reviewed Mar 24, 2025
View reviewed changes
irvinebroque
irvinebroque reviewed Mar 24, 2025
View reviewed changes
irvinebroque
irvinebroque reviewed Mar 24, 2025
View reviewed changes
@markjmiller markjmiller force-pushed the markmiller/workers-api-iac branch from ddb8f33 to 0ed35ff Compare April 18, 2025 15:12
@markjmiller markjmiller requested review from angelampcosta and a team as code owners April 18, 2025 15:12
hyperlint-ai[bot]
hyperlint-ai bot reviewed Apr 18, 2025
View reviewed changes
@markjmiller markjmiller force-pushed the markmiller/workers-api-iac branch 2 times, most recently from c45a99b to 372ca8c Compare April 18, 2025 16:06
@markjmiller
Copy link
Contributor Author

Don't merge until...

@kodster28 kodster28 mentioned this pull request Apr 21, 2025
Merged
@ToriLindsay ToriLindsay removed their request for review June 6, 2025 11:43
@ToriLindsay ToriLindsay assigned kodster28 and unassigned ToriLindsay Jun 6, 2025
@markjmiller markjmiller force-pushed the markmiller/workers-api-iac branch from 998da4c to b715a45 Compare June 17, 2025 00:43
@markjmiller markjmiller requested a review from dcpena as a code owner June 17, 2025 00:43
@github-actions GitHub Actions
Copy link
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/cloudflare-for-platforms/workers-for-platforms/ @irvinebroque, @angelampcosta, @GregBrimble, @cloudflare/deploy-config, @cloudflare/pcx-technical-writing
/src/content/docs/terraform/ @dcpena, @cloudflare/pcx-technical-writing
/src/content/docs/workers/ @cloudflare/workers-docs, @GregBrimble, @irvinebroque, @mikenomitch, @WalshyDev, @cloudflare/deploy-config, @cloudflare/pcx-technical-writing, @kodster28, @cloudflare/wrangler, @cloudflare/workers-runtime-1

@markjmiller markjmiller force-pushed the markmiller/workers-api-iac branch from b715a45 to 0996c28 Compare June 17, 2025 14:57
@korinne korinne merged commit e7f1bb6 into production Jun 17, 2025
11 checks passed
@korinne korinne deleted the markmiller/workers-api-iac branch June 17, 2025 17:31
sdnts pushed a commit to sdnts/cloudflare-docs that referenced this pull request Jul 24, 2025
@markjmiller @kodster28 @sdnts
[Workers] Add getting started guide for API and IaC (cloudflare#21008)
161e2ef 
* [Workers] Add getting started guide for API and IaC

* Tweaks

* remove excess file

---------

Co-authored-by: kodster28 <kody@cloudflare.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hyperlint-ai hyperlint-ai[bot]

@jacobbednarz jacobbednarz

@irvinebroque irvinebroque

@kodster28 kodster28

@korinne korinne

@GregBrimble GregBrimble

@mikenomitch mikenomitch

@WalshyDev WalshyDev

@ranbel ranbel

@angelampcosta angelampcosta

@kristianfreeman kristianfreeman

@pedrosousa pedrosousa

@haleycode haleycode

@KianNH KianNH

@dcpena dcpena

Assignees

@irvinebroque irvinebroque

@mikenomitch mikenomitch

@GregBrimble GregBrimble

@WalshyDev WalshyDev

@kodster28 kodster28

Labels
product:cloudflare-for-platforms product:terraform Related to Terraform product product:workers Related to Workers product size/m
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@markjmiller @jacobbednarz @irvinebroque @kodster28 @korinne @mikenomitch @GregBrimble @WalshyDev @ToriLindsay