From 6b51dd016835df23cae927fd63de4f181c0cce25 Mon Sep 17 00:00:00 2001 From: Caleb Rogers Date: Tue, 13 Dec 2022 16:16:01 +0800 Subject: [PATCH] docs: update environment variable used in admin's deploy guides (#2748) * docs: Update netlify deploy readme for clarity 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. * Update docs/content/deployments/admin/deploying-on-netlify.md * Update deploying-on-netlify.md Co-authored-by: Shahed Nasser --- docs/content/deployments/admin/deploying-on-netlify.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/content/deployments/admin/deploying-on-netlify.md b/docs/content/deployments/admin/deploying-on-netlify.md index 2953857ffe..2ce0ac4e29 100644 --- a/docs/content/deployments/admin/deploying-on-netlify.md +++ b/docs/content/deployments/admin/deploying-on-netlify.md @@ -246,11 +246,17 @@ If you haven’t deployed your Medusa server yet, you can leave the value blank Run the following command to add the environment variable: ```bash -netlify env:set GATSBY_MEDUSA_BACKEND_URL "" +netlify env:set MEDUSA_BACKEND_URL "" ``` Where `` is the URL of your Medusa server. +:::note + +In previous versions of the admin, the environment variable name was `GATSBY_MEDUSA_BACKEND_URL` or `GATSBY_STORE_URL` instead. The admin remains backwards compatible, so if you've used this an older version you can keep the same environment variables. However, it's highly recommended you change it to `MEDUSA_BACKEND_URL`. + +::: + #### Check deployment status You can check the deployment status of your website by running the following command: