Update docs for new AstroDB update#12208
Conversation
…ess environments and driver modes
✅ Deploy Preview for astro-docs-2 ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
sarah11918
left a comment
There was a problem hiding this comment.
Thanks for the docs, @Adammatthiesen ! And the amazing feature that I think such an improvement to DB! See my comments below for polishing the text!
(And try not to laugh too hard at all the things I made up so that I'd have an example of what I think things could sound like! 😅 )
| :::note | ||
| While remote connections are generally possible with any deployment platform using static or server rendering mode, there are currently some limitations. Non-Node runtimes like Cloudflare and Deno don't currently support DB on server-rendered routes when using libSQL. Support for these platforms is planned for future implementation. | ||
| ::: | ||
| #### Non-Node Environments |
There was a problem hiding this comment.
This heading actually splits off the regular instructions for connecting to remote databases and instead puts it under this sub heading!
The note was here previously to let people know when to not even bother continuing on to follow the instructions. But this information doesn't serve that same purpose now, so we have to think about where it belongs.
If the instructions are the same for both modes, then I think we can go straight into "configure your build command" and move your newer content down closer to, and maybe even inside this paragraph:
The
--remoteflag uses the connection to the remote DB both locally during the build and on the server. Ensure you set the necessary environment variables in both your local development environment and your deployment platform.
Like, maybe this is now:
The
--remoteflag uses the connection to the remote DB both locally during the build and on the server. Ensure you set the necessary environment variables in both your local development environment and your deployment platform. Additionally, you may need to configurewebmode for non-Node.js runtimes such as Cloudflare Workers or Deno.
If we just said that, and linked to the config docs, are we missing any key info?
| }); | ||
| ``` | ||
|
|
||
| :::note |
There was a problem hiding this comment.
See my comment above, I'd remove this note in favour of more fully explaining the two modes themselves.
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
…and web mode usage
|
@sarah11918 I think i've got everything 😅 (still not a writer 😅 ) |
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
sarah11918
left a comment
There was a problem hiding this comment.
LGTM, great job @Adammatthiesen ! 🙌
You can merge this as soon as the next @astrojs/db minor is released. I'll try to keep an eye out for it too.
Description (required)
Updates docs for the new Astro DB update withastro/astro#14204
Related issues & labels (optional)