Skip to content

SQC-792 add documentation for local hyperdrive environment files#28905

Open
Ltadrian wants to merge 3 commits intocloudflare:productionfrom
Ltadrian:agracia/SQC-792-hyperdrive-docs
Open

SQC-792 add documentation for local hyperdrive environment files#28905
Ltadrian wants to merge 3 commits intocloudflare:productionfrom
Ltadrian:agracia/SQC-792-hyperdrive-docs

Conversation

@Ltadrian
Copy link
Contributor

@Ltadrian Ltadrian commented Mar 10, 2026

Summary

Screenshots (optional)

Screenshot 2026-03-10 at 6 43 35 PM

Documentation checklist

  • Is there a changelog entry (guidelines)? If you don't add one for something awesome and new (however small) — how will our customers find out? Changelogs are automatically posted to RSS feeds, the Discord, and X.
  • The change adheres to the documentation style guide.
  • 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.

@sejoker
Copy link
Contributor

sejoker commented Mar 15, 2026

/bonk review and address any findings.

Copy link
Contributor

@ask-bonk ask-bonk bot left a comment

Choose a reason for hiding this comment

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

Several style and accuracy issues need fixing before merge. Posted 5 inline suggestions below.

CLOUDFLARE_HYPERDRIVE_LOCAL_CONNECTION_STRING_HYPERDRIVE="postgres://user:password@localhost:5432/databasename"
```

Setting with a environment variable file will have higher precedence and override any environment variable set on your machine.
Copy link
Contributor

Choose a reason for hiding this comment

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

Two issues:

  1. "a environment" → "an environment".
  2. The precedence claim needs verification. Line 84 already states that environment variables take precedence over the Wrangler config. Does the .dev.vars file truly override a shell-exported environment variable? Wrangler typically loads .dev.vars as environment variables itself, so a shell-exported var would usually win. Please verify the actual precedence and clarify the full order (env file vs. env var vs. wrangler config) so readers are not confused.
Suggested change
Setting with a environment variable file will have higher precedence and override any environment variable set on your machine.
Values set in an environment file take precedence over environment variables set on your machine.

@ask-bonk
Copy link
Contributor

ask-bonk bot commented Mar 15, 2026

Review posted. Here's a summary of what I flagged:

HIGH

  • Precedence claim needs verification (line 62): The new section claims .dev.vars overrides shell environment variables. This conflicts with typical Wrangler behavior and needs confirmation. The page should also clarify the full precedence order (env file vs. env var vs. wrangler config) since line 84 already discusses env var vs. wrangler config precedence.

MEDIUM

  • Style: first-person/future tense (lines 52-54): "we will allow" should be rewritten to describe current behavior in second person.
  • Grammar: "a environment" (lines 54, 62): Should be "an environment" in both occurrences.
  • Missing blank line after heading (line 51-52): Inconsistent with the rest of the page.
  • Unnecessary <br/> (line 56): Not needed before a blank line and code block.

The good news: the fix on line 13 (adding the missing word "edge") is correct and welcome.

github run

sejoker and others added 2 commits March 15, 2026 12:21
Co-authored-by: ask-bonk[bot] <249159057+ask-bonk[bot]@users.noreply.github.com>
Co-authored-by: ask-bonk[bot] <249159057+ask-bonk[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants