From 9d2df3ac85c7163dcfcf1e8cc2d566f95b9db119 Mon Sep 17 00:00:00 2001 From: Marcus Kohlberg <78424526+marcuskohlberg@users.noreply.github.com> Date: Fri, 20 Dec 2024 15:33:46 +0100 Subject: [PATCH] update docs (#1664) --- README.md | 2 +- docs/go/develop/metadata.md | 2 +- docs/go/primitives/cron-jobs.md | 2 +- docs/go/quick-start.mdx | 2 +- docs/menu.cue | 10 +- docs/platform/deploy/deploying.md | 54 +++++----- docs/platform/deploy/environments.md | 100 ++++++++---------- .../{infrastructure => deploy}/own-cloud.md | 0 docs/platform/deploy/preview-environments.md | 35 +++--- docs/platform/deploy/security.md | 24 +++-- .../import-kubernetes-cluster.md | 4 +- docs/platform/infrastructure/infra.md | 32 +++--- docs/platform/infrastructure/kubernetes.md | 11 +- docs/platform/introduction.md | 86 ++++++++------- docs/platform/management/billing.md | 2 +- docs/platform/migration/migrate-to-encore.md | 2 +- docs/platform/migration/try-encore.md | 6 +- docs/ts/develop/metadata.md | 2 +- docs/ts/primitives/cron-jobs.md | 2 +- docs/ts/quick-start.mdx | 2 +- 20 files changed, 200 insertions(+), 180 deletions(-) rename docs/platform/{infrastructure => deploy}/own-cloud.md (100%) diff --git a/README.md b/README.md index 73aa38b131..ae67eb5aba 100644 --- a/README.md +++ b/README.md @@ -185,7 +185,7 @@ Encore comes with several built-in tools to help with testing: Encore Cloud is Encore's managed service offering for teams wanting to focus their engineering effort on their product development, avoiding investing time in platformization and DevOps. -Encore Cloud provides **automatic infrastructure provisioning in your cloud on AWS & GCP**. So instead of writing Terraform, YAML, or clicking in cloud consoles, you [connect your cloud account](https://encore.dev/docs/platform/infrastructure/own-cloud) and simply deploy your application. Since using Encore's open source backend frameworks means your application code is cloud agnostic and not tied to any specific infrastructure services, Encore Cloud enables you to change your infrastructure depending on your evolving needs, without needing to make code changes or manually update infrastructure config files. +Encore Cloud provides **automatic infrastructure provisioning in your cloud on AWS & GCP**. So instead of writing Terraform, YAML, or clicking in cloud consoles, you [connect your cloud account](https://encore.dev/docs/platform/deploy/own-cloud) and simply deploy your application. Since using Encore's open source backend frameworks means your application code is cloud agnostic and not tied to any specific infrastructure services, Encore Cloud enables you to change your infrastructure depending on your evolving needs, without needing to make code changes or manually update infrastructure config files. When you deploy, Encore Cloud automatically provisions [infrastructure](https://encore.dev/docs/platform/infrastructure/infra) using battle-tested cloud services on AWS and GCP, such as: - **Compute:** GCP Cloud Run, AWS Fargate, Kubernetes (GKE and EKS) diff --git a/docs/go/develop/metadata.md b/docs/go/develop/metadata.md index 7df919cc09..7dc1dae42a 100644 --- a/docs/go/develop/metadata.md +++ b/docs/go/develop/metadata.md @@ -51,7 +51,7 @@ however by calling `encore.CurrentRequest().PathParams()` you can get access to ### Using Cloud Specific Services -All the [clouds](/docs/platform/infrastructure/own-cloud) contain a large number of services, not all of which Encore natively supports. +All the [clouds](/docs/platform/deploy/own-cloud) contain a large number of services, not all of which Encore natively supports. By using information about the [environment](/docs/platform/deploy/environments), you can define the implementation of these and use different services for each environment's provider. For instance if you are pushing audit logs into a data warehouse, when running on GCP you could use BigQuery, but when running on AWS you could use Redshift, when running locally you could simply write them to a file. diff --git a/docs/go/primitives/cron-jobs.md b/docs/go/primitives/cron-jobs.md index 4c4112efa6..02a64f12f1 100644 --- a/docs/go/primitives/cron-jobs.md +++ b/docs/go/primitives/cron-jobs.md @@ -67,7 +67,7 @@ Cron Job executions across all your environments via the `Cron Jobs` menu item: ## Keep in mind when using Cron Jobs - Cron Jobs do not execute during local development or in [Preview Environments](/docs/platform/deploy/preview-environments). However, you can manually invoke the API to test its behavior. -- In Encore Cloud, Cron Job executions are limited to **once every hour**, with the exact minute randomized within that hour for users on the Free Tier. To enable more frequent executions or to specify the exact minute within the hour, consider [deploying to your own cloud](/docs/platform/infrastructure/own-cloud) or upgrading to the [Pro plan](/pricing). +- In Encore Cloud, Cron Job executions are limited to **once every hour**, with the exact minute randomized within that hour for users on the Free Tier. To enable more frequent executions or to specify the exact minute within the hour, consider [deploying to your own cloud](/docs/platform/deploy/own-cloud) or upgrading to the [Pro plan](/pricing). - Both public and private APIs are supported for Cron Jobs. - Ensure that the API endpoints used in Cron Jobs are idempotent, as they may be called multiple times under certain network conditions. - The API endpoints used in Cron Jobs must not take any request parameters. That is, their signatures must be `func(context.Context) error` or `func(context.Context) (*T, error)`. diff --git a/docs/go/quick-start.mdx b/docs/go/quick-start.mdx index 8a8dabf46b..a2acec8223 100644 --- a/docs/go/quick-start.mdx +++ b/docs/go/quick-start.mdx @@ -203,7 +203,7 @@ It will look something like: `https://app.encore.cloud/$APP_ID/deploys/...` 🥐 Open the URL to access the Encore Cloud dashboard and check the progress of your deployment. -You can now use the Cloud Dashboard to view production [traces](/docs/go/observability/tracing), [connect your cloud account](/docs/platform/infrastructure/own-cloud), [integrate with GitHub](/docs/platform/integrations/github), and much more. +You can now use the Cloud Dashboard to view production [traces](/docs/go/observability/tracing), [connect your cloud account](/docs/platform/deploy/own-cloud), [integrate with GitHub](/docs/platform/integrations/github), and much more.