Skip to content

Conversation

@nevikashah
Copy link
Contributor

Summary

  • updated getting started guide
  • add guide for repo maintainers to set up deploy button (to do: figure out where this lives + add images

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.

@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Mar 24, 2025

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

Updated the getting started guide and added documentation for setting up a Deploy to Cloudflare button.

  • Enhanced the getting started guide for Workers applications.
  • Introduced a new guide for embedding Deploy to Cloudflare buttons.
  • Included best practices for using Deploy to Cloudflare buttons.

Modified Files

  • src/content/docs/workers/get-started/dashboard.mdx

Added Files

  • src/content/docs/workers/deploy-buttons.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.

Copy link
Contributor

@ToriLindsay ToriLindsay left a comment

Choose a reason for hiding this comment

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

@nevikashah
Assuming you're going to replace those insert screenshot notes with files, I'm approving. I reviewed this for grammar and added some other lighter suggestions, but I also have some ideas for re-structuring the Deploy to Cloudflare doc which I'll DM you about, but I wanted to unblock you in the meantime.

@nevikashah nevikashah force-pushed the nevi/deploy-to-cloudflare-button branch from 4753cb0 to 70a2124 Compare March 25, 2025 15:12
@github-actions
Copy link
Contributor

This PR changes current filenames or deletes current files. Make sure you have redirects set up to cover the following paths:

  • /workers/tutorials/deploy-button/

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.

Curious why whole new top-level section?

Screenshot 2025-03-25 at 11 49 46 AM

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.

Makes sense – tricky to find spot for it in docs today but worth a pass at finding places that exist today where we think this should be discoverable

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.

Content makes sense but don't think having whole new top-level section called "community" with just one page does.

@nevikashah nevikashah requested a review from irvinebroque April 4, 2025 22:25
@nevikashah nevikashah merged commit 14fb5e7 into production Apr 7, 2025
11 checks passed
@nevikashah nevikashah deleted the nevi/deploy-to-cloudflare-button branch April 7, 2025 02:51
kodster28 added a commit that referenced this pull request Apr 7, 2025
@kodster28 kodster28 mentioned this pull request Apr 7, 2025
kodster28 added a commit that referenced this pull request Apr 7, 2025
RebeccaTamachiro pushed a commit that referenced this pull request Apr 21, 2025
* add deploy to cloudflare docs + fix getting started

* remove old d2w docs and add community section

* Update src/content/docs/workers/community/deploy-buttons.mdx

* Update src/content/docs/workers/community/deploy-buttons.mdx

* Update src/content/docs/workers/community/deploy-buttons.mdx

* updates based on feedback

---------

Co-authored-by: Nevi <[email protected]>
Co-authored-by: ToriLindsay <[email protected]>
Co-authored-by: Daniel Walsh <[email protected]>
RebeccaTamachiro pushed a commit that referenced this pull request Apr 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:workers Related to Workers product size/m

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants