-
-
Notifications
You must be signed in to change notification settings - Fork 2.9k
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: improve admin documentation #6117
Conversation
shahednasser
commented
Jan 17, 2024
- Move the admin plugin's options to the Admin Configuration documentation.
- Add a section on how to change the backend URL for both development and production.
- Fix the troubleshooting section related to port forwarding.
- General fixes.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Only comment I have, is on the note to enable autoRebuild in the various deployment guides. A good amount of these providers offer some very weak entry plans, that don't have the necessary RAM to handle running the build on the server. Might make sense to address this within the note. It requires a minimum of 2GB RAM.
@kasperkristensen is the better approach then to:
|
@shahednasser What I usually tell people is that they could take a look at using GitHub actions to run the build before deploying their server, we do that in our staging project if you want to see an example. People can also opt to host separately, but while it may be free to host the admin on something like Vercel, the free plan is not allowed to be used for commercial usage, so in reality you are properly not saving money by hosting it by there. So people have options, and I don't think one is better than the others. Maybe we should just add a small description on the different options available to people somewhere, and then link to it in a callout on all the hosting guides. In any case this is only really relevant for people who are just exploring Medusa or setting up a pet project, as most "serious" projects will have plenty of RAM to support the feature. But I still think its important to guide first timers, so this doesn't become a frustration point when testing Medusa out 😄 |
@kasperkristensen got it! I'm looking into improving the deployment guides as a whole, so I'll keep it out of this PR for now and add into that one. Thanks for the info! |