Repository navigation
Add docs for cedardb cloud and the agents feature - #237
lukasvogel wants to merge 2 commits into
Conversation
|
There are already docs for cedardb cloud, of course not agent specific but we should not duplicate that |
Split the CedarDB Cloud page into Get Started, Manage Projects, Monitoring and Backups, and redirect its old address.
2b17a84 to
5f9810a
Compare
| ## Sign up | ||
|
|
||
| 1. Open the [CedarDB Cloud sign-up page](https://app.cedardb.cloud/signup/). | ||
| 2. Enter your details and confirm your email address. |
There was a problem hiding this comment.
maybe add a note that says that people should double check spam 🙈
| Before your first project starts, also for the trial, you add a payment card. | ||
| CedarDB Cloud verifies it before it creates the project. |
There was a problem hiding this comment.
| Before your first project starts, also for the trial, you add a payment card. | |
| CedarDB Cloud verifies it before it creates the project. | |
| Before your first project starts, also for the trial, you add a payment card. | |
| CedarDB Cloud verifies it before it creates the project. We never charge your card before the end of the trial. |
|
|
||
| {{% /steps %}} | ||
|
|
||
| CedarDB Cloud then creates the project and starts its instance. |
There was a problem hiding this comment.
| CedarDB Cloud then creates the project and starts its instance. | |
| CedarDB Cloud then creates the project and starts your database instance. |
|
|
||
| The **Connection** card on the project's **Overview** tab shows the connection string once the project runs. | ||
|
|
||
|  |
There was a problem hiding this comment.
maybe increase font size here, this is rather hard to read from afar.
|
|
||
| Open the project in CedarDB Cloud and go to its **Agents** tab. | ||
| Select **Switch on**. | ||
| After a moment, the status reads **Agents are on**. |
There was a problem hiding this comment.
| After a moment, the status reads **Agents are on**. | |
| The status changes to **Agents are on** when your instance is ready for agent access. |
|
|
||
| To let agents read everything at once, select **Let it read all tables**. | ||
|
|
||
|  |
There was a problem hiding this comment.
This is also a bit hard to read, maybe larger font size would help?
|
|
||
| ```text | ||
| https://api.app.cedardb.cloud/mcp | ||
| ``` |
|
|
||
| Every project starts with the user `cedar` and the database `postgres` on port `5432`. | ||
| Connect with `psql` and run a first query: | ||
|
|
There was a problem hiding this comment.
Do you want to mention that users can also regenerate there password here?
Maybe even that we create two users on startup to allow the sql executor and the connection string to run independantly and serve the user with fresh data.
There was a problem hiding this comment.
i saw that you had some of the info in project. I think it makes more sense there to keep getting started brief.
| It loses access to every project. | ||
| To use it again, connect it again. | ||
|
|
||
| **Your AI clients** also shows when each client connected and when it last queried. |
There was a problem hiding this comment.
Revoking the access also rerolls the account password. so in case the agent fiddled with those settings and you are not sure, shutting down (or restarting) brings the access rights to a defined state.
Furthermore the agent never sees the database PW (altough it can set a new one). If you want to add a security angle.
| You don't have to install, patch, or size anything yourself: create a project, connect with any PostgreSQL-compatible client, and start querying. | ||
|
|
||
| * [Get Started](./get_started) — sign up, create a project, and connect to it | ||
| * [Manage Projects](./manage_projects) — start, stop, reset the password, and delete a project |
There was a problem hiding this comment.
Not for this PR, just that I thought of it now: do we want to have the — in the docs? I think we have them already, but maybe we want to eliminate them? what do you think?
| 1. Open the [CedarDB Cloud sign-up page](https://app.cedardb.cloud/signup/). | ||
| 2. Enter your details and confirm your email address. | ||
| 3. Sign in at [app.cedardb.cloud](https://app.cedardb.cloud). |
There was a problem hiding this comment.
Does the user have to open a new site for logging in? do we not redirect with the email confirmation? Somehow it feels a bit weird to me to link the page again
| 2. Enter your details and confirm your email address. | ||
| 3. Sign in at [app.cedardb.cloud](https://app.cedardb.cloud). | ||
|
|
||
| Your account comes with an organization. |
There was a problem hiding this comment.
This sentence is weird, maybe better:
| Your account comes with an organization. | |
| Your account represents your organization. |
or I do not understand the meaning
|
|
||
| Your account comes with an organization. | ||
| It groups your projects and holds your billing details and limits. | ||
| Each database you run lives in its own project, with its own storage, connection details, and backups. |
There was a problem hiding this comment.
Do we want to specify this really on the website? Thinking if we at somepoint want multi tenancy we would need to remove this.
| Your organization's first project can run as a free trial for 30 days. | ||
| The trial runs on a Cloud I2 instance with up to 64 GiB of storage. | ||
|
|
||
| Before your first project starts, also for the trial, you add a payment card. |
There was a problem hiding this comment.
| Before your first project starts, also for the trial, you add a payment card. | |
| Before your first project starts, also for the trial, you need to add a payment card. |
| If the newest backup failed, the tab says so above the backup history. | ||
| Select **Show error** next to the failed backup to see why. |
There was a problem hiding this comment.
there is now new line before the select displayed. I think we should have one
|
|
||
| ### Confirm the restore | ||
|
|
||
| Type the project's name to confirm, then select **Restore backup**. |
There was a problem hiding this comment.
As a future feature, I think it would be nice to create a new instance from a backup.
| Build a dashboard of daily revenue per region for the last 90 days, with a filter by product category. | ||
| ``` | ||
|
|
||
| ## Switch agents on for a project |
There was a problem hiding this comment.
| ## Switch agents on for a project | |
| ## Switch agents `on` for a project |
|
|
||
| To let agents read everything at once, select **Let it read all tables**. | ||
|
|
||
|  |
There was a problem hiding this comment.
I think it would be nice to see the side bar to be able to know where this is by looking at the screenshot
|
|
||
| ### Explore and answer questions | ||
|
|
||
| Agents find their way around an unfamiliar schema and answer questions that would take several queries to answer by hand. |
There was a problem hiding this comment.
Do agents not also send several queries? I think this sentence is misleading. Maybe:
| Agents find their way around an unfamiliar schema and answer questions that would take several queries to answer by hand. | |
| Agents find their way around an unfamiliar schema and answer questions that would be cumbersome to answer by hand as they need multiple queries. |
No description provided.