wasp icon indicating copy to clipboard operation
wasp copied to clipboard

Write "Going into production" docs / rewrite of deployment docs

Open infomiho opened this issue 1 year ago • 1 comments

Users deploying Wasp apps sometimes get stuck and they report it on our Discord. Some of the common themes:

  • env variables are missing
  • CORS is not working as expected
  • database migrations are misunderstood
  • Wasp app building blocks are misunderstood
  • client routing is misunderstood

We cover a lot of topics in our docs (manual deployment, deploying using the Wasp CLI, env variables, some general Prisma advice) but we don't have the "going into production" topic covered from start to finish.

Here's a rough outline on what I plan to write: Image Image

One of the moves is recommended by our Discord member: moving the deployment docs on the top level. I agree with that, since all users will want to deploy, it shouldn't be hidden away in the Advanced section.

Ideally, we'd make a new top level category Deployment with the following rough outline:

Deployment/
├─ Wasp building blocks
├─ Env variables
├─ Database and schema migrations
├─ Deployment methods/
│  ├─ PaaS options
│  ├─ Self-hosting 
│  ├─ Static hosting for the client
├─ CI/CD setup
├─ Extras/
│  ├─ Using a custom domain
│  ├─ What can Wasp handle in production
│  ├─ DDoS and CDN

infomiho avatar Oct 24 '24 14:10 infomiho