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

docs: improve admin documentation #6117

Merged
merged 6 commits into from
Jan 22, 2024
Merged

Conversation

shahednasser
Copy link
Member

  • 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.

@shahednasser shahednasser requested a review from a team as a code owner January 17, 2024 14:57
Copy link

changeset-bot bot commented Jan 17, 2024

⚠️ No Changeset found

Latest commit: d68a7c8

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Jan 17, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
api-reference ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 22, 2024 3:57pm
docs-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 22, 2024 3:57pm
medusa-dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 22, 2024 3:57pm
medusa-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 22, 2024 3:57pm

Copy link
Contributor

@kasperkristensen kasperkristensen left a 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.

@shahednasser
Copy link
Member Author

@kasperkristensen is the better approach then to:

  • recommend hosting separately instead;
  • or only add a note about increasing the provider plan to provide at least 2GB RAM

@kasperkristensen
Copy link
Contributor

kasperkristensen commented Jan 22, 2024

@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 😄

@shahednasser
Copy link
Member Author

@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!

@kodiakhq kodiakhq bot merged commit 8c67e32 into develop Jan 22, 2024
21 of 22 checks passed
@kodiakhq kodiakhq bot deleted the docs/improve-admin-options branch January 22, 2024 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants