docs(platforms): Cloudflare Workers How-to #1616
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Mar 7, 2023
This reverts commit f9bdf61d1cb1ea25b32aed6dfdb33413dd1352ef.
1 task
reebhub
reviewed
Jul 9, 2023
|
|
||
| {NOTE/} | ||
|
|
||
| In this guide, you will learn how deploy a Cloudflare Worker using the [RavenDB Cloudflare Worker template][template] that is connected to your RavenDB database. This guide assumes you are familiar with Node.js development techniques and the basics of Cloudflare Workers. |
There was a problem hiding this comment.
learn how deploy --> learn how to deploy
|
|
||
| For a walkthrough and demo of getting started with Cloudflare Workers, see [TBD](#). --> | ||
|
|
||
| {NOTE/} |
There was a problem hiding this comment.
please include the table of contents in the note
|
|
||
| In this guide, you will learn how deploy a Cloudflare Worker using the [RavenDB Cloudflare Worker template][template] that is connected to your RavenDB database. This guide assumes you are familiar with Node.js development techniques and the basics of Cloudflare Workers. | ||
|
|
||
| * [Before We Get Started](#before-we-get-started) |
There was a problem hiding this comment.
for the TOC please use an "In this page" title & indent the contents, and use full URLs
e.g. -
Title
---
{NOTE: }
Description
* In this page:
* [Before We Get Started](../../start/guides/cloudflare-workers/overview#before-we-get-started)
* [Create a Worker](../../start/guides/cloudflare-workers/overview#create-a-worker)
* ...
{NOTE/}
{PANEL: Before We Get Started}
| - A [RavenDB Cloud][cloud-signup] account or self-hosted client certificate | ||
| - A free or paid [Cloudflare account](https://cloudflare.com) | ||
| - [Git](https://git-scm.org) | ||
| - [Node.js](https://nodejs.com) 16+ with npm |
There was a problem hiding this comment.
is this what nodejs.com normally shows?
|
|
||
| ### Obtain RavenDB certificate | ||
|
|
||
| First, download your RavenDB client certificate package you will use to authenticate. Follow the guides for either [Cloud certificates][docs-cloud-certs] or for [self-hosted certificates][docs-on-prem-certs]. It is recommended to [generate a new client certificate][docs-generate-client-certificate] with limited access rights instead of a `ClusterAdmin`-level certificate. This also ensures the Worker is using a dedicated certificate that can be managed separately. |
There was a problem hiding this comment.
download your RavenDB... --> download the RavenDB...
"guides for either [Cloud certificates][docs-cloud-certs] or for" --> remove the "for" in the end
| [gh-workflows]: https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions | ||
| [gh-workflows-manual]: https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow | ||
| [gh-template-repo]: https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository | ||
| [image-template-deploy-cloudflare]: images/template-deploy-cloudflare.jpg |
There was a problem hiding this comment.
- this list of references works properly in our private documentation environment but i don't know if our site supports it. we usually embed links in the text -
[like this](../../location)
and the area after the text is kept for related articles. - regarding images: we usually add image titles, e.g. -
[image-template-deploy-cloudflare](images/template-deploy-cloudflare.jpg "Deploy to Workers")
or if adding it to the end of the text does work -
[image-template-deploy-cloudflare]: images/template-deploy-cloudflare.jpg "Deploy to Workers"
| - `DB_URLS` -- These are the node URLs for your RavenDB instance (Cloud or self-hosted). The values are comma-separated | ||
| - `DB_NAME` -- This is the default database to connect to | ||
|
|
||
| When left blank, the Live Test connection settings are used. The defaults are under `[vars]` and overriden in `[env.production.vars]`. |
reebhub
approved these changes
Jul 10, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The RavenDB Node.js client is getting support that enables it to work on Cloudflare and I have a Workers template that makes it easy to get started with Workers + RavenDB integration. This is a how-to guide to get up and running with it.
This is still in draft with unfinished pieces and I'll continue to revise it.
Tasks
Post-Publish / Follow-up
Questions