redwoodjs-com-archive icon indicating copy to clipboard operation
redwoodjs-com-archive copied to clipboard

Deploy Doc improvements

Open thedavidprice opened this issue 3 years ago • 3 comments

cc @MarkBennett

The Deploy Doc is in need of some TLC. Some initial thoughts:

Intro

  • need to make it serverless or traditional infr agnostic + highlight you can switch as you go with zero code changes
  • need to include Data migration as a deploy process step (along with Prisma DB migrations)

General Deployment Setup

This just needs some cleaning up:

  • There's a lot more you can do with redwood.toml config for paths: link to doc
  • Build command: should link to doc and explain how build works and can examine locally
  • Prisma and Database: should also include data migrations, link to docs
  • Environment Variables: make sure we highlight that you need to manually handle Web env vars

All the "tl;dr" Deploy sections --> create a "Quick Start" section at the beginning

I'd like to remove the "tl;dr Deploy" sections for each provider. Instead, we can include a kind of "Deployment Quick Start" section at the beginning — the point being to help people experience deploying a Redwood project with minimal steps required.

See this tweet as an example of what we can do: https://twitter.com/jlengstorf/status/1491530279147622400?s=20&t=3bsdPNcZ5sqf_Gl0oVpXGg

Some thoughts:

  • clone the Redwood Tutorial repo (or other Example Apps when ready for v1)
  • need to handle using Postgres: schema.prisma, run prisma migrate dev, use Railway for DB (see reference section in Tutorial)
  • then can be used to try out any of the hosting provider

thedavidprice avatar Feb 12 '22 01:02 thedavidprice

Thanks for starting this @thedavidprice!

How would you feel about making this page just an example of deploying with the goal of getting a Redwood app deployed in the fastest and simplest way possible. Then we could have seperate small pages for the different deployment options with specific details for each. Alternatively, some providers like Supabase provide their own tutorials that we could link to instead.

Are there some good examples of similair deploy guides you've seen that you'd like to emulate?

Finally, I've been using Remix lately and appreciate that it asks you to choose a deployment provider as part of creating the app. This might be a v1.1 feature, but would it make sense to set up a deployment when you create the app.

MarkBennett avatar Feb 12 '22 18:02 MarkBennett

I just posted on Discource to get the latest advice on how to deploy Redwood quickly and easily. I'll let you know what I hear back!

https://community.redwoodjs.com/t/what-is-the-simplest-way-to-get-redwood-deployed-as-a-publicly-accessible-site/2774

MarkBennett avatar Feb 18 '22 16:02 MarkBennett

Thanks for taking this on Mark! This topic has been near and dear to my heart over the last 2 years, and there's a handful of other hosting platforms like Layer0 and Qovery that I've deployed to but have not properly documented yet. I'll try to carve out some time next week to provide some notes and material so we can make sure we're covering all of our capabilities.

ajcwebdev avatar Feb 18 '22 17:02 ajcwebdev