Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: deployment guide, with supporting config and integrations. #1836

Merged
merged 62 commits into from
Nov 5, 2024

Conversation

thruflo
Copy link
Contributor

@thruflo thruflo commented Oct 11, 2024

Fleshing out deployment guide. To support it, added a sync service config page in the api docs section and specific integrations pages for various deployment platforms.

Quite a lot to review here. Check out the:

Note that:

As @KyleAMathews commented on Discord, these might be better to include in the monorepo and update using a GitHub action. Perhaps that can be a subsequent Issues / PR.

The integrations also include a Phoenix page which is based on merging #1833 and publishing an updated release for https://hexdocs.pm/electric_phoenix/0.1.0-dev-2/Electric.Phoenix.html

Note that the deployment docs all assume a single DATABASE_URL, i.e.: this is pre multi-tenant.

Copy link

netlify bot commented Oct 21, 2024

Deploy Preview for electric-next ready!

Name Link
🔨 Latest commit 0bc678c
🔍 Latest deploy log https://app.netlify.com/sites/electric-next/deploys/672a5c07841d760008d658f3
😎 Deploy Preview https://deploy-preview-1836--electric-next.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@thruflo thruflo marked this pull request as ready for review October 25, 2024 11:45
@thruflo thruflo requested review from alco and KyleAMathews October 25, 2024 11:49
Copy link
Contributor

@KyleAMathews KyleAMathews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

HUGE upgrade! Looks really nice! I can't claim to to have done a super detailed review as that would have taken 1 more hour but I did skim through every new page at least 😇

I made a few suggestions here and there that should be quick to resolve.

website/docs/api/config.md Outdated Show resolved Hide resolved
website/docs/guides/deployment.md Show resolved Hide resolved
website/docs/integrations/cloudflare.md Outdated Show resolved Hide resolved
website/docs/integrations/cloudflare.md Outdated Show resolved Hide resolved
website/docs/api/config.md Show resolved Hide resolved
website/docs/api/http.md Outdated Show resolved Hide resolved
@thruflo thruflo force-pushed the thruflo/deployment-guide branch from 4a827f1 to 3f38523 Compare October 31, 2024 15:48
@thruflo thruflo requested a review from KyleAMathews October 31, 2024 15:48
Copy link
Contributor

@KyleAMathews KyleAMathews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

Copy link
Contributor

@samwillis samwillis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is all amazing, just a couple of comments. Great work!

website/docs/guides/deployment.md Outdated Show resolved Hide resolved

### AWS Terraform

We have an example Terraform repo at [electric-sql/terraform-aws](https://github.com/electric-sql/terraform-aws).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is for the old electric, do we want to link to it without it being updated?

website/docs/integrations/supabase.md Show resolved Hide resolved
website/.vitepress/config.mts Outdated Show resolved Hide resolved
@KyleAMathews
Copy link
Contributor

@thruflo it was easier to just push the changes directly as the merge needed cleaning up

@thruflo thruflo force-pushed the thruflo/deployment-guide branch from b323679 to 49e5e5f Compare November 5, 2024 17:51
@thruflo thruflo merged commit 64e61d1 into main Nov 5, 2024
4 checks passed
@thruflo thruflo deleted the thruflo/deployment-guide branch November 5, 2024 17:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants