Skip to content

[Hyperdrive] Clarifying cache behaviour in Getting started. #21196

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 1 commit into from
Mar 27, 2025
Merged

[Hyperdrive] Clarifying cache behaviour in Getting started. #21196

merged 1 commit into from
Mar 27, 2025

Conversation

@Oxyjun
Copy link
Contributor

@Oxyjun Oxyjun commented Mar 27, 2025

Updating Getting started for clarity.

Summary

  1. Clarified that Hyperdrive caches by default.
  2. Added a note in Getting started for guidance on managing cache.
  3. Edited the Wrangler commands chapter to render the commands, rather than link out to /Workers/.

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.

@Oxyjun
Rendering the same file into Hyperdrive Wrangler.
f9291ef 
Updating Getting started for clarity.
@Oxyjun Oxyjun requested review from a team, elithrar, sejoker and thomasgauvin as code owners March 27, 2025 17:22
@Oxyjun Oxyjun self-assigned this Mar 27, 2025
@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Mar 27, 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

Clarified cache behavior in the Getting Started documentation for Hyperdrive.

  • Clarified that Hyperdrive caches by default.
  • Added guidance on managing cache in Getting Started.
  • Updated the Wrangler commands chapter to render commands directly.

Modified Files

  • src/content/docs/hyperdrive/get-started.mdx
  • src/content/docs/hyperdrive/reference/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
Copy link
Contributor

github-actions bot commented Mar 27, 2025

Preview URL: https://f9291ef0.preview.developers.cloudflare.com
Preview Branch URL: https://jun-hyperdrive-gs-clarification.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/hyperdrive/get-started/ https://jun-hyperdrive-gs-clarification.preview.developers.cloudflare.com/hyperdrive/get-started/
https://developers.cloudflare.com/hyperdrive/reference/wrangler-commands/ https://jun-hyperdrive-gs-clarification.preview.developers.cloudflare.com/hyperdrive/reference/wrangler-commands/

@github-actions github-actions bot added product:hyperdrive Hyperdrive: https://developers.cloudflare.com/hyperdrive/ size/s labels Mar 27, 2025
@ReppCodes
Copy link
Contributor

ReppCodes commented Mar 27, 2025

Looks good to me (Hyperdrive team)

@Oxyjun Oxyjun merged commit 5718d14 into production Mar 27, 2025
12 checks passed
@Oxyjun Oxyjun deleted the jun/hyperdrive/gs-clarification branch March 27, 2025 23:16
RebeccaTamachiro pushed a commit that referenced this pull request Apr 21, 2025
@Oxyjun @RebeccaTamachiro
Rendering the same file into Hyperdrive Wrangler. (#21196)
edf8aba 
Updating Getting started for clarity.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@thomasgauvin thomasgauvin thomasgauvin approved these changes

@angelampcosta angelampcosta angelampcosta approved these changes

@elithrar elithrar Awaiting requested review from elithrar elithrar is a code owner

@sejoker sejoker Awaiting requested review from sejoker sejoker is a code owner

Assignees

@elithrar elithrar

@sejoker sejoker

@thomasgauvin thomasgauvin

@Oxyjun Oxyjun

Labels

product:hyperdrive Hyperdrive: https://developers.cloudflare.com/hyperdrive/ size/s

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@Oxyjun @ReppCodes @thomasgauvin @angelampcosta @elithrar @sejoker