docs: Add deployment docs for automatic deployment

mtwichel commented 1 month ago

Description

Currently, all of the docs for deploying Dart Frog are for manual deployment to their systems. However, which my PR adding docs for Railway deployment, I wrote instructions for automatic deployment from Github because that seemed the most natural for that platform.

This got me wondering if we should have docs specifically for doing automatic deployment onto different services. I'm envisioning something simple to start, like Google Cloud Build -> Cloud Run, or maybe Github Actions to AWS?

Obviously it could be different for everyone's systems and we can't (and shouldn't) cover every possible case. However, I think a really simple start would be nice for people new to backend in general.

Additionally, maybe it would even be cool to add something like this GitHub workflow for auto-deploying from GitHub, either to Very Good Workflows or this repository. I can open a separate ticket for that if you're into the idea.

LMK you thoughts! :blue_h

Requirements

[ ] No functional changes to the code.
[ ] All CI/CD checks are passing.
[ ] There is no drop in the test coverage percentage.

Additional Context

No response

mtwichel commented 1 month ago

Also happy to jump on a call if we want to discuss where this could live.

tomarra commented 1 month ago

Thanks for opening this up @mtwichel! In talking with the team this is for sure on the radar but we don't have it prioritized right now so I'm giving it a P2. That being said if you have content for this already and want to contribute it back (like the Railway docs) feel free to open the PR so we can get it reviewed and merged. It would be greatly appreciated.

mtwichel commented 1 month ago

I'm more than happy to contribute - I mainly opened this up for some guidance on where to add the docs. I'm thinking

L Deploy
  L Manual Deployment
  L Automatic Deployment
  L Platform Specific Guides
    L Cloud Run
    L AWS
    L ...ect

tomarra commented 1 month ago

Any idea on what the Manual & Automatic deployment sections would have? Right now all the deploy docs are platform specific. Wondering if it's better to split the current docs into Manual and Automatic sections. Thoughts?

mtwichel commented 1 month ago

I realize we don't have a general doc on "this is how you build a project". I'm not even sure if dart_frog build is documented outside the platform specific ones. So my thought is that we'd have a doc explaining the basic concept of building and containerizing your application. Maybe instead of "Manual" it could just be "Building"?

As for automatic, originally I thought that it would be a good place for explaining how to auto-deploy in a general sense But, now that I think about it, it's basically the same as the manual deployment just in whatever spec your CI/CD supports. Maybe we could have a section on "Autodeploy with Github" or something like that? It would be GitHub specific but I think that's by far the most common platform. The actual deploy step varies by platform, but not by much so we could just tell them to fill in the blank.

VeryGoodOpenSource / dart_frog