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

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

Open
infomiho opened this issue Oct 24, 2024 · 1 comment
Open

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

infomiho opened this issue Oct 24, 2024 · 1 comment
Assignees
Labels
deployment documentation Improvements or additions to documentation

Comments

@infomiho
Copy link
Contributor

infomiho commented Oct 24, 2024

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 infomiho self-assigned this Oct 24, 2024
@infomiho infomiho added documentation Improvements or additions to documentation deployment labels Oct 24, 2024
@infomiho infomiho changed the title Improve our deployment docs Write "Going into production" docs / rewrite of deployment docs Oct 24, 2024
@infomiho infomiho added epic Umbrella feature that encompasses multiple smaller features and removed epic Umbrella feature that encompasses multiple smaller features labels Oct 24, 2024
@Martinsos
Copy link
Member

This will be great!
These two issues are very relevant: #2201 and #2053 .
These two might be relevant: #1927 and #1464 .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deployment documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants