From 9e7e8c6d51583784c2e06f37576d1064390f4998 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Wed, 9 Nov 2022 16:30:41 +0200 Subject: [PATCH] docs: migrated images to cloudinary from imgur (#2569) --- docs/content/add-plugins/algolia.md | 20 ++++---- .../contentful/customize-contentful.md | 18 ++++---- docs/content/add-plugins/contentful/index.md | 30 ++++++------ docs/content/add-plugins/mailchimp.md | 6 +-- docs/content/add-plugins/meilisearch.md | 8 ++-- docs/content/add-plugins/minio.md | 16 +++---- docs/content/add-plugins/paypal.md | 8 ++-- docs/content/add-plugins/s3.md | 16 +++---- docs/content/add-plugins/segment.md | 18 ++++---- docs/content/add-plugins/sendgrid.mdx | 2 +- docs/content/add-plugins/slack.md | 8 ++-- docs/content/add-plugins/spaces.md | 20 ++++---- docs/content/add-plugins/strapi.md | 8 ++-- docs/content/add-plugins/stripe.md | 8 ++-- docs/content/add-plugins/twilio-sms.md | 2 +- docs/content/admin/quickstart.md | 2 +- .../advanced/backend/batch-jobs/index.md | 2 +- .../how-to-create-notification-provider.md | 4 +- .../payment/how-to-create-payment-provider.md | 2 +- .../advanced/backend/shipping/overview.md | 2 +- .../deployments/admin/deploying-on-netlify.md | 28 +++++------ .../server/deploying-on-digital-ocean.md | 46 +++++++++---------- .../deployments/server/deploying-on-qovery.md | 10 ++-- .../storefront/deploying-gatsby-on-netlify.md | 28 +++++------ docs/content/introduction.md | 2 +- .../content/starters/gatsby-medusa-starter.md | 10 ++-- .../content/starters/nextjs-medusa-starter.md | 16 +++---- docs/content/troubleshooting/cors-issues.md | 2 +- .../missing-payment-providers.md | 4 +- docs/content/user-guide/customers/groups.mdx | 10 ++-- docs/content/user-guide/customers/manage.mdx | 2 +- docs/content/user-guide/gift-cards/manage.mdx | 24 +++++----- docs/content/user-guide/index.mdx | 18 ++++---- docs/content/user-guide/lists.mdx | 22 ++++----- docs/content/user-guide/orders/claims.mdx | 20 ++++---- docs/content/user-guide/orders/drafts.mdx | 10 ++-- docs/content/user-guide/orders/exchange.mdx | 12 ++--- docs/content/user-guide/orders/export.mdx | 6 +-- .../user-guide/orders/fulfillments.mdx | 6 +-- docs/content/user-guide/orders/manage.mdx | 12 ++--- docs/content/user-guide/orders/returns.mdx | 6 +-- .../content/user-guide/price-lists/import.mdx | 10 ++-- .../content/user-guide/price-lists/manage.mdx | 24 +++++----- .../user-guide/products/collections.mdx | 8 ++-- docs/content/user-guide/products/export.mdx | 6 +-- docs/content/user-guide/products/import.mdx | 8 ++-- docs/content/user-guide/products/index.mdx | 4 +- docs/content/user-guide/products/manage.mdx | 46 +++++++++---------- docs/content/user-guide/regions/manage.mdx | 6 +-- docs/content/user-guide/regions/providers.mdx | 4 +- .../user-guide/regions/shipping-options.mdx | 6 +-- .../user-guide/sales-channels/manage.mdx | 12 ++--- .../user-guide/sales-channels/products.mdx | 4 +- .../user-guide/taxes/tax-overrides.mdx | 8 ++-- docs/content/user-guide/taxes/tax-rates.mdx | 4 +- docs/content/user-guide/users/team.mdx | 10 ++-- 56 files changed, 326 insertions(+), 328 deletions(-) diff --git a/docs/content/add-plugins/algolia.md b/docs/content/add-plugins/algolia.md index 27051b23a7..9c7e125e2b 100644 --- a/docs/content/add-plugins/algolia.md +++ b/docs/content/add-plugins/algolia.md @@ -34,27 +34,27 @@ The first step is to create an Algolia app for your Medusa server. To create one On the Applications page, click on the New application button at the top right. -![Click on New application button at the top right](https://i.imgur.com/WxckgS2.png) +![Click on New application button at the top right](https://res.cloudinary.com/dza7lstvk/image/upload/v1667999820/Medusa%20Docs/Algolia/WxckgS2_eygl8l.png) In the new page that opens, optionally enter a name for the application and choose a subscription plan. You can choose the Free plan for now, but it’s recommended to switch to the Pay-as-you-go plan as your business grows. -![Optionally enter a name for the application and choose a subscription plan](https://i.imgur.com/jpM2EBU.png) +![Optionally enter a name for the application and choose a subscription plan](https://res.cloudinary.com/dza7lstvk/image/upload/v1667999980/Medusa%20Docs/Algolia/jpM2EBU_fui1lg.png) Once you’re done, click on the Next Step button. If you picked Pay as you go service, you’ll need to enter billing details before you proceed. Then, you’ll be asked to pick a region for your application. Once you’re done, click on Review Application Details. -![Select a region then click on Review Application Details at the bottom right](https://i.imgur.com/fahf2J2.png) +![Select a region then click on Review Application Details at the bottom right](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000005/Medusa%20Docs/Algolia/fahf2J2_qgm7sa.png) In the last step, you’ll see a summary of your order. If all looks good, check the checkboxes at the end of the form to indicate that you agree to the terms and conditions. Then, click on the Create Application button. -![Summary of your application's order with the terms and agreement checkboxes checked](https://i.imgur.com/PTI2Swq.png) +![Summary of your application's order with the terms and agreement checkboxes checked](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000019/Medusa%20Docs/Algolia/PTI2Swq_a1qbi5.png) ## Retrieve API Keys To retrieve the API keys that you’ll use in the next sections, go to Settings, then choose API Keys in the Team and Access section. -![Click on API Keys in the Team and Access section of your settings](https://i.imgur.com/gnORibC.png) +![Click on API Keys in the Team and Access section of your settings](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000028/Medusa%20Docs/Algolia/gnORibC_msuur5.png) On this page, you’ll find the Application ID, Search-Only API Key, and Admin API Key. You’ll need the Application ID and Admin API Key for the Medusa server. As for the storefront, you’ll need the Application ID and Search-Only API Key. @@ -64,7 +64,7 @@ If you have more than one application in your Algolia account, make sure you’r ::: -![Application ID, Search-Only API Key, and Admin API Key can be found in the API Keys page](https://i.imgur.com/i50Irki.png) +![Application ID, Search-Only API Key, and Admin API Key can be found in the API Keys page](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000037/Medusa%20Docs/Algolia/i50Irki_jmtyk6.png) ## Install the Algolia Plugin @@ -128,7 +128,7 @@ npm run start The quickest way to test that the integration is working is by sending a `POST` request to `/store/products/search`. This endpoint accepts a `q` body parameter of the query to search for and returns in the result the products that match this query. -![Postman request send to the search endpoint that retrieves products using Algolia](https://i.imgur.com/IHeTsi7.png) +![Postman request send to the search endpoint that retrieves products using Algolia](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000054/Medusa%20Docs/Algolia/IHeTsi7_ymhb2p.png) You can also check that the products are properly indexed by opening your Algolia dashboard and choosing Search from the left sidebar. You’ll find your products that are on your Medusa server added there. @@ -138,7 +138,7 @@ If you have more than one application on your Algolia account, make sure you’r ::: -![Products from the Medusa server can be seen on the Algolia dashboard](https://i.imgur.com/wkXzUH0.png) +![Products from the Medusa server can be seen on the Algolia dashboard](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000071/Medusa%20Docs/Algolia/wkXzUH0_dowyxj.png) ### Add or Update Products @@ -211,7 +211,7 @@ To make sure the Next.js storefront properly displays the products in the search ::: -![Search pop up in the Next.js storefront](https://i.imgur.com/1f9qqK6.png) +![Search pop up in the Next.js storefront](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000082/Medusa%20Docs/Algolia/1f9qqK6_c0z8zi.png) ## Add to Gatsby and React-Based Storefronts @@ -325,7 +325,7 @@ And add the `Search` component in the returned JSX before `RegionPopover`: If you run your Gatsby storefront while the Medusa server is running, you should find a search bar in the header of the page. Try entering a query to search through the products in your store. -![Search bar in the Gatsby storefront](https://i.imgur.com/INtlcIo.png) +![Search bar in the Gatsby storefront](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000097/Medusa%20Docs/Algolia/INtlcIo_jlh16x.png) ## What’s Next diff --git a/docs/content/add-plugins/contentful/customize-contentful.md b/docs/content/add-plugins/contentful/customize-contentful.md index 32d442c340..ac41bbf78c 100644 --- a/docs/content/add-plugins/contentful/customize-contentful.md +++ b/docs/content/add-plugins/contentful/customize-contentful.md @@ -118,31 +118,31 @@ This runs the Contentful migration in that file and makes the necessary changes To check if the above migration worked, in your Contentful Space dashboard go to Content Models from the navigation bar. You should see the new content model Rich Text. -![Rich Text can be found among content models](https://i.imgur.com/W5WzcTG.png) +![Rich Text can be found among content models](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001241/Medusa%20Docs/Contentful/W5WzcTG_vau6c9.png) The above migration also allows you to add Rich Text content to pages. To test this out, go to Content from the navigation bar and choose Page in the select field next to the search bar. This shows the available pages in your Contentful Space. -![Filter content to only show pages by choosing Page in the Content Type select field](https://i.imgur.com/ht87z4e.png) +![Filter content to only show pages by choosing Page in the Content Type select field](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001251/Medusa%20Docs/Contentful/ht87z4e_gmbk6c.png) Choose one of the pages. For example, the About page. Then, scroll down to the Add content button. If you click on it, you should be able to choose Rich Text under New Content. -![Click on add content and choose from the dropdown Rich Text](https://i.imgur.com/pJ5yM0m.png) +![Click on add content and choose from the dropdown Rich Text](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001261/Medusa%20Docs/Contentful/pJ5yM0m_dfb7vp.png) Click on Rich Text and a new form will open to create new Rich Text content. It has the same fields that you defined in the migration file. -![The Rich Text form is filled with data](https://i.imgur.com/lAglhc9.png) +![The Rich Text form is filled with data](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001271/Medusa%20Docs/Contentful/lAglhc9_ejfs2i.png) After adding the content you want, click on the Publish button on the right then go back to the About page editor. -![Click on the Publish button at the right](https://i.imgur.com/oYpQKsc.png) +![Click on the Publish button at the right](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001281/Medusa%20Docs/Contentful/oYpQKsc_piobfk.png) Similarly, in the About page editor, click on the Publish Changes button on the right to view these changes later in the storefront. -![Click on the Publish changes button at the right](https://i.imgur.com/DIMo3hd.png) +![Click on the Publish changes button at the right](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001296/Medusa%20Docs/Contentful/DIMo3hd_ylxkr3.png) Similarly, you can add Rich Text content to any product page. -![A rich text content is added to a product](https://i.imgur.com/wgI8mEB.png) +![A rich text content is added to a product](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001305/Medusa%20Docs/Contentful/wgI8mEB_wbukpd.png) ## Render New Content Models in the Storefront @@ -238,7 +238,7 @@ npm run start This runs the Gatsby storefront on `localhost:8000`. Go to the storefront in your browser and open the About page. You should see the Rich Text content you added. -![Rich Text content you added to the about page should be visible now](https://i.imgur.com/aQAY9Vz.png) +![Rich Text content you added to the about page should be visible now](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001320/Medusa%20Docs/Contentful/aQAY9Vz_yw4eop.png) ### Render Component in a Product Page @@ -306,7 +306,7 @@ This loops over `contentModules` and if the type of the content is Rich Text, it Restart the Gatsby storefront then open a product that you added Rich Text content to. You should see the Rich Text component at the end of the page. -![Rich Text content you added to the product should be visible at the end of the page](https://i.imgur.com/LGiVMxx.png) +![Rich Text content you added to the product should be visible at the end of the page](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001342/Medusa%20Docs/Contentful/LGiVMxx_rqsr2l.png) ## What’s Next diff --git a/docs/content/add-plugins/contentful/index.md b/docs/content/add-plugins/contentful/index.md index 7bddb04d8e..4a9dee7379 100644 --- a/docs/content/add-plugins/contentful/index.md +++ b/docs/content/add-plugins/contentful/index.md @@ -52,15 +52,15 @@ Set the value for `CONTENTFUL_ENV` to `master`. To retrieve the value of `CONTENTFUL_SPACE_ID`, go to your [Contentful Space dashboard](https://app.contentful.com/). Then, choose Settings in the navigation bar and select API keys from the dropdown. -![Click on Settings then select API keys from the dropdown](https://i.imgur.com/hvp6zo5.png) +![Click on Settings then select API keys from the dropdown](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001360/Medusa%20Docs/Contentful/hvp6zo5_uaqtmi.png) On the APIs page, click Add API Key. -![Click on the Add API Key button](https://i.imgur.com/KlH2BDg.png) +![Click on the Add API Key button](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001375/Medusa%20Docs/Contentful/KlH2BDg_fiqd80.png) In the form, enter a name for the API key and click Save. -![A form with the name of API key entered](https://i.imgur.com/hOG1RqM.png) +![A form with the name of API key entered](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001385/Medusa%20Docs/Contentful/hOG1RqM_tmctae.png) Then, copy the value of Space ID and set it as the value of `CONTENTFUL_SPACE_ID`. @@ -68,11 +68,11 @@ Then, copy the value of Space ID and set it as the value of `CONTENTFUL_SPACE_ID Go back to the API Keys page and click on the Content management tokens tab. -![API Keys page with Content management tokens tab opened](https://i.imgur.com/7nWx1xk.png) +![API Keys page with Content management tokens tab opened](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001394/Medusa%20Docs/Contentful/7nWx1xk_co8ykw.png) Click on Generate personal token. A pop-up will open where you have to enter a name for the token. -![Pop up model for Personal Access Token with token name entered](https://i.imgur.com/y6R81pH.png) +![Pop up model for Personal Access Token with token name entered](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001403/Medusa%20Docs/Contentful/y6R81pH_yhbg1u.png) Once you click Generate, a personal access token will be generated. Use it to set the value of `CONTENTFUL_ACCESS_TOKEN`. @@ -141,7 +141,7 @@ npm run migrate:contentful Once this command finishes executing, in your Contentful Space dashboard click on Content Model in the navigation bar. You should see a list of new content models added. -![Content Model page filled with new content models](https://i.imgur.com/ZDJPNkr.png) +![Content Model page filled with new content models](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001419/Medusa%20Docs/Contentful/ZDJPNkr_avr7gy.png) ### Seed Content to Contentful @@ -155,7 +155,7 @@ npm run seed:contentful After this command finishes running, in your Contentful Space dashboard click on Content in the navigation bar. You should see a list of new content added. -![Content page filled with new content](https://i.imgur.com/bfgFxPg.png) +![Content page filled with new content](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001429/Medusa%20Docs/Contentful/bfgFxPg_jb4zok.png) ### (Optional) Seed Medusa Database @@ -177,7 +177,7 @@ npm run start If you seeded the database with demo data, you should see that events related to the products are triggered. -![Seed the database](https://i.imgur.com/ci4accp.png) +![Seed the database](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001440/Medusa%20Docs/Contentful/ci4accp_okaro3.png) The Contentful integration ensures a two-way sync between the Medusa server and Contentful. So, when new products are added to Medusa, these products will be added to your Contentful Space as well. @@ -195,7 +195,7 @@ To do that, open your Contentful Space Dashboard and click on Content in the Nav Click on the checkbox at the top of the table to select all products then click Publish to publish these products. -![Select all products' checkboxes and click the publish button](https://i.imgur.com/3NrH5tJ.png) +![Select all products' checkboxes and click the publish button](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001452/Medusa%20Docs/Contentful/3NrH5tJ_f16iym.png) ### Added Featured Products @@ -203,19 +203,19 @@ On the homepage of the storefront, there’s a featured products tile that shows To do that, open your Contentful Space Dashboard and click on Content in the Navigation bar. Make sure the select field next to the search bar is set to Any and search for Featured Products. You should find one content of the type Tile Section. -![Search for the featured products tile section](https://i.imgur.com/2gS0ozY.png) +![Search for the featured products tile section](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001462/Medusa%20Docs/Contentful/2gS0ozY_b2tpsb.png) Click on it. You should find on the page an empty Tiles section where you can add tiles and products. -![On the content's page find the empty tiles section](https://i.imgur.com/inuN1OB.png) +![On the content's page find the empty tiles section](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001472/Medusa%20Docs/Contentful/inuN1OB_ipiszl.png) Click on Add content then on Add existing content and pick some of the products you want to show on the homepage. -![Add at least 1 product as a tile](https://i.imgur.com/N5m4LbF.png) +![Add at least 1 product as a tile](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001500/Medusa%20Docs/Contentful/N5m4LbF_fb97tm.png) Once you’re done adding products, click on Publish changes in the right sidebar. -![Click on the publish changes button on the right](https://i.imgur.com/URNpkXq.png) +![Click on the publish changes button on the right](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001508/Medusa%20Docs/Contentful/URNpkXq_cb5ppp.png) ## Setup Gatsby Storefront @@ -250,7 +250,7 @@ To retrieve the value of `CONTENTFUL_ACCESS_TOKEN`, on your Contentful Space das You should find the field "Content Delivery API - access token”. Copy its value and set it as the value of `CONTENTFUL_ACCESS_TOKEN`. -![Copy the value of the Content Delivery API access token](https://i.imgur.com/a7dl7DI.png) +![Copy the value of the Content Delivery API access token](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001522/Medusa%20Docs/Contentful/a7dl7DI_mziogm.png) ### Start Storefront @@ -262,7 +262,7 @@ npm run start This starts the storefront at `localhost:8000`. Open it in your browser and you should see on the homepage the Featured Product section with the products you chose on Contentful. -![The storefront with the featured products section](https://i.imgur.com/f6xwYbS.png) +![The storefront with the featured products section](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001537/Medusa%20Docs/Contentful/f6xwYbS_w1v993.png) ## Make Changes to Content diff --git a/docs/content/add-plugins/mailchimp.md b/docs/content/add-plugins/mailchimp.md index 6ec3dc7c89..87c64ee60c 100644 --- a/docs/content/add-plugins/mailchimp.md +++ b/docs/content/add-plugins/mailchimp.md @@ -80,11 +80,11 @@ Try sending a `POST` request to `/mailchimp/subscribe` with the following JSON b If the subscription is successful, a `200` response code will be returned with `OK` message. -![Postman](https://i.imgur.com/tpr7uCF.png) +![Postman](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000185/Medusa%20Docs/Mailchimp/tpr7uCF_g4rymn.png) If you check your Mailchimp dashboard, you should find the email added to your Audience list. -![Email Added](https://i.imgur.com/ALz6WUq.png) +![Email Added](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000199/Medusa%20Docs/Mailchimp/ALz6WUq_e4mkcs.png) ### With Additional Data @@ -173,7 +173,7 @@ export default function NewsletterForm() { This will result in a subscription form similar to the following: -![Subscription Form](https://i.imgur.com/JHIFEwe.png) +![Subscription Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000210/Medusa%20Docs/Mailchimp/JHIFEwe_fu4rkv.png) If you try entering an email and clicking Subscribe, the email will be subscribed to your Mailchimp newsletter successfully. diff --git a/docs/content/add-plugins/meilisearch.md b/docs/content/add-plugins/meilisearch.md index 8934af9fea..713719b39b 100644 --- a/docs/content/add-plugins/meilisearch.md +++ b/docs/content/add-plugins/meilisearch.md @@ -89,11 +89,11 @@ npm run start The quickest way to test that the integration is working is by sending a `POST` request to `/store/products/search`. This endpoint accepts a `q` body parameter of the query to search for and returns in the result the products that match this query. -![Postman request to search endpoint that shows results returned from the search engine](https://i.imgur.com/RCGquxU.png) +![Postman request to search endpoint that shows results returned from the search engine](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000265/Medusa%20Docs/MeiliSearch/RCGquxU_um3dvn.png) You can also check that the products are properly indexed by opening the MeiliSearch host URL in your browser, which is `http://127.0.0.1:7700/` by default. You’ll find your products that are on your Medusa server added there. -![MeiliSearch dashboard showing products from the Medusa server indexed](https://i.imgur.com/5sk3jyP.png) +![MeiliSearch dashboard showing products from the Medusa server indexed](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000277/Medusa%20Docs/MeiliSearch/5sk3jyP_i3swkn.png) ### Add or Update Products @@ -170,7 +170,7 @@ To make sure the Next.js storefront properly displays the products in the search ::: -![Search Result on Next.js storefront](https://i.imgur.com/gQVWvH2.png) +![Search Result on Next.js storefront](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000298/Medusa%20Docs/MeiliSearch/gQVWvH2_datei5.png) ### Add to Gatsby and React-Based Storefronts @@ -284,7 +284,7 @@ And add the `Search` component in the returned JSX before `RegionPopover`: If you run your Gatsby storefront while the Medusa server and the MeiliSearch instance are running, you should find a search bar in the header of the page. Try entering a query to search through the products in your store. -![Search box in the header of the storefront](https://i.imgur.com/ZkRgF2h.png) +![Search box in the header of the storefront](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000317/Medusa%20Docs/MeiliSearch/ZkRgF2h_ytnpv9.png) ## What’s Next diff --git a/docs/content/add-plugins/minio.md b/docs/content/add-plugins/minio.md index 9ea4af8804..762bfbb3f5 100644 --- a/docs/content/add-plugins/minio.md +++ b/docs/content/add-plugins/minio.md @@ -32,19 +32,19 @@ minio server ~/minio --console-address :9090 --address :9001 After installing MinIO and logging into the Console, click on “Create Bucket” to create a new bucket that will store the files of your Medusa server. -![Create Bucket](https://i.imgur.com/PwLldKt.png) +![Create Bucket](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000345/Medusa%20Docs/MinIO/PwLldKt_vm4r6d.png) Then, in the form, enter a name for the bucket and click on Create Bucket. By MinIO’s requirement, the name can only consist of lower case characters, numbers, dots (`.`), and hyphens (`-`). -![Bucket Info](https://i.imgur.com/UB477rl.png) +![Bucket Info](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000356/Medusa%20Docs/MinIO/UB477rl_opdmzj.png) After creating the bucket, click on the cog icon at the top right to configure the bucket. -![Configure Bucket](https://i.imgur.com/0pB8RIM.png) +![Configure Bucket](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000369/Medusa%20Docs/MinIO/0pB8RIM_bxo20d.png) Then, click on the edit icon next to Access Policy. This will open a pop-up. -![Access Policy](https://i.imgur.com/qo3QQz4.png) +![Access Policy](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000379/Medusa%20Docs/MinIO/qo3QQz4_asdtgb.png) In the pop-up, change the selected value to “public” and click Set. @@ -58,15 +58,15 @@ Changing the Access Policy to public will allow anyone to access your bucket. Av From the sidebar of your MinIO console, click on Identity then Service Accounts. -![Service Accounts Sidebar](https://i.imgur.com/CkTbrEc.png) +![Service Accounts Sidebar](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000392/Medusa%20Docs/MinIO/CkTbrEc_ni2hlz.png) Then, click on Create Service Account. -![Create Service Account](https://i.imgur.com/a000HQf.png) +![Create Service Account](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000403/Medusa%20Docs/MinIO/a000HQf_noszz2.png) This will generate a random Access Key and Secret Key for you. -![Generated Keys](https://i.imgur.com/my4c7zU.png) +![Generated Keys](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000415/Medusa%20Docs/MinIO/my4c7zU_yyw6fw.png) Click on Create. A pop-up will then show the value for your Access Key and Secret Key. Copy them to use in the next section. @@ -119,7 +119,7 @@ If you have multiple storage plugins configured, the last plugin declared in the Run your Medusa server alongside the [Medusa Admin](../admin/quickstart.md) to try out your new file service. Upon editing or creating products, you can now upload thumbnails and images, that are stored in a MinIO server. -![Image Uploaded on Admin](https://i.imgur.com/alabX2i.png) +![Image Uploaded on Admin](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000429/Medusa%20Docs/MinIO/alabX2i_dzg2mh.png) ## Private Buckets diff --git a/docs/content/add-plugins/paypal.md b/docs/content/add-plugins/paypal.md index 3bc9815e54..221c7a9abe 100644 --- a/docs/content/add-plugins/paypal.md +++ b/docs/content/add-plugins/paypal.md @@ -127,7 +127,7 @@ Make sure to replace `` with your PayPal Client ID. Now, if you run your Medusa server and your storefront, on checkout you’ll be able to use PayPal]. -![PayPal Button](https://i.imgur.com/F8OvsOJ.png) +![PayPal Button](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000463/Medusa%20Docs/PayPal/F8OvsOJ_v3ctol.png) You can test out the payment with PayPal using your sandbox account. @@ -276,7 +276,7 @@ That’s all you need to integrate PayPal into the Gatsby storefront. Now, start the Medusa server and the Gatsby storefront server. Try adding an item into the cart and proceeding to checkout. When you reach the payment step, you should see the PayPal button. -![PayPal Button](https://i.imgur.com/SMLrptP.png) +![PayPal Button](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000477/Medusa%20Docs/PayPal/SMLrptP_g6b22m.png) You can test out the payment with PayPal using your sandbox account. @@ -382,13 +382,13 @@ You can then import this component where you want to show it in your storefront. If you run the Medusa server and the storefront server, you should see the PayPal button on checkout. -![PayPal Button](https://i.imgur.com/PsibgPY.png) +![PayPal Button](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000492/Medusa%20Docs/PayPal/PsibgPY_xtqdli.png) ## Capture Payments After the customer places an order, you can see the order on the admin panel. In the payment information under the “Payment” section, you should see a “Capture” button. -![Capture Payment](https://i.imgur.com/Mx357yY.png) +![Capture Payment](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000502/Medusa%20Docs/PayPal/Mx357yY_xsandw.png) Clicking this button lets you capture the payment for an order. You can also refund payments if an order has captured payments. diff --git a/docs/content/add-plugins/s3.md b/docs/content/add-plugins/s3.md index ace40bfceb..4a73480b8e 100644 --- a/docs/content/add-plugins/s3.md +++ b/docs/content/add-plugins/s3.md @@ -22,23 +22,23 @@ You need to [create an AWS account](https://console.aws.amazon.com/console/home? On your AWS Console, search for S3 in the search box at the top. Then, choose the first result you see which should be S3 under the Services category. -![Enter S3 in the search box and choose S3 from the result in the Services category](https://i.imgur.com/wuPTfQ8.png) +![Enter S3 in the search box and choose S3 from the result in the Services category](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000547/Medusa%20Docs/S3/wuPTfQ8_bzbm8n.png) Then, on the new page that opens, click on Create Bucket button at the top right of the Buckets table. -![Click on the Create bucket button](https://i.imgur.com/h95D38T.png) +![Click on the Create bucket button](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000527/Medusa%20Docs/S3/h95D38T_gptwpr.png) The Create Bucket form will open. In the General Configuration section enter a name for the bucket and choose a region for the bucket. Both of the values of these fields are important as you’ll use them throughout the documentation. -![Enter bucket name and choose region in the General Configuration section](https://i.imgur.com/wlxUU8I.png) +![Enter bucket name and choose region in the General Configuration section](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000559/Medusa%20Docs/S3/wlxUU8I_m4ngqd.png) Next, in the Object Ownership section, choose ACLs enabled. Then, two radio buttons will show below it. Choose Bucket owner preferred. -![In the Object Ownership section choose ACLs enabled, then choose Bucket owner preferred for the Object ownership field](https://i.imgur.com/ChUXQPt.png) +![In the Object Ownership section choose ACLs enabled, then choose Bucket owner preferred for the Object ownership field](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000572/Medusa%20Docs/S3/ChUXQPt_eg8mn1.png) Then, in the “Block Public Access settings for this bucket” section, uncheck the “Block all public access” checkbox. This shows a warning message at the bottom of the section with another checkbox. Check the checkbox to ensure you understand that objects in the bucket are publicly accessible. -![Uncheck Block all public access and all fields under it, and check the checkbox field "I acknowledge that the current settings might result in this bucket and the objects within becoming public"](https://i.imgur.com/abHquFh.png) +![Uncheck Block all public access and all fields under it, and check the checkbox field "I acknowledge that the current settings might result in this bucket and the objects within becoming public"](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000586/Medusa%20Docs/S3/abHquFh_wypfbx.png) You can leave the rest of the fields in the form as is and scroll down to the end of the page. Then, click on the Create Bucket button. @@ -46,7 +46,7 @@ You can leave the rest of the fields in the form as is and scroll down to the en On the page of the bucket you just created, click on the Permissions tab. Then, scroll down until you find the Bucket policy section. Click on Edit in that section. -![Find the bucket policy section which should be empty and click on the Edit button](https://i.imgur.com/I6BBLwv.png) +![Find the bucket policy section which should be empty and click on the Edit button](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000607/Medusa%20Docs/S3/I6BBLwv_zoknft.png) In the Edit Bucket Policy page, enter the following in the field: @@ -142,11 +142,11 @@ Then, you can either test the plugin using the [REST APIs](https://docs.medusajs On the Medusa Admin, create a new product and, in the Images section, upload an image then click Save. If the integration was successful, the product image will be uploaded successfully. -![An image is successfully uploaded on the Medusa Admin](https://i.imgur.com/zPC9qFH.png) +![An image is successfully uploaded on the Medusa Admin](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000619/Medusa%20Docs/S3/zPC9qFH_dgqf76.png) You can also check that the image was uploaded on the S3 bucket’s page. -![Image is now available in the S3 Bucket](https://i.imgur.com/NJZ5bP8.png) +![Image is now available in the S3 Bucket](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000630/Medusa%20Docs/S3/NJZ5bP8_ovv9rc.png) ## Next.js Storefront Configuration diff --git a/docs/content/add-plugins/segment.md b/docs/content/add-plugins/segment.md index d734e4e95e..40b231c12c 100644 --- a/docs/content/add-plugins/segment.md +++ b/docs/content/add-plugins/segment.md @@ -52,23 +52,23 @@ You need to [create a Segment account](https://app.segment.com/signup/) to follo On your Segment dashboard, choose Catalog from the sidebar under Connections. -![Under Connections in the sidebar choose Catalog](https://i.imgur.com/rAeJkP3.png) +![Under Connections in the sidebar choose Catalog](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000661/Medusa%20Docs/Segment/rAeJkP3_ybyutz.png) Then, in the catalog list find the Server category and choose Node.js from the list. -![Choose Node.js under the Server category](https://i.imgur.com/6RxQbW6.png) +![Choose Node.js under the Server category](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000672/Medusa%20Docs/Segment/6RxQbW6_wjphte.png) This opens a new side menu. In the side menu, click on Add Source. -![Click on Add Source in the side menu showing information about the Node.js source](https://i.imgur.com/0VZJnpd.png) +![Click on Add Source in the side menu showing information about the Node.js source](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000683/Medusa%20Docs/Segment/0VZJnpd_ehagat.png) This opens a new page to create a Node.js source. Enter the name of the source then click Add Source. -![Enter a name under the Name field then click on the Add Source button](https://i.imgur.com/u2hzkB5.png) +![Enter a name under the Name field then click on the Add Source button](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000693/Medusa%20Docs/Segment/u2hzkB5_t59yhj.png) On the new source dashboard, you should find a Write Key. You’ll use this key in the next section after you install the Segment plugin on your Medusa server. -![The Write Key is available on the new source's page](https://i.imgur.com/OTJVsz7.png) +![The Write Key is available on the new source's page](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000708/Medusa%20Docs/Segment/OTJVsz7_v95qla.png) ### Optional: Add Destination @@ -76,11 +76,11 @@ After you create the Segment source, you can add destinations. This is where the To add a destination, on the same Segment source page, click on Add Destination in the Destinations section. -![Click on the Add Destination button on the source page](https://i.imgur.com/FrKlUxh.png) +![Click on the Add Destination button on the source page](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000718/Medusa%20Docs/Segment/FrKlUxh_zlnkww.png) You can then choose from a list of destinations such as Google Universal Analytics or Facebook Pixel. -![List of some of the available destinations in Segment's catalog](https://i.imgur.com/y2YnPUh.png) +![List of some of the available destinations in Segment's catalog](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000730/Medusa%20Docs/Segment/y2YnPUh_mgfqdo.png) The process of integrating each destination is different, so you must follow the steps detailed in Segment for each destination you choose. @@ -126,7 +126,7 @@ Then, try triggering one of the [mentioned events earlier in this document](#eve After you place an order, on the Segment source that you created, click on the Debugger tab. You should see at least one event triggered for each order you place. If you click on the event, you can see the order details are passed to the event. -![The order completed event is recorded on the Segment source](https://i.imgur.com/LQVJTGg.png) +![The order completed event is recorded on the Segment source](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000743/Medusa%20Docs/Segment/LQVJTGg_i5jyge.png) If you added a destination, you can also check your destination to make sure the data is reflected there. @@ -183,7 +183,7 @@ The `SegmentServer` also provides the method `identify` to tie a user to their a After adding the above subscriber, run your server again if it isn’t running and create a customer using the REST APIs or one of the Medusa storefronts. If you check the Debugger in your Segment source, you should see a new event “Customer Created” tracked. If you click on it, you’ll see the data you passed to the `track` method. -![The customer created event is recoreded on the Segment source](https://i.imgur.com/4LD41xE.png) +![The customer created event is recoreded on the Segment source](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000759/Medusa%20Docs/Segment/4LD41xE_qungdw.png) ## What’s Next diff --git a/docs/content/add-plugins/sendgrid.mdx b/docs/content/add-plugins/sendgrid.mdx index 4c84b33007..ba252dc2ab 100644 --- a/docs/content/add-plugins/sendgrid.mdx +++ b/docs/content/add-plugins/sendgrid.mdx @@ -3959,7 +3959,7 @@ If you don’t have a storefront installed, check out the [Gatsby](../starters/g You can also track analytics related to emails sent from the SendGrid dashboard. -![SendGrid Analytics](https://i.imgur.com/X01LigH.png) +![SendGrid Analytics](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000788/Medusa%20Docs/SendGrid/X01LigH_mxmtbn.png) ## What’s Next diff --git a/docs/content/add-plugins/slack.md b/docs/content/add-plugins/slack.md index a6833de6df..e07c41fbf4 100644 --- a/docs/content/add-plugins/slack.md +++ b/docs/content/add-plugins/slack.md @@ -41,7 +41,7 @@ The first step is to create a Slack app. This app will be connected to your work Go to [Slack API](https://api.slack.com/) and click Create app. This will take you to a new page with a pop-up. In the pop-up, choose From scratch. -![Create Slack App](https://i.imgur.com/liVfwF8.png) +![Create Slack App](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000844/Medusa%20Docs/Slack/liVfwF8_ryzly3.png) You’ll then need to enter some info like the App name and the workspace it will be connected to. Once you’re done, the app will be created. @@ -49,17 +49,17 @@ You’ll then need to enter some info like the App name and the workspace it wil To activate Incoming Webhooks, choose Features > Incoming Webhooks from the sidebar. At first, it will be disabled so make sure to enable it by switching the toggle. -![Incoming Webhooks](https://i.imgur.com/5Y0nv4p.png) +![Incoming Webhooks](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000856/Medusa%20Docs/Slack/5Y0nv4p_mugzkb.png) ### Add New Webhook After activating Incoming Webhooks, on the same page scroll down and click on the Add New Webhook to Workspace button. -![Add New Webhook](https://i.imgur.com/sejdIqH.png) +![Add New Webhook](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000867/Medusa%20Docs/Slack/sejdIqH_wyqgs5.png) After that, choose the channel to send the notifications to. You can also choose a DM to send the notifications to. Once you’re done click Allow. -![Choose channel or DM](https://i.imgur.com/Zw3f5uF.png) +![Choose channel or DM](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000882/Medusa%20Docs/Slack/Zw3f5uF_hljfpr.png) This will create a new Webhook with a URL which you can see in the table at the end of the Incoming Webhooks page. Copy the URL as you’ll use it in the next section. diff --git a/docs/content/add-plugins/spaces.md b/docs/content/add-plugins/spaces.md index 1962c2605f..946633c830 100644 --- a/docs/content/add-plugins/spaces.md +++ b/docs/content/add-plugins/spaces.md @@ -28,15 +28,15 @@ You need to [create a DigitalOcean account](https://cloud.digitalocean.com/regi In your DigitalOcean account, click on the Create button at the top right, then choose Spaces from the dropdown. -![Click on the green Create button at the top right, then choose Spaces in the dropdown](https://i.imgur.com/AQqMRoJ.png) +![Click on the green Create button at the top right, then choose Spaces in the dropdown](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000907/Medusa%20Docs/Spaces/AQqMRoJ_uhkywh.png) In the Create a Space form, you can choose any of the regions listed. You can alternatively leave all settings as they are and scroll down to the Finalize and Create section. -![The Space form can be left as is and move towards the Finalize and Create section](https://i.imgur.com/ipsIqoA.png) +![The Space form can be left as is and move towards the Finalize and Create section](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000929/Medusa%20Docs/Spaces/ipsIqoA_zeyfkf.png) In the Finalize and Create section, enter a name for the field “Choose a unique name”. You’ll use this name later in the integration with Medusa. Also, select the project you want to add the new Space to. -![Enter a name for the Space in the Choose a unique name field](https://i.imgur.com/NhlRX0h.png) +![Enter a name for the Space in the Choose a unique name field](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000949/Medusa%20Docs/Spaces/NhlRX0h_ptdhpk.png) Once you’re done, click on the Create a Space button. This creates the Space and redirects you to the Space’s page. @@ -44,15 +44,15 @@ Once you’re done, click on the Create a Space button. This creates the Space a Choose API from the bottom of the sidebar. -![Choose API from the bottom of the sidebar.](https://i.imgur.com/6zNoDOW.png) +![Choose API from the bottom of the sidebar.](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000964/Medusa%20Docs/Spaces/6zNoDOW_tqbeqv.png) This opens the Application & API page. Scroll down to Spaces Access Keys and click the Generate New Key button. -![In the Spaces access keys section, click the Generate New Key button](https://i.imgur.com/NUocdgh.png) +![In the Spaces access keys section, click the Generate New Key button](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000977/Medusa%20Docs/Spaces/NUocdgh_doi0dq.png) This shows a table with the Name field editable. Enter a name for the Access Keys and click on the checkmark button to save and generate the Spaces access keys. -![Enter a name for the Space access key in the field under the Name column](https://i.imgur.com/ihJBx0T.png) +![Enter a name for the Space access key in the field under the Name column](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000987/Medusa%20Docs/Spaces/ihJBx0T_xfe4rh.png) Then, two keys will be available under the Key column of the table. The first one is the Access Key ID and the second is the Secret Access Key. Copy both as you’ll use them later. @@ -84,12 +84,12 @@ Where: 1. `` is the URL of your Space which you can find on the Space’s page below the Space’s name. -![The URL is available under the Space's name on the Space's page](https://i.imgur.com/cA3vkvh.png) +![The URL is available under the Space's name on the Space's page](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001004/Medusa%20Docs/Spaces/cA3vkvh_maixr0.png) 2. `` is the name of your Space. 3. `` is your Space’s endpoint which can be found by going to your Space’s page, clicking on the Settings tab, and scrolling to the Endpoint section. -![Endpoint can be found on the Settings tab in the Space's page](https://i.imgur.com/CnvLr6R.png) +![Endpoint can be found on the Settings tab in the Space's page](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001017/Medusa%20Docs/Spaces/CnvLr6R_tudlhu.png) 4. `` and `` are the keys you created in the previous section. @@ -129,11 +129,11 @@ Then, you can either test the plugin using the [REST APIs](https://docs.medusaj On the Medusa Admin, create a new product and, in the Images section, upload an image then click Save. If the integration was successful, the product image will be uploaded successfully. -![Image successfully uploaded on Medusa's admin](https://i.imgur.com/oTi4jIw.png) +![Image successfully uploaded on Medusa's admin](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001039/Medusa%20Docs/Spaces/oTi4jIw_c6vefa.png) You can also check that the image was uploaded on the Space’s page. -![Image can be seen on the Space's page on DigitalOcean](https://i.imgur.com/BexmRkg.png) +![Image can be seen on the Space's page on DigitalOcean](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001050/Medusa%20Docs/Spaces/BexmRkg_gimk1d.png) ## Next.js Storefront Configuration diff --git a/docs/content/add-plugins/strapi.md b/docs/content/add-plugins/strapi.md index 1d40c3f563..642bc56d51 100644 --- a/docs/content/add-plugins/strapi.md +++ b/docs/content/add-plugins/strapi.md @@ -36,7 +36,7 @@ This creates the Strapi project in the directory `strapi-medusa`. Once the installation is finished, the Strapi development server will run on `localhost:1337`. A new page will also open in your default browser to create a new admin user and log in. -![Create User Form in Strapi](https://i.imgur.com/9pFE1Ij.png) +![Create User Form in Strapi](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001083/Medusa%20Docs/Strapi/9pFE1Ij_h2dicv.png) Once you log in, you can access the Strapi dashboard. @@ -44,11 +44,11 @@ Once you log in, you can access the Strapi dashboard. The Strapi plugin in Medusa requires the credentials of a Strapi user. To create a new user, go to Content Manager, then choose User under Collection Types. -![Showing the users under Content Manager](https://i.imgur.com/YyGJPUf.png) +![Showing the users under Content Manager](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001096/Medusa%20Docs/Strapi/YyGJPUf_mr5sx7.png) Click on the Create new entry button at the top right. This opens a new form to enter the user’s details. -![Create User Form on Strapi](https://i.imgur.com/mdMhSlV.png) +![Create User Form on Strapi](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001105/Medusa%20Docs/Strapi/mdMhSlV_vy7ygv.png) Enter the user’s username, email, and password. Once you’re done, click on the Save button at the top right. @@ -58,7 +58,7 @@ By default, created users have the “Authenticated” role. Before you start us On your Strapi dashboard, go to Settings → Roles → Authenticated. Then, under the Permissions section, expand the accordion of each content model type and check the Select All checkbox. -![An example of modifying permissions on the Product content type](https://i.imgur.com/QgckXqS.png) +![An example of modifying permissions on the Product content type](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001116/Medusa%20Docs/Strapi/QgckXqS_wlyxe8.png) Once you’re done, click the Save button at the top right. diff --git a/docs/content/add-plugins/stripe.md b/docs/content/add-plugins/stripe.md index 2f9dcde41c..98bb868ba1 100644 --- a/docs/content/add-plugins/stripe.md +++ b/docs/content/add-plugins/stripe.md @@ -131,7 +131,7 @@ Make sure to replace `` with your Stripe Publishable Key. Now, if you run your Medusa server and your storefront, on checkout you’ll be able to use Stripe. -![Next.js Stripe Form](https://i.imgur.com/h5mWdJT.png) +![Next.js Stripe Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001145/Medusa%20Docs/Stripe/h5mWdJT_n1bktt.png) ### Add to Gatsby Storefront @@ -151,7 +151,7 @@ You might find this environment variable already available so you can just repla Now, if you run your Medusa server and your storefront, on checkout you’ll be able to use Stripe. -![Gatsby Stripe Form](https://i.imgur.com/1XvW776.png) +![Gatsby Stripe Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001172/Medusa%20Docs/Stripe/1XvW776_omosuz.png) ### Add to Custom Storefront @@ -344,13 +344,13 @@ Once the promise resolves you can handle the errors, if there are any. If not, y If you run your server and storefront now, you’ll see the Stripe UI element and you’ll be able to make orders. -![Stripe Form](https://i.imgur.com/NOi8THw.png) +![Stripe Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001190/Medusa%20Docs/Stripe/NOi8THw_xv3zsx.png) ## Capture Payments After the customer places an order, you’ll be able to see the order on the admin panel. In the payment information under the “Payment” section, you should see a “Capture” button. -![Capture Payment](https://i.imgur.com/Iz55PVZ.png) +![Capture Payment](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001205/Medusa%20Docs/Stripe/Iz55PVZ_p6hiz6.png) Clicking this button allows you to capture the payment for an order. You can also refund payments if an order has captured payments. diff --git a/docs/content/add-plugins/twilio-sms.md b/docs/content/add-plugins/twilio-sms.md index 128f604cd1..0d0f686890 100644 --- a/docs/content/add-plugins/twilio-sms.md +++ b/docs/content/add-plugins/twilio-sms.md @@ -120,7 +120,7 @@ If you’re on a Twilio trial make sure that the phone number you entered on che ::: -![Twilio Dashboard](https://i.imgur.com/MXtQMiL.png) +![Twilio Dashboard](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001219/Medusa%20Docs/Stripe/MXtQMiL_kb7kxe.png) ## What’s Next diff --git a/docs/content/admin/quickstart.md b/docs/content/admin/quickstart.md index 04121bb9aa..bd1828d4ac 100644 --- a/docs/content/admin/quickstart.md +++ b/docs/content/admin/quickstart.md @@ -57,7 +57,7 @@ npm run start By default, the admin runs on port 7000. So, in your browser, go to `localhost:7000` to view your admin. -![Admin Log In](https://i.imgur.com/XYqMCo9.png) +![Admin Log In](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001604/Medusa%20Docs/Screenshots/XYqMCo9_hq1fsv.png) Use your Medusa admin’s user credentials to log in. diff --git a/docs/content/advanced/backend/batch-jobs/index.md b/docs/content/advanced/backend/batch-jobs/index.md index bab3b9fb98..c2e4122684 100644 --- a/docs/content/advanced/backend/batch-jobs/index.md +++ b/docs/content/advanced/backend/batch-jobs/index.md @@ -54,7 +54,7 @@ If the batch job fails at any point in this flow, its status is changed to `fail ::: -![Flowchart summarizing the batch job's flow from creation to completion](https://i.imgur.com/Qja0kAz.png) +![Flowchart summarizing the batch job's flow from creation to completion](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001632/Medusa%20Docs/Diagrams/Qja0kAz_ns4vm8.png) ## What’s Next diff --git a/docs/content/advanced/backend/notification/how-to-create-notification-provider.md b/docs/content/advanced/backend/notification/how-to-create-notification-provider.md index e86c8683ac..fec5c942b0 100644 --- a/docs/content/advanced/backend/notification/how-to-create-notification-provider.md +++ b/docs/content/advanced/backend/notification/how-to-create-notification-provider.md @@ -267,11 +267,11 @@ You must be authenticated as an admin user before sending this request. You can ::: -![List Notifications Request](https://i.imgur.com/iF1rZX1.png) +![List Notifications Request](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001650/Medusa%20Docs/Screenshots/iF1rZX1_msps2t.png) Then, send a request to the [Resend Notification](https://docs.medusajs.com/api/admin/#tag/Notification/operation/PostNotificationsNotificationResend) endpoint using the ID retrieved from the previous request. You can pass the `to` parameter in the body to change the receiver of the notification. You should see the message “Notification Resent” in your console and if you implemented your own logic for resending the notification it will be resent. -![Resend Notifications Request](https://i.imgur.com/0zFfPed.png) +![Resend Notifications Request](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001659/Medusa%20Docs/Screenshots/0zFfPed_og7one.png) This request returns the same notification object as the List Notifications endpoint, but it now has a new object in the `resends` array. This is the resent notification. If you supplied a `to` parameter in the request body, you should see its value in the `to` property of the resent notification object. diff --git a/docs/content/advanced/backend/payment/how-to-create-payment-provider.md b/docs/content/advanced/backend/payment/how-to-create-payment-provider.md index 59986d9098..f47c33d58e 100644 --- a/docs/content/advanced/backend/payment/how-to-create-payment-provider.md +++ b/docs/content/advanced/backend/payment/how-to-create-payment-provider.md @@ -40,7 +40,7 @@ All these methods must be declared async in the Payment Provider Service. These methods are used at different points in the Checkout flow as well as when processing the order after it’s placed. -![Payment Flows.jpg](https://i.imgur.com/WeDr0ph.jpg) +![Checkout Flow - Payment](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001750/Medusa%20Docs/Diagrams/WeDr0ph_idcrir.jpg) ## Create a Payment Provider diff --git a/docs/content/advanced/backend/shipping/overview.md b/docs/content/advanced/backend/shipping/overview.md index b591392359..c14919ef26 100644 --- a/docs/content/advanced/backend/shipping/overview.md +++ b/docs/content/advanced/backend/shipping/overview.md @@ -17,7 +17,7 @@ It’s also constructed to support multiple regions, provide different shipment - **Shipping Options:** created by the admin and belong to a shipping profile. They are specific to certain regions and can have cart conditions. They use an underlying fulfillment provider. Once a customer checks out, they can choose the shipping option that’s available and most relevant to them. - **Shipping Method:** created when the customer chooses a shipping option on checkout. The shipping method is basically a copy of the shipping option, but with values specific to the customer and the cart it’s associated with. When the order is placed, the shipping method will then be associated with the order and fulfilled based on the integration with the fulfillment provider. -![Shipping Architecture](https://i.imgur.com/QII2Hvn.png) +![Shipping Architecture](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001762/Medusa%20Docs/Diagrams/QII2Hvn_vjkrdy.png) ## Fulfillment Provider diff --git a/docs/content/deployments/admin/deploying-on-netlify.md b/docs/content/deployments/admin/deploying-on-netlify.md index 2b0e7c3dc8..c5c6e90dc9 100644 --- a/docs/content/deployments/admin/deploying-on-netlify.md +++ b/docs/content/deployments/admin/deploying-on-netlify.md @@ -41,11 +41,11 @@ Before you can deploy your Medusa Admin you need to create a GitHub repository a On GitHub, click the plus icon at the top right, then click New Repository. -![Create Repository](https://i.imgur.com/0YlxBRi.png) +![Create Repository](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001782/Medusa%20Docs/Netlify/0YlxBRi_aiywpo.png) You’ll then be redirected to a new page with a form. In the form, enter the Repository Name then scroll down and click Create repository. -![Repository Form](https://i.imgur.com/YPYXAF2.png) +![Repository Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001800/Medusa%20Docs/Netlify/YPYXAF2_lypjne.png) ### Push Code to GitHub Repository @@ -53,7 +53,7 @@ The next step is to push the code to the GitHub repository you just created. After creating the repository, you’ll be redirected to the repository’s page. On that page, you should see a URL that you can copy to connect your repository to a local directory. -![GitHub Repository URL](https://i.imgur.com/pHfSTuT.png) +![GitHub Repository URL](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001818/Medusa%20Docs/Netlify/pHfSTuT_w544lr.png) Copy the link. Then, open your terminal in the directory that holds your Medusa Admin codebase and run the following commands: @@ -88,21 +88,21 @@ Alternatively, if you don’t have any other websites, you’ll see a big button ::: -![Create a new website](https://i.imgur.com/IUUOzoW.png) +![Create a new website](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001840/Medusa%20Docs/Netlify/IUUOzoW_mw9u5w.png) You’ll then be asked to connect to a Git provider. -![Connect Git Provider](https://i.imgur.com/T6lZPDi.png) +![Connect Git Provider](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001855/Medusa%20Docs/Netlify/T6lZPDi_rvcuyf.png) Choose GitHub. You’ll then be redirected to GitHub’s website to give Netlify permissions if you haven’t done that before. After you authorize Netlify to use GitHub, you’ll be asked to pick the repository you want to deploy. Pick the repository you just created. -![Choose Repository](https://i.imgur.com/D0r6Q1e.png) +![Choose Repository](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001871/Medusa%20Docs/Netlify/D0r6Q1e_th5uei.png) In the form that shows, keep all fields the same and click on the “Show advanced” button before the “Deploy site” button. -![Show advanced Button](https://i.imgur.com/nUdwRbq.png) +![Show advanced Button](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001884/Medusa%20Docs/Netlify/nUdwRbq_d2kmo6.png) Under the “Advanced build settings” section click on the “New variable” button. This will show two inputs for the key and value of the environment variable. @@ -114,23 +114,23 @@ If you haven’t deployed your Medusa server yet, you can leave the value blank ::: -![Environment Variable](https://i.imgur.com/DnutZfT.png) +![Environment Variable](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001898/Medusa%20Docs/Netlify/DnutZfT_rv8iel.png) Once you’re done, scroll down and click on Deploy site. You’ll be then redirected to the dashboard of the new website. Netlify will build your website in the background. You should see “Site deploy in progress” on the top card. -![Site Deployment Progress](https://i.imgur.com/BCnLPw7.png) +![Site Deployment Progress](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001914/Medusa%20Docs/Netlify/BCnLPw7_uo9odf.png) The deployment can take a few minutes. Once the deployment is done, you’ll find the URL in the place of the “Site deploy in progress” message you saw earlier. -![Deployment Complete](https://i.imgur.com/fNBxCG2.png) +![Deployment Complete](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001929/Medusa%20Docs/Netlify/fNBxCG2_jlq0q9.png) If you click on it, you’ll be redirected to the deployed admin website. -![Medusa Admin Login](https://i.imgur.com/6t4ODe4.png) +![Medusa Admin Login](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001604/Medusa%20Docs/Screenshots/XYqMCo9_hq1fsv.png) :::note @@ -160,11 +160,11 @@ netlify login This opens a page to log in on your browser. You’ll be asked to authorize the Netlify CLI tool. -![Authorize Application](https://i.imgur.com/JDUdqSE.png) +![Authorize Application](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001985/Medusa%20Docs/Netlify/JDUdqSE_dzveww.png) Click on Authorize. Then, you can go back to your terminal and see that you’ve successfully logged in. -![Authorized Message](https://i.imgur.com/L13Yqhp.png) +![Authorized Message](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001998/Medusa%20Docs/Netlify/L13Yqhp_e2ejpx.png) #### Initialize Netlify Website @@ -251,7 +251,7 @@ netlify open:site The Medusa Admin will then open in your browser. -![Medusa Admin Login](https://i.imgur.com/6t4ODe4.png) +![Medusa Admin Login](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001604/Medusa%20Docs/Screenshots/XYqMCo9_hq1fsv.png) Before you can use Medusa Admin, you must add the URL as an environment variable on your deployed Medusa server. diff --git a/docs/content/deployments/server/deploying-on-digital-ocean.md b/docs/content/deployments/server/deploying-on-digital-ocean.md index c584cc42a9..617449359f 100644 --- a/docs/content/deployments/server/deploying-on-digital-ocean.md +++ b/docs/content/deployments/server/deploying-on-digital-ocean.md @@ -74,11 +74,11 @@ Before you can deploy your Medusa server you need to create a GitHub repository On GitHub, click the plus icon at the top right, then click New Repository. -![Click plus then choose new repository from dropdown](https://i.imgur.com/0YlxBRi.png) +![Click plus then choose new repository from dropdown](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001782/Medusa%20Docs/Netlify/0YlxBRi_aiywpo.png) You’ll then be redirected to a new page with a form. In the form, enter the Repository Name then scroll down and click Create repository. -![New repository form](https://i.imgur.com/YPYXAF2.png) +![New repository form](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001800/Medusa%20Docs/Netlify/YPYXAF2_lypjne.png) ### Push Code to GitHub Repository @@ -86,7 +86,7 @@ The next step is to push the code to the GitHub repository you just created. After creating the repository, you’ll be redirected to the repository’s page. On that page, you should see a URL that you can copy to connect your repository to a local directory. -![GitHub repository's URL](https://i.imgur.com/pHfSTuT.png) +![GitHub repository's URL](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001818/Medusa%20Docs/Netlify/pHfSTuT_w544lr.png) Copy the link. Then, open your terminal in the directory that holds your Medusa server codebase and run the following commands: @@ -111,13 +111,13 @@ After pushing the changes, you can find the files in your GitHub repository. After logging into your account, click on the Create button at the top right, then choose App. -![Click Create button then choose Apps](https://i.imgur.com/PQgPZ0q.png) +![Click Create button then choose Apps](https://res.cloudinary.com/dza7lstvk/image/upload/v1668002030/Medusa%20Docs/Digital%20Ocean/PQgPZ0q_xntr2i.png) ### Choose Repository In the Create App page, choose GitHub from the Service Provider list. -![Choose GitHub from list of providers](https://i.imgur.com/nBY9wGE.png) +![Choose GitHub from list of providers](https://res.cloudinary.com/dza7lstvk/image/upload/v1668002043/Medusa%20Docs/Digital%20Ocean/nBY9wGE_zyy1e6.png) If you haven’t given DigitalOcean access before, click on Manage Access under Source Code. You’ll then be redirected to GitHub to give DigitalOcean access. @@ -125,7 +125,7 @@ Once DigitalOcean have access to your GitHub account, you should see a Repositor Additional inputs will show up to choose the Branch, Source Directory, and Autodeploy options. -![Enter master for Branch input, backslash for Source Directory, and check Autodeploy](https://i.imgur.com/kjk9E2B.png) +![Enter master for Branch input, backslash for Source Directory, and check Autodeploy](https://res.cloudinary.com/dza7lstvk/image/upload/v1668002055/Medusa%20Docs/Digital%20Ocean/kjk9E2B_qpwrx4.png) If you host your Medusa server in a monorepo, you should change the Source Directory to the directory the server is available in the repository. Otherwise, it can be left as is. @@ -135,7 +135,7 @@ Once you’re done, click Next to move on to the next step. In the next step, you’ll see the resources to create. -![List of resources showing a docker resource and web service resource](https://i.imgur.com/6TlpWB9.png) +![List of resources showing a docker resource and web service resource](https://res.cloudinary.com/dza7lstvk/image/upload/v1668002067/Medusa%20Docs/Digital%20Ocean/6TlpWB9_wfppc7.png) If you have a Dockerfile available in the server’s codebase (which is available by default), you’ll have two resources showing. You can remove it by clicking on the trash icon at the right of the resource. @@ -143,7 +143,7 @@ By default, DigitalOcean hosts the web service in a sub-path of the domain name Then, scroll to HTTP Request Routes and expand it by clicking on Edit at its right. Change the value of the Routes input to `/`. -![Enter backslash for Routes](https://i.imgur.com/ta0jHh4.png) +![Enter backslash for Routes](https://res.cloudinary.com/dza7lstvk/image/upload/v1668002076/Medusa%20Docs/Digital%20Ocean/ta0jHh4_ddcz3r.png) Once you’re done click Save. You’ll be taken back to the Resources page. @@ -151,15 +151,15 @@ Once you’re done click Save. You’ll be taken back to the Resources page. On the same page, expand the Add Resources section, choose Database, then click Add. -![Choose Database](https://i.imgur.com/MfK9E8o.png) +![Choose Database](https://res.cloudinary.com/dza7lstvk/image/upload/v1668002090/Medusa%20Docs/Digital%20Ocean/MfK9E8o_ensfu0.png) In the new page, you’ll be shown a PostgreSQL database to be created. Notice that it’s important to choose a name that you’ll remember as you’ll need the name in next steps. You can leave the name as is if it’s not necessary to change it. -![Enter db for Choose Name input](https://i.imgur.com/jYxENhr.png) +![Enter db for Choose Name input](https://res.cloudinary.com/dza7lstvk/image/upload/v1668002099/Medusa%20Docs/Digital%20Ocean/jYxENhr_wxkspz.png) Once you’re done, click Create and Attach. You’ll be redirected back to the previous page with the database added to the resources. -![Database showing in the list of resources with web service](https://i.imgur.com/jNZ7rxg.png) +![Database showing in the list of resources with web service](https://res.cloudinary.com/dza7lstvk/image/upload/v1668002109/Medusa%20Docs/Digital%20Ocean/jNZ7rxg_msmgbz.png) Once you’re done, click Next to move on to the next step. @@ -169,7 +169,7 @@ In this section, you’ll add environment variables that are essential to your M You should see two ways to add environment variables: Global or specific to the Web Service. -![Global environment variables and web service environment variables](https://i.imgur.com/VOYykPT.png) +![Global environment variables and web service environment variables](https://res.cloudinary.com/dza7lstvk/image/upload/v1668002118/Medusa%20Docs/Digital%20Ocean/VOYykPT_qoili6.png) Click Edit on the second row to add environment variables specific to the Web Service. Add the following environment variables: @@ -202,7 +202,7 @@ Once you’re done click Save. In the next section, you’ll be shown the app info and the region it will be deployed to. You can leave it all as is or make changes if you find it necessary. -![App info and region details](https://i.imgur.com/XVS0yej.png) +![App info and region details](https://res.cloudinary.com/dza7lstvk/image/upload/v1668002128/Medusa%20Docs/Digital%20Ocean/XVS0yej_kwmaim.png) Once you’re done, click Next to go to the next step. @@ -214,15 +214,15 @@ While the server is being deployed, you can create the Redis resource. Click the Create button at the top right and choose Database from the dropdown. -![Click Create then choose Databases](https://i.imgur.com/8BzUzuO.png) +![Click Create then choose Databases](https://res.cloudinary.com/dza7lstvk/image/upload/v1668002138/Medusa%20Docs/Digital%20Ocean/8BzUzuO_bhwcpd.png) In the new page under Choose a database engine, choose Redis. -![For the Choose a database engine input choose Redis](https://i.imgur.com/lninWzJ.png) +![For the Choose a database engine input choose Redis](https://res.cloudinary.com/dza7lstvk/image/upload/v1668002149/Medusa%20Docs/Digital%20Ocean/lninWzJ_joycrd.png) Then, scroll down to the “Choose a name” input. Since you used the name `redis` in the `REDIS_URL` environment variables, change the value to `redis` here. -![For the choose a name input set the value to redis](https://i.imgur.com/E81Qc4l.png) +![For the choose a name input set the value to redis](https://res.cloudinary.com/dza7lstvk/image/upload/v1668002158/Medusa%20Docs/Digital%20Ocean/E81Qc4l_gid9qa.png) Once you’re done, click on Create Database Cluster. @@ -232,11 +232,11 @@ Once the Redis database is created go back to the App you created earlier by cho Click at the white Create button at the top right and choose Create/Attach Database. -![Click at the create button and choose create/attach database](https://i.imgur.com/jdh702G.png) +![Click at the create button and choose create/attach database](https://res.cloudinary.com/dza7lstvk/image/upload/v1668002168/Medusa%20Docs/Digital%20Ocean/jdh702G_fjssat.png) In the new page, click on the Previously Created DigitalOcean Database radio button. Then, under Database Cluster select the Redis database you just created. -![Choose Previously Created DigitalOcean Database then under Database Cluster choose redis](https://i.imgur.com/aBJ2z0B.png) +![Choose Previously Created DigitalOcean Database then under Database Cluster choose redis](https://res.cloudinary.com/dza7lstvk/image/upload/v1668002177/Medusa%20Docs/Digital%20Ocean/aBJ2z0B_yzwpym.png) Once you’re done click Attach Database. This will add the Redis database to the list of resources of your App and will trigger a redeploy of the App. @@ -244,11 +244,11 @@ Once you’re done click Attach Database. This will add the Redis database to th Once the redeployment is complete, copy the URL of the App which can be found under the App’s name. -![Copy URL under the app name](https://i.imgur.com/i3ws777.png) +![Copy URL under the app name](https://res.cloudinary.com/dza7lstvk/image/upload/v1668002186/Medusa%20Docs/Digital%20Ocean/i3ws777_ooknst.png) Then, go to `/store/products`. If the deployment was successful, you should receive a JSON response. -![JSON response with list of products](https://i.imgur.com/5xTdMbY.png) +![JSON response with list of products](https://res.cloudinary.com/dza7lstvk/image/upload/v1668002196/Medusa%20Docs/Digital%20Ocean/5xTdMbY_pqwyzy.png) ## Run Commands on Your Server @@ -263,7 +263,7 @@ medusa user --email --password Make sure to replace `` and `` with the credentials you want to give the user. -![Console in the DigitalOcean App](https://i.imgur.com/9RMfD4C.png) +![Console in the DigitalOcean App](https://res.cloudinary.com/dza7lstvk/image/upload/v1668002204/Medusa%20Docs/Digital%20Ocean/9RMfD4C_u0mdqs.png) ## Add Environment Variables @@ -271,11 +271,11 @@ You’ll likely need to add environment variables later such as Admin Cross-Orig To add environment variables, on the App’s page click on Settings and choose the Web Service component. -![Choose the Settings tab then choose the web service container](https://i.imgur.com/qLPARaV.png) +![Choose the Settings tab then choose the web service container](https://res.cloudinary.com/dza7lstvk/image/upload/v1668002217/Medusa%20Docs/Digital%20Ocean/qLPARaV_ocit6w.png) Then, scroll down and find Environment Variables. You can expand the environment variables by clicking Edit on the right. Here, you can edit, add, and remove environment variables. -![Expand the Environment Variables section by clicking edit](https://i.imgur.com/4x6JGjX.png) +![Expand the Environment Variables section by clicking edit](https://res.cloudinary.com/dza7lstvk/image/upload/v1668002227/Medusa%20Docs/Digital%20Ocean/4x6JGjX_wzltiq.png) Once you click Save, the environment variables will be saved and a redeployment will be triggered. diff --git a/docs/content/deployments/server/deploying-on-qovery.md b/docs/content/deployments/server/deploying-on-qovery.md index 058f1045ff..1f2147459e 100644 --- a/docs/content/deployments/server/deploying-on-qovery.md +++ b/docs/content/deployments/server/deploying-on-qovery.md @@ -48,11 +48,11 @@ Before you can deploy your Medusa server you need to create a GitHub repository On GitHub, click the plus icon at the top right, then click New Repository. -![Click plus icon at the top right](https://i.imgur.com/0YlxBRi.png) +![Click plus icon at the top right](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001782/Medusa%20Docs/Netlify/0YlxBRi_aiywpo.png) You’ll then be redirected to a new page with a form. In the form, enter the Repository Name then scroll down and click Create repository. -![An image of the Create Repository form](https://i.imgur.com/YPYXAF2.png) +![An image of the Create Repository form](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001800/Medusa%20Docs/Netlify/YPYXAF2_lypjne.png) ### Push Code to GitHub Repository @@ -60,7 +60,7 @@ The next step is to push the code to the GitHub repository you just created. After creating the repository, you’ll be redirected to the repository’s page. On that page, you should see a URL that you can copy to connect your repository to a local directory. -![An image of the GitHub URL in a new repository](https://i.imgur.com/pHfSTuT.png) +![An image of the GitHub URL in a new repository](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001818/Medusa%20Docs/Netlify/pHfSTuT_w544lr.png) Copy the link. Then, open your terminal in the directory that holds your Medusa server codebase and run the following commands: @@ -477,7 +477,7 @@ If you run into any errors while running this command, you can just re-run it af Once the command finishes and the deployment is successful, you can access your server in the [Qovery Console](https://console.qovery.com/). Go to the project, environment, then the app that you created using Terraform and Qovery. In the app, click the Open button at the top right to open your website in a new tab. -![open button at the top right](https://i.imgur.com/Ji59ZSJ.png) +![open button at the top right](https://res.cloudinary.com/dza7lstvk/image/upload/v1668002245/Medusa%20Docs/Qovery/Ji59ZSJ_nrkpvb.png) You can access any of the endpoints on your server using the server URL. For example, you can get the list of products using the endpoint `/store/products`. @@ -504,7 +504,7 @@ You’ll likely need to add environment variables later such as Admin Cross-Orig To add environment variables, in your [Qovery Console](https://console.qovery.com/) go to the Medusa app and choose Environment Variables from the sidebar. You can add environment variables here at any point later on. -![Environment Variables in the sidebar](https://i.imgur.com/aQl7zdz.png) +![Environment Variables in the sidebar](https://res.cloudinary.com/dza7lstvk/image/upload/v1668002258/Medusa%20Docs/Qovery/aQl7zdz_tjs0eb.png) ## What’s Next diff --git a/docs/content/deployments/storefront/deploying-gatsby-on-netlify.md b/docs/content/deployments/storefront/deploying-gatsby-on-netlify.md index 2f22246b2e..9485b3cf86 100644 --- a/docs/content/deployments/storefront/deploying-gatsby-on-netlify.md +++ b/docs/content/deployments/storefront/deploying-gatsby-on-netlify.md @@ -41,11 +41,11 @@ Before you can deploy your Gatsby storefront you need to create a GitHub reposit On GitHub, click the plus icon at the top right, then click New Repository. -![Create Repository](https://i.imgur.com/0YlxBRi.png) +![Create Repository](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001782/Medusa%20Docs/Netlify/0YlxBRi_aiywpo.png) You’ll then be redirected to a new page with a form. In the form, enter the Repository Name then scroll down and click Create repository. -![Repository Form](https://i.imgur.com/YPYXAF2.png) +![Repository Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001800/Medusa%20Docs/Netlify/YPYXAF2_lypjne.png) ### Push Code to GitHub Repository @@ -53,7 +53,7 @@ The next step is to push the code to the GitHub repository you just created. After creating the repository, you’ll be redirected to the repository’s page. On that page, you should see a URL that you can copy to connect your repository to a local directory. -![GitHub Repository URL](https://i.imgur.com/pHfSTuT.png) +![GitHub Repository URL](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001818/Medusa%20Docs/Netlify/pHfSTuT_w544lr.png) Copy the link. Then, open your terminal in the directory that holds your Gatsby storefront codebase and run the following commands: @@ -88,21 +88,21 @@ Alternatively, if you don’t have any other websites, you’ll see a big button ::: -![Create a new website](https://i.imgur.com/IUUOzoW.png) +![Create a new website](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001840/Medusa%20Docs/Netlify/IUUOzoW_mw9u5w.png) You’ll then be asked to connect to a Git provider. -![Connect Git Provider](https://i.imgur.com/T6lZPDi.png) +![Connect Git Provider](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001855/Medusa%20Docs/Netlify/T6lZPDi_rvcuyf.png) Choose GitHub. You’ll then be redirected to GitHub’s website to give Netlify permissions if you haven’t done that before. After you authorize Netlify to use GitHub, you’ll be asked to pick the repository you want to deploy. Pick the repository you just created. -![Choose Repository](https://i.imgur.com/SRI3r1Y.png) +![Choose Repository](https://res.cloudinary.com/dza7lstvk/image/upload/v1668003038/Medusa%20Docs/Netlify/SRI3r1Y_hqwy8r.png) In the form that shows, keep all fields the same and click on the “Show advanced” button before the “Deploy site” button. -![Show advanced Button](https://i.imgur.com/nUdwRbq.png) +![Show advanced Button](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001884/Medusa%20Docs/Netlify/nUdwRbq_d2kmo6.png) Under the “Advanced build settings” section click on the “New variable” button. This will show two inputs for the key and value of the environment variable. @@ -114,7 +114,7 @@ If you haven’t deployed your Medusa server yet, you can leave the value blank ::: -![Environment Variable](https://i.imgur.com/DnutZfT.png) +![Environment Variable](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001898/Medusa%20Docs/Netlify/DnutZfT_rv8iel.png) :::note @@ -126,7 +126,7 @@ Once you’re done, scroll down and click on Deploy site. You’ll be then redirected to the dashboard of the new website. Netlify will build your website in the background. You should see “Site deploy in progress” on the top card. -![Site Deployment Progress](https://i.imgur.com/PUDjjnL.png) +![Site Deployment Progress](https://res.cloudinary.com/dza7lstvk/image/upload/v1668003051/Medusa%20Docs/Netlify/PUDjjnL_hwuywi.png) The deployment can take a few minutes. @@ -144,11 +144,11 @@ medusa seed -f data/seed.json ::: -![Deployment Complete](https://i.imgur.com/dPF9HvF.png) +![Deployment Complete](https://res.cloudinary.com/dza7lstvk/image/upload/v1668003068/Medusa%20Docs/Netlify/dPF9HvF_ibnoo1.png) If you click on it, you’ll be redirected to the deployed storefront website. -![Gatsby Storefront](https://i.imgur.com/l08cBSA.png) +![Gatsby Storefront](https://res.cloudinary.com/dza7lstvk/image/upload/v1668003076/Medusa%20Docs/Netlify/l08cBSA_eanbne.png) :::caution @@ -178,11 +178,11 @@ netlify login This opens a page to log in on your browser. You’ll be asked to authorize the Netlify CLI tool. -![Authorize Application](https://i.imgur.com/JDUdqSE.png) +![Authorize Application](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001985/Medusa%20Docs/Netlify/JDUdqSE_dzveww.png) Click on Authorize. Then, you can go back to your terminal and see that you’ve successfully logged in. -![Authorized Message](https://i.imgur.com/L13Yqhp.png) +![Authorized Message](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001998/Medusa%20Docs/Netlify/L13Yqhp_e2ejpx.png) #### Initialize Netlify Website @@ -287,7 +287,7 @@ netlify open:site The Gatsby storefront will then open in your browser. -![Gatsby Storefront](https://i.imgur.com/l08cBSA.png) +![Gatsby Storefront](https://res.cloudinary.com/dza7lstvk/image/upload/v1668003089/Medusa%20Docs/Netlify/l08cBSA_yfj2rz.png) Before you can use the Gatsby storefront, you must add the URL as an environment variable on your deployed Medusa server. diff --git a/docs/content/introduction.md b/docs/content/introduction.md index 33adf7476d..6b849d7d24 100644 --- a/docs/content/introduction.md +++ b/docs/content/introduction.md @@ -6,7 +6,7 @@ title: Architecture Overview Medusa is composed of three components: The headless backend, the admin dashboard, and the storefront. -![Medusa's Architecture](https://i.imgur.com/ZHvM2bu.png) +![Medusa's Architecture](https://res.cloudinary.com/dza7lstvk/image/upload/v1667999772/Medusa%20Docs/Diagrams/ZHvM2bu_td4rnx.png) ## Headless Backend diff --git a/docs/content/starters/gatsby-medusa-starter.md b/docs/content/starters/gatsby-medusa-starter.md index 3fe7a45d5d..94bdfe0ff0 100644 --- a/docs/content/starters/gatsby-medusa-starter.md +++ b/docs/content/starters/gatsby-medusa-starter.md @@ -2,7 +2,7 @@ This document guides you to install and set up the Gatsby Storefront for your Medusa Server. -![Gatsby Storefront Quick Look](https://i.imgur.com/LcAsi8r.gif) +![Gatsby Storefront Quick Look](https://res.cloudinary.com/dza7lstvk/image/upload/v1668003111/Medusa%20Docs/Screenshots/LcAsi8r_yivcro.gif) ## Instant Deployment to Netlify @@ -98,16 +98,16 @@ The Gatsby storefront comes with a lot of features out of the box including: - View all products and manage your cart. - ![Products Page](https://i.imgur.com/P0Mpvxh.png) + ![Products Page](https://res.cloudinary.com/dza7lstvk/image/upload/v1668003126/Medusa%20Docs/Screenshots/P0Mpvxh_qznct6.png) - Customer authentication. - ![Sign In Page](https://i.imgur.com/0sVcZeS.png) + ![Sign In Page](https://res.cloudinary.com/dza7lstvk/image/upload/v1668003139/Medusa%20Docs/Screenshots/0sVcZeS_z6cftp.png) - Full checkout workflow. - ![One-Page Checkout](https://i.imgur.com/5wSs3yZ.png) + ![One-Page Checkout](https://res.cloudinary.com/dza7lstvk/image/upload/v1668003152/Medusa%20Docs/Screenshots/5wSs3yZ_iivxrh.png) - Request swaps and returns using a customer’s order ID and Email. - ![Request Return for Order](https://i.imgur.com/mAChp3f.png) + ![Request Return for Order](https://res.cloudinary.com/dza7lstvk/image/upload/v1668003162/Medusa%20Docs/Screenshots/mAChp3f_ubd89n.png) ## What’s Next diff --git a/docs/content/starters/nextjs-medusa-starter.md b/docs/content/starters/nextjs-medusa-starter.md index 39bfbc5d6d..cee432527c 100644 --- a/docs/content/starters/nextjs-medusa-starter.md +++ b/docs/content/starters/nextjs-medusa-starter.md @@ -2,7 +2,7 @@ This document guides you to install and set up the Next.js Storefront for your Medusa Server. -![Next.js Storefront Demo](https://i.imgur.com/koJl8uR.gif) +![Next.js Storefront Demo](https://res.cloudinary.com/dza7lstvk/image/upload/v1668003177/Medusa%20Docs/Screenshots/koJl8uR_n3gvii.gif) ## Instant Deployment to Netlify @@ -98,7 +98,7 @@ To make sure the Next.js storefront properly displays the products in the search ::: -![Search Result on Next.js storefront](https://i.imgur.com/gQVWvH2.png) +![Search Result on Next.js storefront](https://res.cloudinary.com/dza7lstvk/image/upload/v1668003191/Medusa%20Docs/Screenshots/gQVWvH2_h1ljig.png) ### Algolia Integration @@ -133,7 +133,7 @@ export const SEARCH_INDEX_NAME = Then, restart the Next.js server. You’ll be able to search through available products by clicking the search icon in the navigation bar. -![Search Pop-up in Next.js Storefront](https://i.imgur.com/ZLgX5Ad.png) +![Search Pop-up in Next.js Storefront](https://res.cloudinary.com/dza7lstvk/image/upload/v1668003205/Medusa%20Docs/Screenshots/ZLgX5Ad_po6a4n.png) ### Stripe Payment Integration @@ -149,7 +149,7 @@ Make sure to replace `` with your Stripe publishable key. If you restart your Next.js server you should be able to pay with Stripe on checkout. -![Pay with Stripe on Checkout](https://i.imgur.com/h5mWdJT.png) +![Pay with Stripe on Checkout](https://res.cloudinary.com/dza7lstvk/image/upload/v1668003250/Medusa%20Docs/Screenshots/h5mWdJT_yjogcq.png) ### PayPal Payment Integration @@ -165,7 +165,7 @@ Make sure to replace `` with your PayPal client ID. You can retr If you restart your Next.js server you should be able to pay with PayPal on checkout. -![Pay with PayPal on Checkout](https://i.imgur.com/F8OvsOJ.png) +![Pay with PayPal on Checkout](https://res.cloudinary.com/dza7lstvk/image/upload/v1668003264/Medusa%20Docs/Screenshots/F8OvsOJ_mlx0le.png) ### Customization @@ -204,15 +204,15 @@ You can learn more about development with Next.js through [their documentation]( - View all products and manage your cart. -![All Products Page](https://i.imgur.com/1vLAYbH.png) +![All Products Page](https://res.cloudinary.com/dza7lstvk/image/upload/v1668003278/Medusa%20Docs/Screenshots/1vLAYbH_sulxrr.png) - Customer authentication and profiles. -![Customer Profile](https://i.imgur.com/etW3b3L.png) +![Customer Profile](https://res.cloudinary.com/dza7lstvk/image/upload/v1668003287/Medusa%20Docs/Screenshots/etW3b3L_wccrez.png) - Full checkout workflow. -![Checkout Page](https://i.imgur.com/VC8SYfb.png) +![Checkout Page](https://res.cloudinary.com/dza7lstvk/image/upload/v1668003296/Medusa%20Docs/Screenshots/VC8SYfb_eowjno.png) ## What’s Next diff --git a/docs/content/troubleshooting/cors-issues.md b/docs/content/troubleshooting/cors-issues.md index 6a3bd6b9d7..22f1d84a78 100644 --- a/docs/content/troubleshooting/cors-issues.md +++ b/docs/content/troubleshooting/cors-issues.md @@ -4,7 +4,7 @@ If you are experiencing connection issues when trying to access your Medusa serv You might see a log in your browser console, that looks like this: -![CORS error log](https://i.imgur.com/jnHK115.png) +![CORS error log](https://res.cloudinary.com/dza7lstvk/image/upload/v1668003322/Medusa%20Docs/Other/jnHK115_udgf2n.png) In your `medusa-config.js` , you should ensure that you've configured your CORS settings correctly. By default, the Medusa starter runs on port `9000`, Medusa Admin runs on port `7000`, and the storefront starters run on port `8000`. diff --git a/docs/content/troubleshooting/missing-payment-providers.md b/docs/content/troubleshooting/missing-payment-providers.md index edca037a70..c2aebf9f1a 100644 --- a/docs/content/troubleshooting/missing-payment-providers.md +++ b/docs/content/troubleshooting/missing-payment-providers.md @@ -25,9 +25,7 @@ npm install medusa-payment-stripe However, to also show them as part of your checkout flow you need to add them to your regions. -In the Medusa Admin go to Settings > Regions and for each region scroll down to the Payment Provider input and choose the payment provider you want to use in that region: - -![Enable Payment Provider](https://i.imgur.com/FH5vgWh.png) +In the Medusa Admin go to Settings > Regions and for each region scroll down to the Payment Provider input and choose the payment provider you want to use in that region. ## Additional Resources diff --git a/docs/content/user-guide/customers/groups.mdx b/docs/content/user-guide/customers/groups.mdx index 31c4e620eb..815ea93b6e 100644 --- a/docs/content/user-guide/customers/groups.mdx +++ b/docs/content/user-guide/customers/groups.mdx @@ -20,7 +20,7 @@ To create a customer group: 2. Optionally, to add metadata: 1. Click on the Add Metadata button. 2. Enter a value for the Key and Value Fields. - 3. To remove a metadata field, click on the icon. + 3. To remove a metadata field, click on the icon. 5. Once you’re done, click on the Publish Group button. --- @@ -40,14 +40,14 @@ To view the details of a customer group: To edit a customer group: 1. Go to the customer group’s details page. -2. Click on the icon at the right of the group’s name. +2. Click on the icon at the right of the group’s name. 3. Click on Edit in the dropdown. 4. In the new window that opens: 1. You can change the title and existing metadata of the group. 2. To add metadata: 1. Click on the Add Metadata button. 2. Enter a value for the Key and Value Fields. - 3. To remove metadata click on the icon. + 3. To remove metadata click on the icon. 5. Once you’re done, click on the Edit Group button. --- @@ -81,7 +81,7 @@ Removing customers from a customer group doesn't remove the customers from your To remove customers from a customer group: 1. Go to the customer group’s details page. -2. In the Customer section, click on the icon next to the customer you want to remove from the group. +2. In the Customer section, click on the icon next to the customer you want to remove from the group. 3. Click on “Delete from the Group” from the dropdown. ### Remove Multiple Customers from a Group @@ -112,6 +112,6 @@ Deleting a customer group cannot be undone. To delete a customer group: 1. Go to the customer group’s details page. -2. Click on the icon at the right of the group’s name. +2. Click on the icon at the right of the group’s name. 3. Click on Delete from the dropdown. 4. Confirm deleting the price list by clicking the “Yes, delete” button in the pop-up. \ No newline at end of file diff --git a/docs/content/user-guide/customers/manage.mdx b/docs/content/user-guide/customers/manage.mdx index 384a315140..9bf1d9a27d 100644 --- a/docs/content/user-guide/customers/manage.mdx +++ b/docs/content/user-guide/customers/manage.mdx @@ -22,7 +22,7 @@ To view a customer’s details: To edit a customer’s details: 1. Go to a Customer’s details page. -2. Click on the icon in the first section. +2. Click on the icon in the first section. 3. Choose Edit from the dropdown. 4. In the new window that opens, you can edit the customer’s details. 5. Once you’re done, click on the Save button. diff --git a/docs/content/user-guide/gift-cards/manage.mdx b/docs/content/user-guide/gift-cards/manage.mdx index 7f73df247b..66f1faae1c 100644 --- a/docs/content/user-guide/gift-cards/manage.mdx +++ b/docs/content/user-guide/gift-cards/manage.mdx @@ -26,7 +26,7 @@ To create a Gift Card: - You can optionally enter a description and a thumbnail. - Click on Add Denomination. You must at least add one denomination - For each denomination, choose the currency and amount. - - If you want to delete a denomination, you can click the icon. + - If you want to delete a denomination, you can click the icon. 3. Once you’re done, click Create & Publish. :::tip @@ -42,7 +42,7 @@ If you want to add more than one currency value for a denomination, you can do t To edit a Gift Card: 1. Go to the Gift Cards page from the sidebar menu. -2. Next to the main gift card, click on the icon. +2. Next to the main gift card, click on the icon. 3. Choose Edit from the dropdown. This opens a form to edit the gift card details and denominations. @@ -72,7 +72,7 @@ In the window that opens: 3. Optionally, you can enter other values for the denominations. This is useful if you want to enter an amount in another currency. To do that: - Click on “Add a price” under Other Values. - Choose the currency and amount. - - To delete a price under Other Values, click on the icon. + - To delete a price under Other Values, click on the icon. 4. Once you’re done, click Save. ### Edit a Denomination @@ -80,12 +80,12 @@ In the window that opens: To edit a denomination: 1. In the Denominations section, find the denomination you want to edit. -2. Click on the icon in the same row as the denomination you want to edit. +2. Click on the icon in the same row as the denomination you want to edit. 3. Click on Edit Denomination from the dropdown. 4. This opens a new window to edit the denomination. You can then: - Edit the currency or amount of existing prices of the denomination. - Add prices for other currencies by clicking “Add a price” - - Delete prices by clicking the icon. + - Delete prices by clicking the icon. 5. Once you’re done, click Save. ### Delete a Denomination @@ -99,7 +99,7 @@ If you delete a denomination, customers won’t be able to find it in the storef To delete a denomination: 1. In the Denominations section, find the denomination you want to edit. -2. Click on the icon in the same row as the denomination you want to delete. +2. Click on the icon in the same row as the denomination you want to delete. 3. Click on Delete Denomination from the dropdown. 4. Confirm deleting the denomination by clicking the “Yes, delete” button in the pop-up. @@ -148,7 +148,7 @@ If you delete an image, you won’t be able to restore it. To delete a gift card image: 1. Go to the Images section. -2. Click on the icon at the right of the image you want to delete. +2. Click on the icon at the right of the image you want to delete. 3. Click Save at the bottom right of the page. --- @@ -163,12 +163,12 @@ Unpublishing a gift card prevents customers from seeing the gift card in the sto ### On Gift Cards Page -1. Click on the icon at the top right of the main gift card. +1. Click on the icon at the top right of the main gift card. 2. Choose Unpublish. ### On Edit Gift Card Page -1. Click on the icon at the top right of the Product Information section. +1. Click on the icon at the top right of the Product Information section. 2. Choose Unpublish Gift Card from the dropdown. --- @@ -183,12 +183,12 @@ Publishing a gift card allows customers to see the gift card on the storefront, ### On Gift Cards Page -1. Click on the icon at the top right of the main gift card. +1. Click on the icon at the top right of the main gift card. 2. Choose Publish. ### On Edit Gift Card Page -1. Click on the icon at the top right of the Product Information section. +1. Click on the icon at the top right of the Product Information section. 2. Choose Publish Gift Card from the dropdown. --- @@ -204,6 +204,6 @@ If you delete a gift card, you can’t restore it or its settings. Customers als To delete a gift card: 1. Go to the Gift Cards page from the sidebar menu. -2. Click on the icon next to the main gift card. +2. Click on the icon next to the main gift card. 3. Choose Delete from the dropdown. 4. Confirm deleting the gift card by clicking the “Yes, delete” button in the pop-up. \ No newline at end of file diff --git a/docs/content/user-guide/index.mdx b/docs/content/user-guide/index.mdx index 80aabe5919..8e125d5f8c 100644 --- a/docs/content/user-guide/index.mdx +++ b/docs/content/user-guide/index.mdx @@ -15,7 +15,7 @@ If you don’t have a Medusa admin yet, you can check [the live demo](https://de ::: -![Medusa Admin Overview](https://i.imgur.com/RdrJznk.png) +![Medusa Admin Overview](https://res.cloudinary.com/dza7lstvk/image/upload/v1667923680/Medusa%20Docs/User%20Guide/RdrJznk_ejddsm.png) ## Accessing the Medusa Admin @@ -23,7 +23,7 @@ To access the admin panel of your ecommerce store, you must have a URL to the de Once you open the URL, you’ll be asked to log in. -![Log In Page](https://i.imgur.com/cUYLszZ.png) +![Log In Page](https://res.cloudinary.com/dza7lstvk/image/upload/v1667923937/Medusa%20Docs/User%20Guide/cUYLszZ_bksyzs.png) You must use your user’s email and password to log in. If you’re unsure what your email and password are, please contact the technical personnel that deployed your Medusa server and admin. @@ -37,7 +37,7 @@ The sidebar menu includes the main navigation of your Medusa admin. You can use You can also see your team members in the sidebar menu. These are the users that can access the Medusa Admin. -![Sidebar Menu](https://i.imgur.com/KZlWoUi.png) +![Sidebar Menu](https://res.cloudinary.com/dza7lstvk/image/upload/v1667923971/Medusa%20Docs/User%20Guide/KZlWoUi_pf5a2f.png) ### Search Bar @@ -53,24 +53,24 @@ Mac OS: ⌘ + K ::: -![Search Window](https://i.imgur.com/z9a1NLK.png) +![Search Window](https://res.cloudinary.com/dza7lstvk/image/upload/v1667923987/Medusa%20Docs/User%20Guide/z9a1NLK_ojyfn0.png) You can either select a resolve with your mouse, or use the up and down arrows on your keyboard to navigate between the results, then choosing a result by hitting the Enter key. ### Check Notifications -At the top right you’ll find a icon. Clicking this icon opens a side window to view any notifications you might have. You can use this to view notifications such as completed product exports. +At the top right you’ll find a icon. Clicking this icon opens a side window to view any notifications you might have. You can use this to view notifications such as completed product exports. -![Notifications Window](https://i.imgur.com/cTIu9yP.png) +![Notifications Window](https://res.cloudinary.com/dza7lstvk/image/upload/v1667924034/Medusa%20Docs/User%20Guide/cTIu9yP_ubsbqx.png) ### Quick Actions At the top right, you’ll find an avatar icon. By clicking this icon, you’ll see a dropdown. You can use this dropdown to quickly access settings or sign out. -![Quick Actions Dropdown](https://i.imgur.com/YgVKTLH.png) +![Quick Actions Dropdown](https://res.cloudinary.com/dza7lstvk/image/upload/v1667924052/Medusa%20Docs/User%20Guide/YgVKTLH_t8zrqw.png) ### Need Help -At the top right, you’ll find a icon. When you click on this icon, a form will pop up. You can use this form to send the Medusa team a message asking for help. The Medusa team usually responds in a few hours on business days. +At the top right, you’ll find a icon. When you click on this icon, a form will pop up. You can use this form to send the Medusa team a message asking for help. The Medusa team usually responds in a few hours on business days. -![Get Help Form](https://i.imgur.com/8Fpa0gr.png) \ No newline at end of file +![Get Help Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1667924070/Medusa%20Docs/User%20Guide/8Fpa0gr_sjovih.png) \ No newline at end of file diff --git a/docs/content/user-guide/lists.mdx b/docs/content/user-guide/lists.mdx index d6f0c929a2..5b6e8113d4 100644 --- a/docs/content/user-guide/lists.mdx +++ b/docs/content/user-guide/lists.mdx @@ -18,7 +18,7 @@ On a table with a list of items, you’ll find quick filters at the top of the l You can click on one of these filters to quickly apply it to the list of items. -![https://i.imgur.com/eVwD0JP.png](https://i.imgur.com/eVwD0JP.png) +![Quick filters for lists](https://res.cloudinary.com/dza7lstvk/image/upload/v1667998663/Medusa%20Docs/User%20Guide/eVwD0JP_ukor4r.png) ### Advanced Filters @@ -26,13 +26,13 @@ You can use advanced filters to furthermore limit the items shown based on speci To use advanced filters: -1. Click on the icon next to Filters. This will toggle a dropdown with categories for different fields. +1. Click on the icon next to Filters. This will toggle a dropdown with categories for different fields. 2. You can click on a field name to expand it and choose a filter for that field. 3. Click on the Apply button at the top of the dropdown. This will retrieve the items based on the filters you’ve selected. -![https://i.imgur.com/rg9nKcS.png](https://i.imgur.com/rg9nKcS.png) +![Advanced filters for lists](https://res.cloudinary.com/dza7lstvk/image/upload/v1667998724/Medusa%20Docs/User%20Guide/rg9nKcS_vpwcrg.png) ### Save Advanced Filters as Quick Filters @@ -40,31 +40,31 @@ If there are filters that you need to use frequently, you can give the set of fi To save an advanced filter: -1. Click on the icon next to Filters. +1. Click on the icon next to Filters. 2. Choose your filters from the dropdown. 3. Choose a name for the filters in the input at the end of the dropdown. 4. Click the Save button. -![https://i.imgur.com/0nKZ5BX.png](https://i.imgur.com/0nKZ5BX.png) +![Saved Quick filters](https://res.cloudinary.com/dza7lstvk/image/upload/v1667998745/Medusa%20Docs/User%20Guide/0nKZ5BX_r5tdld.png) Once you click Save, you should see the new filter you added next to the Quick Filters at the top of the list. -![https://i.imgur.com/ymuSHkv.png](https://i.imgur.com/ymuSHkv.png) +![Custom Quick filters shown at the top](https://res.cloudinary.com/dza7lstvk/image/upload/v1667998777/Medusa%20Docs/User%20Guide/ymuSHkv_xey8ao.png) To apply a saved quick filter, just click on it. ### Delete Saved Quick Filters -You can delete any saved filter you’ve created. To do that, simply click on the icon next to the quick filter’s name, and it will be deleted. +You can delete any saved filter you’ve created. To do that, simply click on the icon next to the quick filter’s name, and it will be deleted. ### Clear Filters To clear all applied filters: -1. Click on the icon next to Filters. +1. Click on the icon next to Filters. 2. Click on the Clear button. -![https://i.imgur.com/ArawLDT.png](https://i.imgur.com/ArawLDT.png) +![Clear filters](https://res.cloudinary.com/dza7lstvk/image/upload/v1667998828/Medusa%20Docs/User%20Guide/ArawLDT_mjye2n.png) :::info @@ -76,9 +76,9 @@ Clearing filters does not delete saved quick filters. You can still apply them b ## Search Items -You can search for items in a list by clicking the icon at the top right of the list. +You can search for items in a list by clicking the icon at the top right of the list. -![https://i.imgur.com/Z09rbmQ.png](https://i.imgur.com/Z09rbmQ.png) +![Search items in a list](https://res.cloudinary.com/dza7lstvk/image/upload/v1667998849/Medusa%20Docs/User%20Guide/Z09rbmQ_jgi4ti.png) --- diff --git a/docs/content/user-guide/orders/claims.mdx b/docs/content/user-guide/orders/claims.mdx index 00aeeb5905..521791bde8 100644 --- a/docs/content/user-guide/orders/claims.mdx +++ b/docs/content/user-guide/orders/claims.mdx @@ -25,7 +25,7 @@ If you create a claim of type Refund, a refund is issued to the customer right a ::: 1. Open the order details page. -2. In the Timeline section, click on the icon at the top right. +2. In the Timeline section, click on the icon at the top right. 3. Click on Register Claim in the dropdown. 4. In the new window that opens: - Choose the items you want to create the claim for. For each item you pick, you must select the reason for the claim: @@ -35,10 +35,10 @@ If you create a claim of type Refund, a refund is issued to the customer right a - Click on the Add button. - Choose the Shipping method to use to return the item. - You can add a custom price for the shipping method by clicking on the Add custom price button. - - You can remove the custom price by clicking on the icon next to the price. + - You can remove the custom price by clicking on the icon next to the price. - Choose whether the type of the claim is “Refund” or “Replace”. If you choose “Replace”: - Choose the products you want to send to the customer by clicking Add Product and choosing the product you want to add. - - You can remove a product from the “items to send” list by clicking on the icon. + - You can remove a product from the “items to send” list by clicking on the icon. - If you want to send the items to another address, click on “Ship to a different address” and fill out the shipping address info. - Choose the Shipping Method that will be used to deliver the replacement items. - If you don’t want the customer to receive an email that a claim has been created, uncheck the “Send notifications” checkbox. @@ -51,7 +51,7 @@ If you create a claim of type Refund, a refund is issued to the customer right a To view an order’s claim details: 1. Open the order details page. -2. In the Timeline section, find the claim and click on the icon at its right. +2. In the Timeline section, find the claim and click on the icon at its right. 3. Click on More Details in the dropdown. --- @@ -79,7 +79,7 @@ Canceling a return can’t be undone. To cancel a return of a claim: 1. Open the order details page. -2. In the Timeline section, find the return requested and click on the icon. +2. In the Timeline section, find the return requested and click on the icon. 3. Click on “Cancel return” in the dropdown. --- @@ -99,10 +99,10 @@ You can create fulfillment for items in the claim that you are sending to the cu To create a fulfillment for a claim: 1. Open the order details page. -2. In the Timeline section, find the claim and click on the icon. +2. In the Timeline section, find the claim and click on the icon. 3. Click on Fulfill Claim in the dropdown. 4. In the window that opens: - - Choose the items you want to fulfill. You can change the quantity of the items you’re fulfilling using the and icons. + - Choose the items you want to fulfill. You can change the quantity of the items you’re fulfilling using the and icons. - Optionally add under Metadata any additional information that might be necessary for the fulfillment. - If you don’t want the customer to receive an email that a fulfillment for the claim items has been created, uncheck the “Send notifications” checkbox. 5. Once you’re done, click on the Complete button. @@ -114,7 +114,7 @@ To mark a claim’s fulfillment as shipped: 1. Open the order details page. 2. Scroll down to the Fulfillment section. 3. Find the fulfillment you want to mark as shipped. A claim’s fulfillment’s title should be prefixed with “Claim fulfillment”. -4. Click on the icon next to it. +4. Click on the icon next to it. 5. Click on Mark Shipped in the dropdown. 6. In the new window that opens: - Enter a tracking number for the shipment. @@ -137,7 +137,7 @@ To cancel a claim’s fulfillment: 1. Open the order details page. 2. Scroll down to the Fulfillment section. 3. Find the fulfillment you want to cancel. A claim’s fulfillment’s title should be prefixed with “Claim fulfillment”. -4. Click on the icon next to it. +4. Click on the icon next to it. 5. Click on Cancel Fulfillment in the dropdown. 6. Confirm canceling the fulfillment by clicking the “Yes, confirm” button in the pop-up. @@ -160,6 +160,6 @@ Canceling a claim can’t be undone. The [return of the claim must be canceled]( To cancel a claim of type Replace: 1. Open the order details page. -2. In the Timeline section, find the claim and click on the icon. +2. In the Timeline section, find the claim and click on the icon. 3. Click on Cancel Claim in the dropdown. 4. Confirm canceling the fulfillment by clicking the “Yes, remove” button in the pop-up. \ No newline at end of file diff --git a/docs/content/user-guide/orders/drafts.mdx b/docs/content/user-guide/orders/drafts.mdx index 7ddcb1bea4..90d0690c48 100644 --- a/docs/content/user-guide/orders/drafts.mdx +++ b/docs/content/user-guide/orders/drafts.mdx @@ -33,12 +33,12 @@ To create a draft order: 1. Click on the Add Custom button. 2. Enter the title, price, and quantity of the custom item. 3. Click on the Add button. - 3. To remove an item you added, click on the icon at the right of the item. - 4. To change the quantity of any item, use the and icons under the Quantity column. + 3. To remove an item you added, click on the icon at the right of the item. + 4. To change the quantity of any item, use the and icons under the Quantity column. 5. Once you’re done, click the Next button. 3. In the third step, choose a shipping method then click the Next button. 1. If you want to change the default price of the shipping method, click on the “Set custom price” button and enter the price you want to use. - 2. If you want to remove the custom price, you can click on the icon. + 2. If you want to remove the custom price, you can click on the icon. 4. In the fourth step, enter the customer’s details and shipping address. 1. If the customer already exists, you can choose it from the first input. You can search the list of customers by name or email. This fills out the fields under the General section as well. 2. If this is a new customer, in the first field, enter the email of the customer to add. Then, fill out the customer’s first name, last name, and phone number in the General section. @@ -71,7 +71,7 @@ To open a draft order’s details page: To edit the shipping address of a draft order: 1. Open the draft order details page. -2. Scroll down to the customer section and click on the icon in that section. +2. Scroll down to the customer section and click on the icon in that section. 3. Click on Edit Shipping Address in the dropdown. 4. This opens a new window to edit the shipping address’s info. 5. Once you’re done click on the Save button. @@ -89,7 +89,7 @@ Canceling a draft order cannot be undone and the draft order will be removed fro To cancel a draft order: 1. Open the draft order details page. -2. Click on the icon at the top right. +2. Click on the icon at the top right. 3. Click on Cancel Draft Order in the dropdown. 4. Confirm canceling the draft order by clicking the “Yes, remove” button in the pop-up. diff --git a/docs/content/user-guide/orders/exchange.mdx b/docs/content/user-guide/orders/exchange.mdx index f0ac0e9ee3..771bc63a6b 100644 --- a/docs/content/user-guide/orders/exchange.mdx +++ b/docs/content/user-guide/orders/exchange.mdx @@ -26,7 +26,7 @@ An exchange can only be created if the order’s payment is captured and the ite To create an order exchange: 1. Go to an order’s details page. -2. In the Timeline section, click on the icon. +2. In the Timeline section, click on the icon. 3. Click on Register Exchange from the dropdown. 4. In the new window that opens: 1. Choose the items you want the customer to return. For each item you select: @@ -36,12 +36,12 @@ To create an order exchange: 4. Once you’re done, click on the Add button. 2. Choose a Shipping Method to return the customer’s items. 1. You can optionally specify a custom price for shipping by clicking the “Add custom price” button. - 2. You can remove the custom price by clicking the icon. + 2. You can remove the custom price by clicking the icon. 3. In the “Items to send” section, click on the Add Product button. Then: 1. Check the products you want to send to the customer in exchange. 2. When you’re done, click the Add button. - 3. You can remove products you’ve added by clicking the icon. - 4. You can change the quantity of the product to send using the and icons. + 3. You can remove products you’ve added by clicking the icon. + 4. You can change the quantity of the product to send using the and icons. 4. If you don’t want the customer to receive an email that an exchange has been registered, uncheck the “Send notifications” checkbox. 5. Once you’re done, click the Complete button. @@ -69,9 +69,9 @@ To cancel an exchange: 1. Go to an order’s details page. 2. In the Timeline section, find the order exchange. -3. Click on the icon next to it. +3. Click on the icon next to it. 4. Click on “Cancel return” from the dropdown. 5. Confirm canceling the return by clicking the “Yes, cancel” button in the pop-up. -6. Click on the icon again next to the order exchange. +6. Click on the icon again next to the order exchange. 7. Click on “Cancel exchange” from the dropdown. 8. Confirm canceling the exchange by clicking the “Yes, cancel” button in the pop-up. diff --git a/docs/content/user-guide/orders/export.mdx b/docs/content/user-guide/orders/export.mdx index 75c696b2f9..1b21345a78 100644 --- a/docs/content/user-guide/orders/export.mdx +++ b/docs/content/user-guide/orders/export.mdx @@ -21,7 +21,7 @@ To export orders: 1. Go to Orders page. 2. Click on Export Orders at the top right. 3. Click Export in the window that opens. -4. Click on the icon at the top right of the page. +4. Click on the icon at the top right of the page. 5. You should see your new export loading. 6. Once the export is ready, click on the Download button. @@ -43,7 +43,7 @@ You can only cancel an unfinished order export. To cancel an order export: -1. Click on the icon at the top right of the page. +1. Click on the icon at the top right of the page. 2. Find the export you want to cancel. 3. Click on the cancel button. @@ -59,6 +59,6 @@ You can only delete a finished order export. To delete an order export: -1. Click on the icon at the top right of the page. +1. Click on the icon at the top right of the page. 2. Find the export you want to delete. 3. Click on the Delete button. \ No newline at end of file diff --git a/docs/content/user-guide/orders/fulfillments.mdx b/docs/content/user-guide/orders/fulfillments.mdx index 11df68cee3..6cbbd72d93 100644 --- a/docs/content/user-guide/orders/fulfillments.mdx +++ b/docs/content/user-guide/orders/fulfillments.mdx @@ -33,7 +33,7 @@ To create a fulfillment for an order: 2. Scroll down to the Fulfillment section. 3. Click on the Create Fulfillment button. 4. In the window that opens: - - Choose the items you want to create the fulfillment for. These are the items you’ll ship together. You can also choose a specific quantity of an item to ship using the and icons under the Quantity column. + - Choose the items you want to create the fulfillment for. These are the items you’ll ship together. You can also choose a specific quantity of an item to ship using the and icons under the Quantity column. - Optionally enter any additional information you want to associate with the fulfillment under the Metadata section. - If you don’t want the customer to receive an email that a fulfillment has been created, uncheck the “Send notifications” checkbox. 5. Once done, click on the Complete button. @@ -54,7 +54,7 @@ To mark a fulfillment as shipped in an order: 1. Open the order details page. 2. Scroll down to the Fulfillment section. -3. Find the fulfillment you want to mark as shipped, then click on the icon next to it. +3. Find the fulfillment you want to mark as shipped, then click on the icon next to it. 4. Click on Mark Shipped in the dropdown. 5. In the new window that opens: - Enter a tracking number for the shipment. @@ -78,6 +78,6 @@ To cancel a fulfillment in an order: 1. Open the order details page. 2. Scroll down to the Fulfillment section. -3. Find the fulfillment you want to cancel, then click on the icon next to it. +3. Find the fulfillment you want to cancel, then click on the icon next to it. 4. Click on Cancel Fulfillment in the dropdown. 5. Confirm canceling the fulfillment by clicking the “Yes, confirm” button in the pop-up. diff --git a/docs/content/user-guide/orders/manage.mdx b/docs/content/user-guide/orders/manage.mdx index 179ea74f26..c2a9340326 100644 --- a/docs/content/user-guide/orders/manage.mdx +++ b/docs/content/user-guide/orders/manage.mdx @@ -54,7 +54,7 @@ To edit the shipping address used for an order: 1. Open the order details page. 2. Scroll down to the Customer section. -3. Click on the icon. +3. Click on the icon. 4. Click on Edit Shipping Address from the dropdown. 5. This opens a new window to edit the shipping address. 6. Once you’re done, click on the Save button. @@ -67,7 +67,7 @@ To edit the email address associated with an order: 1. Open the order details page. 2. Scroll down to the Customer section. -3. Click on the icon. +3. Click on the icon. 4. Click on Edit Email Address from the dropdown. 5. This opens a new window to edit the email address. 6. Once you’re done, click on the Save button. @@ -79,8 +79,8 @@ To edit the email address associated with an order: To add a note to an order: 1. Open the order details page. -2. In the Timeline section, enter the note in the text input. You can also choose emojis by clicking the icon. -3. Once done, click on the icon. +2. In the Timeline section, enter the note in the text input. You can also choose emojis by clicking the icon. +3. Once done, click on the icon. The note will be added and can be seen in the timeline. @@ -98,7 +98,7 @@ To delete a note in an order: 1. Open the order details page. 2. In the Timeline section, find the note you want to delete from the timeline. -3. Click on the icon next to the note. +3. Click on the icon next to the note. 4. Click on Delete from the dropdown. 5. Confirm deleting the note by clicking the “Yes, delete” button in the pop-up. @@ -115,6 +115,6 @@ Once an order is canceled it can’t be undone. To cancel an order: 1. Open the order details page. -2. In the first section showing the order’s number, click on the at the top right. +2. In the first section showing the order’s number, click on the at the top right. 3. Click on Cancel Order from the dropdown. 4. Confirm canceling the order by clicking the “Yes, confirm” button in the pop-up. diff --git a/docs/content/user-guide/orders/returns.mdx b/docs/content/user-guide/orders/returns.mdx index af8fb68ff9..da6412cecb 100644 --- a/docs/content/user-guide/orders/returns.mdx +++ b/docs/content/user-guide/orders/returns.mdx @@ -36,7 +36,7 @@ To find return requests of an order: To request a return for an order: 1. Open the order details page. -2. In the Timeline section, click on the icon at the top right. +2. In the Timeline section, click on the icon at the top right. 3. Click on Request Return in the dropdown. 4. In the new window that opens: - Choose the items in the order that you want to request the return. @@ -44,7 +44,7 @@ To request a return for an order: - Choose a Return Reason, optionally enter a Note, then click the Add button. - Select a shipping method you want to use for this return. - If you want to change the default price of the shipping method, click on the “Add custom price” button and enter the price you want to use. - - If you want to remove the custom price, you can click on the icon. + - If you want to remove the custom price, you can click on the icon. - If you don’t want the customer to receive an email that a return has been requested, uncheck the “Send notifications” checkbox. 5. Once done, click on the Submit button. @@ -79,5 +79,5 @@ If a return is canceled it can’t be undone. A return can only be canceled if i To cancel a return: 1. Open the order details page. -2. In the Timeline section, find the return requested and click on the icon. +2. In the Timeline section, find the return requested and click on the icon. 3. Click on “Cancel return” in the dropdown. diff --git a/docs/content/user-guide/price-lists/import.mdx b/docs/content/user-guide/price-lists/import.mdx index 58f1ed2ba5..f1f9a85b47 100644 --- a/docs/content/user-guide/price-lists/import.mdx +++ b/docs/content/user-guide/price-lists/import.mdx @@ -25,16 +25,16 @@ When you import prices into a price list, it removes existing prices and adds ne To import prices into a price list: 1. Go to the price list’s details page. -2. In the Prices section, click on the icon. +2. In the Prices section, click on the icon. 3. Click on “Import price list” from the dropdown. 4. In the new window: - 1. If you’re unsure of what the CSV file’s format must be like, you can download a template CSV file by clicking the icon. + 1. If you’re unsure of what the CSV file’s format must be like, you can download a template CSV file by clicking the icon. 2. To upload the CSV file you want to import prices from, either: 1. Drag and drop the file into the dashed box; 2. Or click on the dashed box and choose the file you want to import the prices from. 3. After you upload the CSV file: 1. You can check the number of prices to be added above the uploaded file’s name. - 2. You can remove the file you choose by clicking the icon. + 2. You can remove the file you choose by clicking the icon. 5. Once you’re done choosing a file to import prices from, click on the Import List button. This starts the import process. Based on the number of prices you’re importing, it can take some time. @@ -49,7 +49,7 @@ If you face any errors or difficulties, please contact your technical support te To check the status of the import: -1. Click on the icon at the top right of the page. +1. Click on the icon at the top right of the page. 2. Find the price import, which should be the latest item on the list. If a loading indicator is showing, then the import process is still in progress. @@ -70,6 +70,6 @@ You can only cancel an unfinished prices import. To cancel a price import: -1. Click on the icon at the top right of the page. +1. Click on the icon at the top right of the page. 2. Find the import you want to cancel. 3. Click on the cancel button. \ No newline at end of file diff --git a/docs/content/user-guide/price-lists/manage.mdx b/docs/content/user-guide/price-lists/manage.mdx index 6e5ac0c9f3..036dfe3841 100644 --- a/docs/content/user-guide/price-lists/manage.mdx +++ b/docs/content/user-guide/price-lists/manage.mdx @@ -45,22 +45,22 @@ In this section, you must choose at least one product and specify the prices you 2. Choose at least one product from the list. 3. Click the Save button. The products will then be seen under the Prices section. 4. For each product you added: - 1. Click on the icon at its right. + 1. Click on the icon at its right. 2. To add the same price for all variants: - 1. Click on the icon next to any of the variants. + 1. Click on the icon next to any of the variants. 2. Choose “Edit Prices” from the dropdown. 3. In the new window, choose the “Apply on all variants” option. 4. Enter the price for each currency. 5. Click on the “Save and close” button. 3. To add a price for each variant: - 1. Click on the icon next to a variant. + 1. Click on the icon next to a variant. 2. Choose “Edit Prices” from the dropdown. 3. In the new window, choose the “Apply overrides on selected variants” option. 4. Choose the variants that you want to apply the current pricing to. 5. Enter the price for each currency. 6. Click on the “Save and close” button. 4. To remove a variant from the price list: - 1. Click on the icon next to the variant. + 1. Click on the icon next to the variant. 2. Click on the Remove from List button. 2. To remove products from the prices list: 1. Click on the “Add Products Manually” button. @@ -96,7 +96,7 @@ Publishing a price list makes it and its prices available to customers. Unpublis To change a price list’s status: 1. Go to the Pricing page. -2. Click on the icon next to the price list. +2. Click on the icon next to the price list. 3. Based on the current status, click on the Unpublish or Publish links in the dropdown to change the status. --- @@ -106,7 +106,7 @@ To change a price list’s status: To edit a price list’s information and configurations: 1. Go to the price list’s details page. -2. Click on the icon in the first section. +2. Click on the icon in the first section. 3. Choose “Edit price list details”. 4. This opens a form in a new window that has the [same sections as the Create Price List form](#create-a-price-list), except for the Prices section. You can edit the price list’s general information, customer groups, and start and end dates. 5. Once you’re done making changes, click on the Save changes button. @@ -120,7 +120,7 @@ To edit a price list’s information and configurations: To add new product prices: 1. Go to the price list’s details page. -2. In the Prices section, click on the icon. +2. In the Prices section, click on the icon. 3. Click on “Edit manually” in the dropdown. 4. This opens a new window with a form similar to the [Prices section in the Create form](#prices). You can search for or manually add products. 5. Once you’re done, click on the “Save changes” button. @@ -131,11 +131,11 @@ To edit the prices in the price list: 1. Go to the price list’s details page. 2. Find the product you want to edit in the Prices section. -3. Click on the icon next to it. +3. Click on the icon next to it. 4. Choose “Edit prices” from the dropdown. 5. In the new window: - 1. Click on the icon next to the product’s name to expand the list of variants. - 2. Click on the icon next to the variant you want to edit. + 1. Click on the icon next to the product’s name to expand the list of variants. + 2. Click on the icon next to the variant you want to edit. 3. Edit the prices of the variant for each currency. 4. Once you’re done, click on the “Save and close” button. 6. Once you’re done editing the product’s prices, click on the Save button. @@ -152,7 +152,7 @@ To delete all the prices of a product in a price list: 1. Go to the price list’s details page. 2. Find the product you want to edit in the Prices section. -3. Click on the icon next to it. +3. Click on the icon next to it. 4. Click on “Remove product” in the dropdown. --- @@ -168,6 +168,6 @@ Deleting a price list cannot be undone. Prices defined in the price list will no To delete a price list: 1. Go to the Pricing page. -2. Click on the icon next to the price list you want to delete. +2. Click on the icon next to the price list you want to delete. 3. Click on Delete in the dropdown. 4. Confirm deleting the price list by clicking the “Yes, confirm” button in the pop-up. \ No newline at end of file diff --git a/docs/content/user-guide/products/collections.mdx b/docs/content/user-guide/products/collections.mdx index 5ac074e35f..981b7f915a 100644 --- a/docs/content/user-guide/products/collections.mdx +++ b/docs/content/user-guide/products/collections.mdx @@ -19,7 +19,7 @@ To create a collection: 1. You're required to enter a name for the collection 2. You can optionally specify the handle of the collection. 3. To add metadata, click on the Add Metadata button. - 4. To remove metadata, click on the icon next to it. + 4. To remove metadata, click on the icon next to it. 5. Once done, click on the “Publish collection” button. --- @@ -39,7 +39,7 @@ To view a collection’s details: To edit a collection: 1. Go to the Collection’s Details page. -2. Click on the icon at the top right of the first section. +2. Click on the icon at the top right of the first section. 3. Choose Edit Collection from the dropdown. 4. In the new form that opens, edit any of the collection details. 5. Once done, click on the “Save collection” button. @@ -69,7 +69,7 @@ To remove a product from a collection: 1. Go to the Collection’s Details page. 2. In the Products section, find the product you want to remove from the collection. -3. Click on the icon at the right side of the product. +3. Click on the icon at the right side of the product. 4. Confirm removing the product by clicking the “Yes, remove" button in the pop-up. --- @@ -85,6 +85,6 @@ Deleting a collection can’t be undone. You will lose all data related to the c To delete a collection: 1. Go to the Collections page. -2. Find the collection you want to delete, then click on the icon at its right. +2. Find the collection you want to delete, then click on the icon at its right. 3. Choose Delete from the dropdown. 4. Confirm deleting the collection by clicking the “Yes, confirm" button in the pop-up. \ No newline at end of file diff --git a/docs/content/user-guide/products/export.mdx b/docs/content/user-guide/products/export.mdx index ba466ce494..d4dfe90b90 100644 --- a/docs/content/user-guide/products/export.mdx +++ b/docs/content/user-guide/products/export.mdx @@ -21,7 +21,7 @@ To export products: 1. Go to the Products page. 2. Click on Export Products at the top right. 3. Click Export in the window that opens. -4. Click on the icon at the top right of the page. +4. Click on the icon at the top right of the page. 5. You should see your new export loading. 6. Once the export is ready, click on the Download button. @@ -43,7 +43,7 @@ You can only cancel an unfinished product export. To cancel a product export: -1. Click on the icon at the top right of the page. +1. Click on the icon at the top right of the page. 2. Find the export you want to cancel. 3. Click on the cancel button. @@ -59,6 +59,6 @@ You can only delete a finished product export. To delete a product export: -1. Click on the icon at the top right of the page. +1. Click on the icon at the top right of the page. 2. Find the export you want to delete. 3. Click on the Delete button. \ No newline at end of file diff --git a/docs/content/user-guide/products/import.mdx b/docs/content/user-guide/products/import.mdx index 5aec76bd64..a9d644e1d7 100644 --- a/docs/content/user-guide/products/import.mdx +++ b/docs/content/user-guide/products/import.mdx @@ -23,13 +23,13 @@ To import products: 1. Go to the Products page. 2. Click on Import Products at the top right. 3. In the new window: - 1. If you’re unsure of what the CSV file’s format must be like, you can download a template CSV file by clicking the icon. + 1. If you’re unsure of what the CSV file’s format must be like, you can download a template CSV file by clicking the icon. 2. To upload the CSV file you want to import products from, either: 1. Drag and drop the file into the dashed box; 2. Or click on the dashed box and choose the file you want to import the products from. 3. After you upload the CSV file: 1. You can check the number of products to be created or updated above the uploaded file’s name. - 2. You can remove the file you choose by clicking the icon. + 2. You can remove the file you choose by clicking the icon. 4. Once you’re done choosing a file to import products from, click on the Import List button. This starts the import process. Based on the number of products you’re importing, it can take some time. @@ -44,7 +44,7 @@ If you face any errors or difficulties, please contact your technical support te To check the status of the import: -1. Click on the icon at the top right of the page. +1. Click on the icon at the top right of the page. 2. Find the product import, which should be the latest item on the list. If a loading indicator is showing, then the import process is still in progress. @@ -65,6 +65,6 @@ You can only cancel an unfinished product import. To cancel a product import: -1. Click on the icon at the top right of the page. +1. Click on the icon at the top right of the page. 2. Find the import you want to cancel. 3. Click on the cancel button. \ No newline at end of file diff --git a/docs/content/user-guide/products/index.mdx b/docs/content/user-guide/products/index.mdx index c660574295..74cbb0e81e 100644 --- a/docs/content/user-guide/products/index.mdx +++ b/docs/content/user-guide/products/index.mdx @@ -30,11 +30,11 @@ In the list, you can see product details such as the name, collection, inventory ### List View -To view products in a list view, which is the default view, click on the icon at the top right of the product list. +To view products in a list view, which is the default view, click on the icon at the top right of the product list. ### Grid View -To view products in a grid view, click on the icon at the top right of the product list. +To view products in a grid view, click on the icon at the top right of the product list. --- diff --git a/docs/content/user-guide/products/manage.mdx b/docs/content/user-guide/products/manage.mdx index 85249a3f26..45d761a131 100644 --- a/docs/content/user-guide/products/manage.mdx +++ b/docs/content/user-guide/products/manage.mdx @@ -30,26 +30,26 @@ All fields in this section allow you to better group and filter your products us 1. You can either choose from a list of types or create a new one. 2. You can choose from a list of collections. -3. Tags are comma-separated. After entering a tag’s value, add a comma “,” and it will create the tag. You can remove the tag by pressing the icon next to it. +3. Tags are comma-separated. After entering a tag’s value, add a comma “,” and it will create the tag. You can remove the tag by pressing the icon next to it. ### Variants Section In this section, you can create different options and variants of a product. You must add an option before you can add variants. 1. Add a new option by clicking the “Add an option” button. - 1. This shows two new fields: the Title and the Variations fields. Separate the variations using a comma “,”. You can remove a variation by clicking the icon next to it. - 2. To remove an option, click on the icon next to it. + 1. This shows two new fields: the Title and the Variations fields. Separate the variations using a comma “,”. You can remove a variation by clicking the icon next to it. + 2. To remove an option, click on the icon next to it. 2. Add a new variant by clicking the “Add a variant” button. In the new window that opens: 1. Enter the required fields Custom title and choose a value for each option you created. 2. In the Pricing section, you can specify the price for each currency. To specify the price per region: - 1. Click on the icon next to the currency. This expands a list of regions below the currency. These are regions that use this currency. + 1. Click on the icon next to the currency. This expands a list of regions below the currency. These are regions that use this currency. 2. Enter the price for the region you want. 3. In the Stock & Inventory section, you can manage how Medusa handles the product’s inventory, the quantity in stock, and more. 1. If Manage Inventory is enabled, Medusa will change the available quantity of the variant when orders or returns are made. 2. If Allow Backorders is enabled, customers can purchase this variant even if it’s out-of-stock. 4. In the Shipping section, you can specify information relevant to shipping such as Height, Weight, Country of origin, and more. -3. You can edit a variant by clicking the icon, then choosing Edit from the dropdown. -4. You can delete a variant by clicking the icon, then choosing Delete from the dropdown. +3. You can edit a variant by clicking the icon, then choosing Edit from the dropdown. +4. You can delete a variant by clicking the icon, then choosing Delete from the dropdown. ### Attributes Section @@ -67,7 +67,7 @@ You can upload only one thumbnail. Uploading another thumbnail replaces the prev 1. Click the dashed box and choose an image; 2. Or drag-and-drop an image in the dashed box. 2. To delete a thumbnail: - 1. Click on the icon. + 1. Click on the icon. 2. Click Delete from the dropdown. ### Media Section @@ -82,7 +82,7 @@ You can upload more than one image in the Media section. 1. Click the dashed box and choose an image; 2. Or drag-and-drop an image in the dashed box. 2. To delete an image: - 1. Click on the icon. + 1. Click on the icon. 2. Click Delete from the dropdown. ### Save the Product @@ -104,7 +104,7 @@ To view a product’s details: To edit a product’s general information: 1. Go to the product’s details page. -2. Click on the at the top right of the first section. +2. Click on the at the top right of the first section. 3. Click on “Edit General Information” from the dropdown. 4. Edit any of the information in the window. 5. Once done, click on the Save button. @@ -130,12 +130,12 @@ After a product is created, the only way to add values to an option is when you To manage a product’s option: 1. Go to the product’s details page. -2. Click on the icon in the top right of the Variants section. +2. Click on the icon in the top right of the Variants section. 3. Click on Edit Options from the dropdown. 4. In the new window that opens: 1. You can add a new option by clicking the “Add an option” button. 2. You can edit an option’s name by changing its name in the field. - 3. You can delete an option by clicking the icon. + 3. You can delete an option by clicking the icon. 5. Once you’re done, click on the "Save and close" button. ## Manage Product Variants @@ -151,13 +151,13 @@ Multiple variants can’t have the same options combination. To add a variant to a product: 1. Go to the product’s details page. -2. Click on the icon in the top right of the Variants section. +2. Click on the icon in the top right of the Variants section. 3. Click on Add Variant from the dropdown. 4. In the window that opens: 1. Enter the required title field. 2. Choose a value for each option in the product. 3. In the Pricing section, you can specify the price for each currency. To specify the price per region: - 1. Click on the icon next to the currency. This expands a list of regions below the currency. These are regions that use this currency. + 1. Click on the icon next to the currency. This expands a list of regions below the currency. These are regions that use this currency. 2. Enter the price for the region you want. 4. In the Stock & Inventory section, you can manage how Medusa handles the product’s inventory, the quantity in Stock, and more. 1. If Manage Inventory is enabled, Medusa will change the available quantity of the variant when orders or returns are made. @@ -170,10 +170,10 @@ To add a variant to a product: To edit variants’ position in a product: 1. Go to the product’s details page. -2. Click on the icon in the top right of the Variants section. +2. Click on the icon in the top right of the Variants section. 3. Click on Edit Variants from the dropdown. 4. In the window that opens: - 1. Click and hold the icon next to the variant, then drag it to the position you want. + 1. Click and hold the icon next to the variant, then drag it to the position you want. 2. You can also change the inventory of the variants. 5. Once you’re done, click on the “Save and close” button. @@ -183,7 +183,7 @@ To edit a variant: 1. Go to the product’s details page. 2. Find the variant you want to edit in the Variants section. -3. Click on the icon. +3. Click on the icon. 4. Click on Edit Variant from the dropdown. 5. In the new window that opens, you can edit all of the variant’s information. 6. Once you’re done, click on the “Save and close” button. @@ -194,7 +194,7 @@ To duplicate a variant: 1. Go to the product’s details page. 2. Find the variant you want to duplicate in the Variants section. -3. Click on the icon. +3. Click on the icon. 4. Click on Duplicate Variant from the dropdown. 5. This opens a new window with almost all fields filled except for the selected Options. 6. Once you’re done, click on the “Save and close” button. @@ -211,7 +211,7 @@ To delete a variant: 1. Go to the product’s details page. 2. Find the variant you want to duplicate in the Variants section. -3. Click on the icon. +3. Click on the icon. 4. Click on Delete Variant from the dropdown. ## Edit a Product’s Attributes @@ -219,7 +219,7 @@ To delete a variant: To edit a product’s attributes: 1. Go to the product’s details page. -2. Click on the icon in the top right of the Attributes section. +2. Click on the icon in the top right of the Attributes section. 3. Click on Edit Attributes from the dropdown. 4. In the new window that opens, you can edit any of the attribute information of the product. 5. Once you’re done, click on the Save button. @@ -254,7 +254,7 @@ Deleting a thumbnail can’t be undone. To delete a thumbnail: 1. Go to the product’s details page. -2. Click on the icon at the top right of the Thumbnail section. +2. Click on the icon at the top right of the Thumbnail section. 3. Click the Confirm button. ## Manage Images @@ -274,7 +274,7 @@ To manage a product’s images 1. Click the dashed box and choose an image; 2. Or drag-and-drop an image in the dashed box. 2. To delete an image: - 1. Click on the icon. + 1. Click on the icon. 2. Click on Delete from the dropdown. 4. Once you’re done, click Save and close. @@ -283,7 +283,7 @@ To manage a product’s images To duplicate a product: 1. Go to the Products page. -2. Click on the icon next to the product you want to duplicate. +2. Click on the icon next to the product you want to duplicate. 3. Click on Duplicate from the dropdown. This creates a product with the same information as the original but as a draft. @@ -299,6 +299,6 @@ Deleting a product can’t be undone. You’ll lose all the product information. To delete a product: 1. Go to the Products page. -2. Click on the icon next to the product you want to delete. +2. Click on the icon next to the product you want to delete. 3. Click on Delete from the dropdown. 4. Confirm deleting the product by clicking the “Yes, confirm” button in the pop-up. diff --git a/docs/content/user-guide/regions/manage.mdx b/docs/content/user-guide/regions/manage.mdx index 6038ff6db0..0bf73a0e03 100644 --- a/docs/content/user-guide/regions/manage.mdx +++ b/docs/content/user-guide/regions/manage.mdx @@ -24,7 +24,7 @@ This opens the Regions page where you can find a list of regions. To create a region: 1. Go to Settings → Regions. -2. Click on the icon at the top right of the Regions section. +2. Click on the icon at the top right of the Regions section. 3. In the form that opens you must enter the Regions details: - It is required to enter a title, choose a currency, enter a tax rate, and at least choose one country, payment provider, and fulfillment provider. - You can optionally enter a tax code for the region. Alternatively, you can [edit a region’s tax settings](../taxes/manage.md#edit-a-regions-taxes) after creation. @@ -46,7 +46,7 @@ To edit a region's basic information: 1. Go to Settings → Regions. 2. Click on the region you want to edit from the Regions section. This shows sections to the right to edit different information and data related to the region. -4. Click on the icon at the top right of the first region. +4. Click on the icon at the top right of the first region. 5. This opens a new window where you can edit the region's details. 6. Once done, click on the "Save and close" button. @@ -64,6 +64,6 @@ To delete a region: 1. Go to Settings → Regions. 2. Click on the region you want to duplicate from the Regions section. -3. In the first section on the right, click on the icon. +3. In the first section on the right, click on the icon. 4. Choose Delete Region from the dropdown list. 5. Confirm deleting the region by clicking the “Yes, confirm" button in the pop-up. \ No newline at end of file diff --git a/docs/content/user-guide/regions/providers.mdx b/docs/content/user-guide/regions/providers.mdx index c948574ea8..f1246427d5 100644 --- a/docs/content/user-guide/regions/providers.mdx +++ b/docs/content/user-guide/regions/providers.mdx @@ -23,7 +23,7 @@ To add or remove a payment provider in a region: 1. Go to Settings → Regions. 2. Select a region to edit. -3. Click on the icon at the top right of the first section on the right. +3. Click on the icon at the top right of the first section on the right. 4. Click on Edit Region Details from the dropdown. 5. Under the providers section, select the payment providers you want to add to the region. 6. Unselect the payment providers you want to remove from the region. @@ -37,7 +37,7 @@ To add or remove a fulfillment provider in a region: 1. Go to Settings → Regions. 2. Select a region to edit. -3. Click on the icon at the top right of the first section on the right. +3. Click on the icon at the top right of the first section on the right. 4. Click on Edit Region Details from the dropdown. 5. Under the providers section, select the fulfillment providers you want to add to the region. 6. Unselect the fulfillment providers you want to remove from the region. diff --git a/docs/content/user-guide/regions/shipping-options.mdx b/docs/content/user-guide/regions/shipping-options.mdx index aeb5112b5f..da97383cb6 100644 --- a/docs/content/user-guide/regions/shipping-options.mdx +++ b/docs/content/user-guide/regions/shipping-options.mdx @@ -61,7 +61,7 @@ To delete a shipping option: 1. Go to Settings → Regions. 2. Select a region to edit. 3. Scroll down to the Shipping Options section on the right side. -4. Find the shipping option you want to edit and click on the icon at its right. +4. Find the shipping option you want to edit and click on the icon at its right. 5. Click on Delete in the dropdown. --- @@ -92,7 +92,7 @@ To edit a return shipping option: 1. Go to Settings → Regions. 2. Select a region to edit. 3. Scroll down to the Return Shipping Options section on the right side. -4. Find the shipping option you want to edit and click on the icon at its right. +4. Find the shipping option you want to edit and click on the icon at its right. 5. Click on Edit in the dropdown. 6. A new window will open with the fields that you can edit. You can edit all of the fields you chose while adding the shipping option except for the Shipping Profile and Fulfillment Method. 7. Once you’re done, click the Save and close button. @@ -110,5 +110,5 @@ To delete a return shipping option: 1. Go to Settings → Regions. 2. Select a region to edit. 3. Scroll down to the Return Shipping Options section on the right side. -4. Find the shipping option you want to edit and click on the icon at its right. +4. Find the shipping option you want to edit and click on the icon at its right. 5. Click on Delete in the dropdown. diff --git a/docs/content/user-guide/sales-channels/manage.mdx b/docs/content/user-guide/sales-channels/manage.mdx index 16e0f25d90..18d7fea59d 100644 --- a/docs/content/user-guide/sales-channels/manage.mdx +++ b/docs/content/user-guide/sales-channels/manage.mdx @@ -24,10 +24,10 @@ This opens the Sales Channels page where you can see the list of Sales channels To search sales channels: 1. Go to Settings → Sales Channels -2. In the Sales Channels section on the left, click on the icon next to the title of the section. +2. In the Sales Channels section on the left, click on the icon next to the title of the section. 3. This shows an input to search sales channels by title and description. -To clear the search, click on the icon in the search input. +To clear the search, click on the icon in the search input. --- @@ -36,7 +36,7 @@ To clear the search, click on the icon next to the title of the section. +2. In the Sales Channels section on the left, click on the icon next to the title of the section. 3. The form to create a new sales channel will open. The name of the sales channel is required, but the description is optional. 4. Once you’re done, you can either: - Click Save as draft to save the sales channel as disabled. @@ -52,7 +52,7 @@ To enable or disable a sales channel: 1. Go to Settings → Sales Channels 2. In the sales channels list on the left, choose the sales channel you want to enable/disable. -3. At the top right of the right section, you can find the status of the sales channel, with a icon if it’s enabled or a icon if it’s disabled. +3. At the top right of the right section, you can find the status of the sales channel, with a icon if it’s enabled or a icon if it’s disabled. 4. Click on the status, and a dropdown will show to toggle the status. For example, if the status of the sales channel is Enabled, the dropdown will show a Disabled status. 5. Choose the status in the dropdown, and the status of the sales channel will change. @@ -64,7 +64,7 @@ To edit a sales channel’s information: 1. Go to Settings → Sales Channels 2. In the sales channels list on the left, choose the sales channel you want to edit. -3. At the top right of the right section, click on the icon. +3. At the top right of the right section, click on the icon. 4. Choose from the dropdown list “Edit general info”. 5. This opens a form in a window where you can edit the name and description of the sales channel. 6. Once done, click Save. @@ -83,6 +83,6 @@ To delete a sales channel: 1. Go to Settings → Sales Channels 2. In the sales channels list on the left, choose the sales channel you want to delete. -3. At the top right of the right section, click on the icon. +3. At the top right of the right section, click on the icon. 4. Choose from the dropdown list “Delete channel”. 5. Confirm deleting the tax rate by clicking the “Yes, delete” button in the pop-up. diff --git a/docs/content/user-guide/sales-channels/products.mdx b/docs/content/user-guide/sales-channels/products.mdx index 47a31f4aa1..41c8b3a6d7 100644 --- a/docs/content/user-guide/sales-channels/products.mdx +++ b/docs/content/user-guide/sales-channels/products.mdx @@ -21,7 +21,7 @@ To add products to a sales channel: 1. Go to Settings → Sales Channels 2. In the sales channels list on the left, choose the sales channel you want to add products to. -3. At the top right of the right section, click on the icon. +3. At the top right of the right section, click on the icon. 4. Choose from the dropdown list “Add products”. 5. This opens a window to add products with filters and search functionalities similar to those of a product page. Select the products you want to add to the sales channel. 6. Click Save. @@ -47,5 +47,5 @@ To remove a product from a sales channel: 1. Go to Settings → Sales Channels 2. In the sales channels list on the left, choose the sales channel you want to remove the product from. 3. Find the product you want to remove from the sales channel. -4. Click the icon at the right side of the product’s row. +4. Click the icon at the right side of the product’s row. 5. Choose from the dropdown list “Remove from the channel”. \ No newline at end of file diff --git a/docs/content/user-guide/taxes/tax-overrides.mdx b/docs/content/user-guide/taxes/tax-overrides.mdx index 65bcef961a..86ff054f60 100644 --- a/docs/content/user-guide/taxes/tax-overrides.mdx +++ b/docs/content/user-guide/taxes/tax-overrides.mdx @@ -49,9 +49,9 @@ To edit an override: 1. Go to Settings → Taxes 2. Select the region that the tax rate you want to edit belongs to. -3. From the list of tax rates in the Details section, find the tax rate that the override you want to edit belongs to and click the icon. +3. From the list of tax rates in the Details section, find the tax rate that the override you want to edit belongs to and click the icon. 4. Under the overrides section, find the override type you want to edit. For example, if you want to add a product to the overrides, find the override with the title “Product Rules”. -5. Click on the icon next to the override type. +5. Click on the icon next to the override type. 6. Choose Edit from the dropdown. 7. You can then change the selected entries for the override type. 8. Once done, click Add. @@ -71,8 +71,8 @@ To delete an override: 1. Go to Settings → Taxes 2. Select the region that the tax rate you want to edit belongs to. -3. From the list of tax rates in the Details section, find the tax rate that the override you want to delete belongs to and click the icon. +3. From the list of tax rates in the Details section, find the tax rate that the override you want to delete belongs to and click the icon. 4. Under the overrides section, find the override type you want to delete. -5. Click on the icon next to the override type. +5. Click on the icon next to the override type. 6. Choose “Delete rule” from the dropdown. 7. Click Save. diff --git a/docs/content/user-guide/taxes/tax-rates.mdx b/docs/content/user-guide/taxes/tax-rates.mdx index 9d2574ebed..4e535158fc 100644 --- a/docs/content/user-guide/taxes/tax-rates.mdx +++ b/docs/content/user-guide/taxes/tax-rates.mdx @@ -33,7 +33,7 @@ To edit a tax rate: 1. Go to Settings → Taxes 2. Select the region that the tax rate you want to edit belongs to. -3. From the list of tax rates in the Details section, find the tax rate you want to edit and click the icon. +3. From the list of tax rates in the Details section, find the tax rate you want to edit and click the icon. 4. Choose Edit from the dropdown. 5. In the form that opens in the new window, you can edit the basic details of the tax rate such as the name or rate. If you’re editing a tax rate that’s not the default, you can [manage overrides of this tax rate](./tax-overrides.mdx). 6. Once done, click Save. @@ -52,7 +52,7 @@ To delete a tax rate: 1. Go to Settings → Taxes 2. Select the region that the tax rate you want to delete belongs to. -3. From the list of tax rates in the Details section, find the tax rate you want to delete and click the icon. +3. From the list of tax rates in the Details section, find the tax rate you want to delete and click the icon. 4. Choose Delete Tax Rate from the dropdown. 5. Confirm deleting the tax rate by clicking the “Yes, confirm” button in the pop-up. diff --git a/docs/content/user-guide/users/team.mdx b/docs/content/user-guide/users/team.mdx index ef3adb097b..4565624b8d 100644 --- a/docs/content/user-guide/users/team.mdx +++ b/docs/content/user-guide/users/team.mdx @@ -32,7 +32,7 @@ If you want the user to receive a new email with the invite link, you can resend To resend an invite to a user: 1. Go to your team page. -2. Find the user that you want to resend an invite to, then click on the icon at its right. +2. Find the user that you want to resend an invite to, then click on the icon at its right. 3. Click on Resend Invitation from the dropdown. ### Get Invite Link @@ -42,7 +42,7 @@ In addition to sending the user an invite, you can copy the invite link and send To copy the invite link: 1. Go to your team page. -2. Find the user invite, then click on the icon at its right. +2. Find the user invite, then click on the icon at its right. 3. Click on “Copy invite link” from the dropdown. ### Remove Invite @@ -56,7 +56,7 @@ Removing an invite would prevent the invited user from joining the team, even if To remove an invite: 1. Go to your team page. -2. Find the user invite, then click on the icon at its right. +2. Find the user invite, then click on the icon at its right. 3. Click on “Remove invitation” from the dropdown. 4. Confirm removing the invitation by clicking the “Yes, remove” button in the pop-up. @@ -65,7 +65,7 @@ To remove an invite: To edit a user’s details in your team: 1. Go to your team page. -2. Find the user and click on the icon at its right. +2. Find the user and click on the icon at its right. 3. In the new form, edit any of the user’s information. 4. Once done, click on the Save button. @@ -80,6 +80,6 @@ Removing a user from a team can’t be done. The user’s details will be lost. To remove a user from your team: 1. Go to your team page. -2. Find the user and click on the icon at its right. +2. Find the user and click on the icon at its right. 3. Click on Remove User from the dropdown. 4. Confirm removing the user by clicking the “Yes, remove” button in the pop-up.