docs: Update netlify deploy readme for clarity #2748
Conversation
It was unlcear why "Gatsby" was mentioned in the env name for the server URL. Also, the code shows precedence given to `MEDUSA_BACKEND_URL` now:
```
__MEDUSA_BACKEND_URL__: JSON.stringify(
env.MEDUSA_BACKEND_URL ||
// Backwards-compat with Gatsby.
env.GATSBY_MEDUSA_BACKEND_URL ||
env.GATSBY_STORE_URL ||
""
),
```
Therefore, this should be indicated in the documentation.
|
| 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). |
There was a problem hiding this comment.
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".
|
@komali2 any update on this? 😊 |
|
Thanks for adding changes! I got overwhelmed at work. |
It was unlcear why "Gatsby" was mentioned in the env name for the server URL. Also, the code shows precedence given to
MEDUSA_BACKEND_URLnow:Therefore, this should be indicated in the documentation.