Docs: Add quick start guides for dragonfly cloud #233
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Signed-off-by: s1ntaxe770r <53065463+s1ntaxe770r@users.noreply.github.com>
docs/cloud/getting-started.md
Outdated
|
|
||
|  | ||
|
|
||
| - **Name:** Provide a unique name for your data store. |
There was a problem hiding this comment.
we don't enforce uniqueness
docs/cloud/getting-started.md
Outdated
| - **AWS:** Select this option to create your data store on Amazon Web Services. | ||
| - **GCP:** Select this option to create your data store on Google Cloud Platform. | ||
| - **Region:** | ||
| - For AWS, you can choose from `us-east-1` and `eu-west-1`. More regions are coming soon. |
There was a problem hiding this comment.
those regions happens to be the one staging, prod has many more, I don't think we should specify them here
docs/cloud/getting-started.md
Outdated
| @@ -0,0 +1,40 @@ | |||
| --- | |||
| sidebar_position: 1 | |||
| title: Dragonfly Quickstart | |||
There was a problem hiding this comment.
my intention for this page to cover onboarding and signup and very basic datastore then link to the datastore pages for more details
There was a problem hiding this comment.
will update this in the next pr, along with the page structure we went over
docs/cloud/networks.md
Outdated
|
|
||
| ## Managing Networks on Drangonfly Cloud | ||
|
|
||
| Dragonfly Cloud allows you to create isolated networks where you can deploy your data stores similar to VPC's if you are familiar with AWS. |
There was a problem hiding this comment.
the motivation for a private network is security, latency and cost (as you avoid egress charges)
it should proceed to connecting to the private network on the "peering connection" page
docs/cloud/cloud.md
Outdated
| sidebar_position: 1 | ||
| label: Cloud | ||
| --- | ||
|
|
There was a problem hiding this comment.
this is the content of the data stores page
docs/cloud/cloud.md
Outdated
|
|
||
| ## Getting Started with Dragonfly Cloud | ||
|
|
||
| A Dragonfly Cloud data store represents a Redis Protocol (RESP) endpoint. To create a data store, on the Data Store tab click +Data Store. The minimum configuration consists of a name, cloud provider, cloud region and plan. Note that the cloud provider can not be modified once the data store is created. |
There was a problem hiding this comment.
please format better with line breaks please
There was a problem hiding this comment.
Can you use an image for +Data Store
docs/cloud/cloud.md
Outdated
|  | ||
|
|
||
|
|
||
| The plan specifies the provisioned memory and memory to cpu ratio of the data store. You can modify the data store plan later with zero down time to scale it up or down. |
There was a problem hiding this comment.
new lint for 2nd sentence
docs/cloud/cloud.md
Outdated
|
|
||
| By default the data store will be configured with a public endpoint, TLS and an auto generated passkey, meaning you can securely connect to it from anywhere over the public internet. | ||
|
|
||
| To create a data store with a private endpoint, see [Security](cloud/data-stores/security), [Networks](cloud/networks) and Peering Connections.By default the data store will consist of a single Dragonfly server, to create a highly available data store see [Durability and High Availability](cloud/data-stores/duarability-vs-high-availability) |
There was a problem hiding this comment.
Peering Connection should link
docs/cloud/cloud.md
Outdated
| Once the data store is created, clicking the data store row will open a drawer with the data store configuration, including the auto generated passkey and redis compatible connection string. | ||
|
|
||
|
|
||
|  |
There was a problem hiding this comment.
The image here should show the drawer with the details when clicking a data store row
| @@ -0,0 +1,40 @@ | |||
| --- | |||
| sidebar_position: 1 | |||
| title: Creating a Data Store | |||
There was a problem hiding this comment.
please remove this content
|
|
||
|
|
||
| # Durability and Availability | ||
| Dragonfly Cloud prioritizes both data durability and high availability for your data stores. You can further fine-tune these aspects through the concept of eviction policies when creating a data store. This allows you to strike a balance between data persistence and performance based on your application's needs. |
There was a problem hiding this comment.
please stick to the content I specified in
https://docs.google.com/document/d/1kipawV9069mc8iSZEP6OuiVsGlQkS6JTs5eZEQAYjMo/edit
There was a problem hiding this comment.
make sure to do so across the entire PR
|
|
||
| A private endpoint data store in a private network provides better security, performance and reduces data transfer costs. | ||
|
|
||
| To create a private network navigate to the Networks tab and click +Network at the top right corner. |
There was a problem hiding this comment.
Can you use an image dor +Network ?
| The minimum configuration consists of a name, cloud provider, cloud region and plan. Note that the cloud provider can not be modified once the data store is created. | ||
|
|
||
|
|
||
|  |
There was a problem hiding this comment.
This doesn't look good. Can you make it smaller and inline with the text?
This PR adds docs for: