Skip to content

[Workers][Developer Platform] Add "Workers Platform" roles to "roles.mdx" #22362

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

danielrs
Copy link
Contributor

The role should provide read-only access to most Developer Platform products:

https://www.cloudflare.com/developer-platform/products/

These include:

  • Workers
  • Pages
  • Durabe Objects
  • KV
  • R2
  • etc

Summary

*The role is currently experimental; visual glitches in the Dash, or API access issues might occur.

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.

Copy link
Contributor

hyperlint-ai bot commented May 12, 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

Added a new experimental role for read-only access to Developer Platform products in the documentation.

  • Introduced the 'Developer Platform Read (Experimental)' role for read-only access to various Developer Platform products.
  • Updated the roles documentation to include this new role and its associated permissions.
  • Noted that the role is experimental and may have visual glitches or API access issues.

Modified Files

  • src/content/docs/fundamentals/setup/manage-members/roles.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

@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.

Is it weird to have "Workers Admin" but not a corresponding read-only permission for Workers?

I get the rationale behind calling it dev plat instead of Workers

@danielrs
Copy link
Contributor Author

Is it weird to have "Workers Admin" but not a corresponding read-only permission for Workers?

I get the rationale behind calling it dev plat instead of Workers

A little bit, I've heard conversations about renaming it. FWIW this role that I'm adding should be equivalent, but read-only.

@danielrs danielrs force-pushed the drivas/add-developer-platform-read-role branch from bcf040a to 03d4f71 Compare May 13, 2025 15:00
@github-actions github-actions bot added size/s and removed size/xs labels May 13, 2025
@danielrs danielrs marked this pull request as draft June 3, 2025 15:18
@danielrs danielrs force-pushed the drivas/add-developer-platform-read-role branch from 03d4f71 to 9964244 Compare June 16, 2025 15:20
@danielrs danielrs changed the title [Workers][Developer Platform] Add "Developer Platform Read (Experimental)" role to "roles.mdx" [Workers][Developer Platform] Add "Workers Platform" roles to "roles.mdx" Jun 16, 2025
### How are you affected?

If you're using the old role name "Workers Admin" to talk to our API, you should
update all your references to use the new name "Workers Platform Admin".
Copy link
Contributor

Choose a reason for hiding this comment

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

This is a breaking change?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, turns out some API(s) expect the role name (non-constant) instead of the role id (constant). Honestly this is news to me, as we have renamed roles in the past without issues.

@danielrs danielrs force-pushed the drivas/add-developer-platform-read-role branch from 9964244 to 2e75b34 Compare June 16, 2025 15:39
@irvinebroque irvinebroque marked this pull request as ready for review June 16, 2025 15:54
@irvinebroque irvinebroque requested review from a team as code owners June 16, 2025 15:54
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.

Looks like there is a conflict needs to be resolved before merge but content 👍

danielrs and others added 5 commits June 17, 2025 09:35
The role should provide read-only access to most Workers Platform
products:

https://www.cloudflare.com/developer-platform/products/

These include:

- Workers
- Pages
- Durabe Objects
- KV
- R2
- etc
The former was not even the latest name, it was "Workers Admin". So the
roles for this role were a bit out of date.
@danielrs danielrs force-pushed the drivas/add-developer-platform-read-role branch from 21d28e3 to 3368d19 Compare June 17, 2025 14:35
@kodster28 kodster28 merged commit 2008c0a into cloudflare:production Jun 17, 2025
5 checks passed
@workers-devprod workers-devprod added the contribution [Holopin] Recognizes a docs contribution, big or small label Jun 17, 2025
Copy link

holopin-bot bot commented Jun 17, 2025

Congratulations @danielrs, the maintainer of this repository has issued you a holobyte! Here it is: https://holopin.io/holobyte/cmc0o0ten403707ju39efe4us

This badge can only be claimed by you, so make sure that your GitHub account is linked to your Holopin account. You can manage those preferences here: https://holopin.io/account.
Or if you're new to Holopin, you can simply sign up with GitHub, which will do the trick!

@danielrs danielrs deleted the drivas/add-developer-platform-read-role branch June 19, 2025 20:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution [Holopin] Recognizes a docs contribution, big or small product:fundamentals size/s
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants