Skip to content

[Secrets Store] Review for consistency and clarity in examples and limits #21795

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

Merged
merged 9 commits into from
Apr 21, 2025

Conversation

RebeccaTamachiro
Copy link
Contributor

Summary

PCX-16696

Copy link
Contributor

hyperlint-ai bot commented Apr 17, 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

Enhanced the Secrets Store documentation by incorporating partials and improving examples for better clarity and usability.

  • Updated role definitions for Super Administrator and Secrets Store Deployer to include binding to Workers.
  • Modified example code snippets to use consistent naming conventions for secrets.
  • Revised command examples for creating secrets to reflect updated naming standards.

Modified Files

  • src/content/docs/secrets-store/access-control.mdx
  • src/content/docs/secrets-store/integrations/workers.mdx
  • src/content/docs/workers/wrangler/commands.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 bot added size/m and removed size/s labels Apr 21, 2025
@RebeccaTamachiro RebeccaTamachiro changed the title [Secrets Store] Use partials and improve examples [Secrets Store] Review for consistency and clarity in examples and limits Apr 21, 2025
@RebeccaTamachiro RebeccaTamachiro marked this pull request as ready for review April 21, 2025 09:54
@@ -112,7 +112,7 @@ To bind an account secret to your Worker, you must have one of the following [ro
```toml
main = "./src/index.js"
secrets_store_secrets = [
{ binding = "MY_SECRETS_STORE_SECRET", store_id= "<STORE_ID>", secret_name = "<MY_SECRET_NAME>" }
{ binding = "secrets_store_binding", store_id= "<STORE_ID>", secret_name = "<MY_SECRET_NAME>" }
Copy link
Contributor

Choose a reason for hiding this comment

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

Just to double check. In binding = the customer isn't supposed to input their secret; rather they should write the var "secrets_store_binding"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not really. I think originally it wasn't added as a placeholder (in between < > ) bc of the concrete example at the bottom but I'll update both to have the placeholders instead. Thank you!

@RebeccaTamachiro RebeccaTamachiro enabled auto-merge (squash) April 21, 2025 10:54
@RebeccaTamachiro RebeccaTamachiro merged commit bb0ac73 into production Apr 21, 2025
12 checks passed
@RebeccaTamachiro RebeccaTamachiro deleted the rebecca/secrets-store-follow-up-mdx branch April 21, 2025 10:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants