From f09d96f21be2aa0921009025870204e30517505b Mon Sep 17 00:00:00 2001 From: Kyle Gray Date: Thu, 12 Oct 2023 13:53:32 -0700 Subject: [PATCH] docs: Replace form with dashboard link (#2840) --- docs/howto/managed-databases.md | 11 ++++++----- docs/howto/upload.md | 9 +++++---- docs/reference/changelog.md | 5 ++--- 3 files changed, 13 insertions(+), 12 deletions(-) diff --git a/docs/howto/managed-databases.md b/docs/howto/managed-databases.md index 449a00d1fe..87c301738f 100644 --- a/docs/howto/managed-databases.md +++ b/docs/howto/managed-databases.md @@ -1,5 +1,9 @@ # Managed databases +```{note} +Managed databases are powered by [sqlc Cloud](https://dashboard.sqlc.dev). Sign up for [free](https://dashboard.sqlc.dev) today. +``` + *Added in v1.22.0* `sqlc` can create and maintain hosted databases for your project. These @@ -12,15 +16,12 @@ other use-cases. Beyond linting queries, you can use sqlc managed databases in your tests to quickly stand up a database per test suite or even per test, providing a real, isolated database for a test run. No cleanup required. -Interested in trying out managed databases? Sign up [here](https://docs.google.com/forms/d/e/1FAIpQLSdxoMzJ7rKkBpuez-KyBcPNyckYV-5iMR--FRB7WnhvAmEvKg/viewform) or send us an email -at [hello@sqlc.dev](mailto:hello@sqlc.dev). - ## Configuring managed databases To configure `sqlc` to use a managed database, remove the `uri` key from your `database` configuration and replace it with the `managed` key set to `true`. Set the `project` key in your `cloud` configuration to the value of your -project ID, obtained via the sqlc.dev Dashboard. +project ID, obtained via the [dashboard](https://dashboard.sqlc.dev). ```yaml version: '2' @@ -37,7 +38,7 @@ sql: ## Authentication `sqlc` expects to find a valid auth token in the value of the `SQLC_AUTH_TOKEN` -environment variable. You can create an auth token via the sqlc.dev Dashboard. +environment variable. You can create an auth token via the [dashboard](https://dashboard.sqlc.dev). ```shell export SQLC_AUTH_TOKEN=sqlc_xxxxxxxx diff --git a/docs/howto/upload.md b/docs/howto/upload.md index b974252afc..e432df4556 100644 --- a/docs/howto/upload.md +++ b/docs/howto/upload.md @@ -1,5 +1,9 @@ # Uploading projects +```{note} +Project uploads are powered by [sqlc Cloud](https://dashboard.sqlc.dev). Sign up for [free](https://dashboard.sqlc.dev) today. +``` + *Added in v1.22.0* Uploading an archive of your project ensures that future releases of sqlc do not @@ -7,9 +11,6 @@ break your code. Similar to Rust's [crater](https://github.com/rust-lang/crater) project, uploaded archives are tested against development releases of sqlc to verify correctness. -Interested in uploading projects? Sign up [here](https://docs.google.com/forms/d/e/1FAIpQLSdxoMzJ7rKkBpuez-KyBcPNyckYV-5iMR--FRB7WnhvAmEvKg/viewform) or send us an email -at [hello@sqlc.dev](mailto:hello@sqlc.dev). - ## Add configuration After creating a project, add the project ID to your sqlc configuration file. @@ -46,4 +47,4 @@ Once you're ready to upload, remove the `--dry-run` flag. sqlc upload ``` -By uploading your project, you're making sqlc more stable and reliable. Thanks! \ No newline at end of file +By uploading your project, you're making sqlc more stable and reliable. Thanks! diff --git a/docs/reference/changelog.md b/docs/reference/changelog.md index 6ebf8dd1ec..20faa79db7 100644 --- a/docs/reference/changelog.md +++ b/docs/reference/changelog.md @@ -18,9 +18,8 @@ When you turn on managed databases, `sqlc` will use your schema to create a template database that it can copy to make future runs of `sqlc vet` very performant. -This feature relies on configuration obtained via sqlc Cloud. If you're interested -in early access you can [sign up here](https://docs.google.com/forms/d/e/1FAIpQLSdxoMzJ7rKkBpuez-KyBcPNyckYV-5iMR--FRB7WnhvAmEvKg/viewform) -or send us an email at [hello@sqlc.dev](mailto:hello@sqlc.dev). +This feature relies on configuration obtained via [sqlc +Cloud](https://dashboard.sqlc.dev). Read more in the [managed databases](../howto/managed-databases.md) documentation.