From 1663b0791812a2950c8d4d77a5882742ae130090 Mon Sep 17 00:00:00 2001 From: Oleksii Sholik Date: Sat, 3 Aug 2024 09:37:14 +0300 Subject: [PATCH] wip --- docs/.vitepress/config.mts | 2 +- docs/api/clients/typescript.md | 2 +- docs/guides/deployment.md | 27 ++++++++++++++++++++++++++- 3 files changed, 28 insertions(+), 3 deletions(-) diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 818b6e11..2f2fcbf8 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -47,7 +47,7 @@ export default defineConfig({ { text: 'Quickstart', link: '/guides/quickstart' }, // { text: 'Usage', link: '/guides/usage' }, { text: 'Shapes', link: '/guides/shapes' }, - // { text: 'Deployment', link: '/guides/deployment' }, + { text: 'Deployment', link: '/guides/deployment' }, { text: 'Writing clients', link: '/guides/write-your-own-client' } ] }, diff --git a/docs/api/clients/typescript.md b/docs/api/clients/typescript.md index ce867a80..8a563b34 100644 --- a/docs/api/clients/typescript.md +++ b/docs/api/clients/typescript.md @@ -29,7 +29,7 @@ The client exports a `ShapeStream` class for getting updates to shapes on a row- ### `ShapeStream` ```tsx -import { ShapeStream } from '@electric-sql/next' +import { ShapeStream } from '@electric-sql/next', // Passes subscribers rows as they're inserted, updated, or deleted const stream = new ShapeStream({ diff --git a/docs/guides/deployment.md b/docs/guides/deployment.md index 3dc064c9..1d879a30 100644 --- a/docs/guides/deployment.md +++ b/docs/guides/deployment.md @@ -4,4 +4,29 @@ outline: deep # Deployment -This page is under construction. \ No newline at end of file +## Components + +... + +## PostgreSQL with logical replication + +... + +## Docker image + +... + +## Configuration + +- DATABASE_URL +- SSL +- IPv6 +- CACHE + +## Caching proxy + +... + +## Authentication + +...