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.

Sign up for GitHub

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: Update netlify deploy readme for clarity #2748

Merged
merged 3 commits into from
Dec 13, 2022
Merged

docs: Update netlify deploy readme for clarity #2748

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4a817fd
docs: Update netlify deploy readme for clarity
komali2 Dec 9, 2022
99f4aea
Update docs/content/deployments/admin/deploying-on-netlify.md
shahednasser Dec 13, 2022
b256a9d
Update deploying-on-netlify.md
shahednasser Dec 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/content/deployments/admin/deploying-on-netlify.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,13 @@ Run the following command to add the environment variable:
netlify env:set GATSBY_MEDUSA_BACKEND_URL "<YOUR_SERVER_URL>"
shahednasser marked this conversation as resolved.
Show resolved Hide resolved
```

Where `<YOUR_SERVER_URL>` is the URL of your Medusa server.
Where `<YOUR_SERVER_URL>` is the URL of your Medusa server. Note that the usage of `GATSBY` in the environment variable name doesn't mean you can only use Gatsby frontend starters. For backwards compatibility, the following environment variable names are all valid and will all result with your Medusa Admin app communicating with the provided value as your Medusa server. Use any one of:

1. `GATSBY_MEDUSA_BACKEND_URL`
2. `GATSBY_STORE_URL`
3. `MEDUSA_BACKEND_URL`

If you define multiple environment variables with the above names, precedence will be given to `MEDUSA_BACKEND_URL`, and the others will be ignored (even if `MEDUSA_BACKEND_URL` is an invalid URL).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's revert this back to the text that was before "Where <YOUR_SERVER_URL> is the URL of your Medusa server." and instead add a note saying something like "Previous versions of the Medusa admin use GATSBY_MEDUSA_BACKEND_URL or GATSBY_STORE_URL. Although the Admin is backwards compatible, it is advised to change the variable to MEDUSA_BACKEND_URL".


#### Check deployment status

Expand Down