From 9530961c7926162a38b0e9916b2db5d694550e4d Mon Sep 17 00:00:00 2001 From: Zeke Foppa Date: Fri, 14 Feb 2025 11:56:54 -0800 Subject: [PATCH 01/10] [bfops/deploying]: add instructions for deploying mainnet --- docs/deploying/maincloud.md | 29 +++++++++++++++++++++++++++++ docs/deploying/testnet.md | 34 ---------------------------------- docs/nav.js | 2 +- 3 files changed, 30 insertions(+), 35 deletions(-) create mode 100644 docs/deploying/maincloud.md delete mode 100644 docs/deploying/testnet.md diff --git a/docs/deploying/maincloud.md b/docs/deploying/maincloud.md new file mode 100644 index 00000000..08f57756 --- /dev/null +++ b/docs/deploying/maincloud.md @@ -0,0 +1,29 @@ +# SpacetimeDB Cloud Deployment + +The SpacetimeDB Cloud is a managed cloud service that provides developers an easy way to deploy their SpacetimeDB apps to the cloud. + +## Deploy via CLI + +1. Install the SpacetimeDB CLI and create your module (see [Getting Started](/getting-started)) +1. Publish to maincloud: + +```bash +spacetime publish -s maincloud my-cool-module +``` + +## Connecting your Identity to the Web Dashboard + +By logging in your CLI via spacetimedb.com, you can view your published modules on the web dashboard. + +If you did not log in with spacetimedb.com when publishing your module, you can log in by running: +```bash +spacetime logout +spacetime login +``` + +1. Open the SpacetimeDB website and log in using your GitHub login. +1. You should now be able to see your published modules on the web dashboard. + +--- + +With SpacetimeDB Cloud, you benefit from automatic scaling, robust security, and the convenience of not having to manage the hosting environment. diff --git a/docs/deploying/testnet.md b/docs/deploying/testnet.md deleted file mode 100644 index ce648043..00000000 --- a/docs/deploying/testnet.md +++ /dev/null @@ -1,34 +0,0 @@ -# SpacetimeDB Cloud Deployment - -The SpacetimeDB Cloud is a managed cloud service that provides developers an easy way to deploy their SpacetimeDB apps to the cloud. - -Currently only the `testnet` is available for SpacetimeDB cloud which is subject to wipes. The `mainnet` will be available soon. - -## Deploy via CLI - -1. [Install](/install) the SpacetimeDB CLI. -1. Configure your CLI to use the SpacetimeDB Cloud. To do this, run the `spacetime server` command: - -```bash -spacetime server add --default "https://testnet.spacetimedb.com" testnet -``` - -## Connecting your Identity to the Web Dashboard - -By associating an email with your CLI identity, you can view your published modules on the web dashboard. - -1. Get your identity using the `spacetime identity list` command. Copy it to your clipboard. -1. Connect your email address to your identity using the `spacetime identity set-email` command: - -```bash -spacetime identity set-email -``` - -1. Open the SpacetimeDB website and log in using your email address. -1. Choose your identity from the dropdown menu. -1. Validate your email address by clicking the link in the email you receive. -1. You should now be able to see your published modules on the web dashboard. - ---- - -With SpacetimeDB Cloud, you benefit from automatic scaling, robust security, and the convenience of not having to manage the hosting environment. diff --git a/docs/nav.js b/docs/nav.js index 244f92b8..dfce98fa 100644 --- a/docs/nav.js +++ b/docs/nav.js @@ -10,7 +10,7 @@ const nav = { page('Overview', 'index', 'index.md'), // TODO(BREAKING): For consistency & clarity, 'index' slug should be renamed 'intro'? page('Getting Started', 'getting-started', 'getting-started.md'), section('Deploying'), - page('Testnet', 'deploying/testnet', 'deploying/testnet.md'), + page('Maincloud', 'deploying/maincloud', 'deploying/maincloud.md'), section('Migration Guides'), page('v0.12', 'migration/v0.12', 'migration/v0.12.md'), section('Unity Tutorial - Basic Multiplayer'), From 94ef82e7ea57b8ebb711a174b3712bebc0b8fd3b Mon Sep 17 00:00:00 2001 From: Zeke Foppa Date: Fri, 14 Feb 2025 12:00:43 -0800 Subject: [PATCH 02/10] [bfops/deploying]: nav.ts --- nav.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nav.ts b/nav.ts index 364b8cea..887cd2b6 100644 --- a/nav.ts +++ b/nav.ts @@ -34,7 +34,7 @@ const nav: Nav = { page('Getting Started', 'getting-started', 'getting-started.md'), section('Deploying'), - page('Testnet', 'deploying/testnet', 'deploying/testnet.md'), + page('Maincloud', 'deploying/testnet', 'deploying/testnet.md'), section('Migration Guides'), page('v0.12', 'migration/v0.12', 'migration/v0.12.md'), From 80bdcfd7c32fa4402af85a2a6e96b3bbee3dbd3d Mon Sep 17 00:00:00 2001 From: Zeke Foppa Date: Fri, 14 Feb 2025 12:08:52 -0800 Subject: [PATCH 03/10] [bfops/deploying]: nav.ts --- nav.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nav.ts b/nav.ts index 887cd2b6..999aa844 100644 --- a/nav.ts +++ b/nav.ts @@ -34,7 +34,7 @@ const nav: Nav = { page('Getting Started', 'getting-started', 'getting-started.md'), section('Deploying'), - page('Maincloud', 'deploying/testnet', 'deploying/testnet.md'), + page('Maincloud', 'deploying/maincloud', 'deploying/maincloud.md'), section('Migration Guides'), page('v0.12', 'migration/v0.12', 'migration/v0.12.md'), From 886abb2d3dc809394cf943310db25094dad09355 Mon Sep 17 00:00:00 2001 From: Zeke Foppa Date: Fri, 14 Feb 2025 12:24:20 -0800 Subject: [PATCH 04/10] [bfops/deploying]: fix link? --- docs/deploying/maincloud.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/deploying/maincloud.md b/docs/deploying/maincloud.md index 08f57756..28079750 100644 --- a/docs/deploying/maincloud.md +++ b/docs/deploying/maincloud.md @@ -4,7 +4,7 @@ The SpacetimeDB Cloud is a managed cloud service that provides developers an eas ## Deploy via CLI -1. Install the SpacetimeDB CLI and create your module (see [Getting Started](/getting-started)) +1. Install the SpacetimeDB CLI and create your module (see [Getting Started](/docs/getting-started)) 1. Publish to maincloud: ```bash From fa9f731e8015ab1aed8b657fcaf8409b92cf5c7e Mon Sep 17 00:00:00 2001 From: Zeke Foppa <196249+bfops@users.noreply.github.com> Date: Mon, 3 Mar 2025 11:00:59 -0800 Subject: [PATCH 05/10] Update docs/deploying/maincloud.md Co-authored-by: John Detter <4099508+jdetter@users.noreply.github.com> --- docs/deploying/maincloud.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/deploying/maincloud.md b/docs/deploying/maincloud.md index 28079750..c949e2af 100644 --- a/docs/deploying/maincloud.md +++ b/docs/deploying/maincloud.md @@ -1,4 +1,4 @@ -# SpacetimeDB Cloud Deployment +# Deploy to Maincloud The SpacetimeDB Cloud is a managed cloud service that provides developers an easy way to deploy their SpacetimeDB apps to the cloud. From afb111414f224a4e8228079b9ea8df249939efc7 Mon Sep 17 00:00:00 2001 From: Zeke Foppa <196249+bfops@users.noreply.github.com> Date: Mon, 3 Mar 2025 11:01:08 -0800 Subject: [PATCH 06/10] Update docs/deploying/maincloud.md Co-authored-by: John Detter <4099508+jdetter@users.noreply.github.com> --- docs/deploying/maincloud.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/deploying/maincloud.md b/docs/deploying/maincloud.md index c949e2af..1a861e55 100644 --- a/docs/deploying/maincloud.md +++ b/docs/deploying/maincloud.md @@ -1,6 +1,6 @@ # Deploy to Maincloud -The SpacetimeDB Cloud is a managed cloud service that provides developers an easy way to deploy their SpacetimeDB apps to the cloud. +Maincloud is a managed cloud service that provides developers an easy way to deploy their SpacetimeDB apps to the cloud. ## Deploy via CLI From aa7b0f441df127ec27ca0089c6cf0a8273bda399 Mon Sep 17 00:00:00 2001 From: Zeke Foppa Date: Mon, 3 Mar 2025 11:05:39 -0800 Subject: [PATCH 07/10] [bfops/deploying]: review --- docs/deploying/maincloud.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/deploying/maincloud.md b/docs/deploying/maincloud.md index 1a861e55..70ca33c8 100644 --- a/docs/deploying/maincloud.md +++ b/docs/deploying/maincloud.md @@ -4,7 +4,8 @@ Maincloud is a managed cloud service that provides developers an easy way to dep ## Deploy via CLI -1. Install the SpacetimeDB CLI and create your module (see [Getting Started](/docs/getting-started)) +1. Install the SpacetimeDB CLI for your platform: [Install SpacetimeDB](/install) +1. Create your module (see [Getting Started](/docs/getting-started)) 1. Publish to maincloud: ```bash From c5b440a070887b7fc8db574f5ce16f49be91278f Mon Sep 17 00:00:00 2001 From: Zeke Foppa <196249+bfops@users.noreply.github.com> Date: Mon, 3 Mar 2025 15:51:12 -0800 Subject: [PATCH 08/10] Update docs/deploying/maincloud.md Co-authored-by: Tyler Cloutier --- docs/deploying/maincloud.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/deploying/maincloud.md b/docs/deploying/maincloud.md index 70ca33c8..14f88f38 100644 --- a/docs/deploying/maincloud.md +++ b/docs/deploying/maincloud.md @@ -6,7 +6,7 @@ Maincloud is a managed cloud service that provides developers an easy way to dep 1. Install the SpacetimeDB CLI for your platform: [Install SpacetimeDB](/install) 1. Create your module (see [Getting Started](/docs/getting-started)) -1. Publish to maincloud: +1. Publish to Maincloud: ```bash spacetime publish -s maincloud my-cool-module From 092fc040fafe321c3de385bf81ae2974c5241445 Mon Sep 17 00:00:00 2001 From: Phoebe Goldman Date: Mon, 3 Mar 2025 19:00:47 -0500 Subject: [PATCH 09/10] Apply suggestions from code review Co-authored-by: Tyler Cloutier --- docs/deploying/maincloud.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/deploying/maincloud.md b/docs/deploying/maincloud.md index 14f88f38..ea14ebbd 100644 --- a/docs/deploying/maincloud.md +++ b/docs/deploying/maincloud.md @@ -23,8 +23,8 @@ spacetime login ``` 1. Open the SpacetimeDB website and log in using your GitHub login. -1. You should now be able to see your published modules on the web dashboard. +1. You should now be able to see your published modules [by navigating to your profile on the website](/profile). --- -With SpacetimeDB Cloud, you benefit from automatic scaling, robust security, and the convenience of not having to manage the hosting environment. +With SpacetimeDB Maincloud, you benefit from automatic scaling, robust security, and the convenience of not having to manage the hosting environment. From 189035aad5d8c31b5d1cff015d98ef185f0f7e6d Mon Sep 17 00:00:00 2001 From: Phoebe Goldman Date: Mon, 3 Mar 2025 19:03:50 -0500 Subject: [PATCH 10/10] Add `/profile` as a known link --- scripts/checkLinks.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/checkLinks.ts b/scripts/checkLinks.ts index 58c94f47..944f67d2 100644 --- a/scripts/checkLinks.ts +++ b/scripts/checkLinks.ts @@ -124,7 +124,7 @@ function checkLinks(): void { return; // Skip external links } - const siteLinks = ['/install', '/images']; + const siteLinks = ['/install', '/images', '/profile']; for (const siteLink of siteLinks) { if (link.startsWith(siteLink)) { return; // Skip site links