diff --git a/docs/content/add-plugins/minio.md b/docs/content/add-plugins/minio.md index 551149ae6d..3053b7f007 100644 --- a/docs/content/add-plugins/minio.md +++ b/docs/content/add-plugins/minio.md @@ -46,7 +46,11 @@ Then configure your `medusa-config.js` to include the plugin alongside the requi The two access keys in the options are the ones created in the previous section. -> Make sure to use an environment variable for the secret key in a live environment. +:::tip + +Make sure to use an environment variable for the secret key in a live environment. + +::: ### Try it out diff --git a/docs/content/add-plugins/s3.md b/docs/content/add-plugins/s3.md index d3059732c0..0fdf04a4bf 100644 --- a/docs/content/add-plugins/s3.md +++ b/docs/content/add-plugins/s3.md @@ -78,7 +78,11 @@ https://[bucket].s3.[region].amazonaws.com The two access keys in the options are the ones created in the previous section. -> Make sure to use an environment variable for the secret key in a live environment. +:::tip + + Make sure to use an environment variable for the secret key in a live environment. + +::: ### Try it out diff --git a/docs/content/add-plugins/segment.md b/docs/content/add-plugins/segment.md index eccf0c414f..ebf1fbb72a 100644 --- a/docs/content/add-plugins/segment.md +++ b/docs/content/add-plugins/segment.md @@ -21,7 +21,11 @@ Common integration use cases that can be implemented with Segment include: ## Adding Segment to your Medusa store -> Note: you should create a [Node.js source in Segment](https://segment.com/docs/connections/sources/catalog/libraries/server/node/quickstart/) in order to obtain the write key that will be provided in the plugin options. +:::note + +You should create a [Node.js source in Segment](https://segment.com/docs/connections/sources/catalog/libraries/server/node/quickstart/) in order to obtain the write key that will be provided in the plugin options. + +::: Plugins in Medusa's ecosystem come as separate npm packages, that can be installed from the npm registry. diff --git a/docs/content/add-plugins/spaces.md b/docs/content/add-plugins/spaces.md index 27d856e030..7119db049a 100644 --- a/docs/content/add-plugins/spaces.md +++ b/docs/content/add-plugins/spaces.md @@ -47,7 +47,11 @@ Then configure your `medusa-config.js` to include the plugin alongside the requi In the above options, a `spaces_url` is included. This can be found in your Space overview. The `bucket` should point to the name you gave your Space. The `endpoint` identifies the region in which you created the Space. And finally the two keys are the ones created in the previous section. -> Make sure to use an environment variable for the secret key in a live environment. +:::tip + +Make sure to use an environment variable for the secret key in a live environment. + +::: ### Try it out! diff --git a/docs/content/add-plugins/strapi.md b/docs/content/add-plugins/strapi.md index 1ec6ebac98..91f6e6c92d 100644 --- a/docs/content/add-plugins/strapi.md +++ b/docs/content/add-plugins/strapi.md @@ -37,7 +37,11 @@ Alternatively, using Yarn: yarn create medusa-app ``` -> When choosing `npx` you are shown different store engine options as part of the setup. For this Strapi tutorial, you should choose `medusa-starter-default`. Optionally, pick a storefront. +:::note + +When choosing `npx` you are shown different store engine options as part of the setup. For this Strapi tutorial, you should choose `medusa-starter-default`. Optionally, pick a storefront. + +::: **Use `medusa-cli`** `@medusajs/medusa-cli` is our Command Line Tool for creating the Medusa store engine (alongside many other powerful commands). First, install it: @@ -116,12 +120,19 @@ Alternatively, using Yarn: yarn global add create-strapi-app@3.6.8 create-strapi-app strapi-medusa --template https://github.com/Deathwish98/strapi-medusa-template.git ``` +:::note -> Note: The plugin expects node version to be '>= 10.16.0 and <=14.x.x', otherwise it will throw an error. +The plugin expects node version to be '>= 10.16.0 and <=14.x.x', otherwise it will throw an error. + +::: After running the command, you have a full Strapi project configured to synchronize with Medusa. Upon the initial start of the Strapi server, all the required models will be created. They will correlate with models from Medusa to allow for two-way synchronization. -> Note: The Strapi template starter uses SQLite as the default database. There is a known bug related to `knex.js` that comes from multiple write connections. Restarting the Strapi server should make the error disappear. +:::caution + +The Strapi template starter uses SQLite as the default database. There is a known bug related to `knex.js` that comes from multiple write connections. Restarting the Strapi server should make the error disappear. + +::: **Synchronization** @@ -133,7 +144,11 @@ When products are created in Medusa, the two-way communication ensures that data **Variants**: title **Region**: name -> Further down the road, the support for synchronizing more entities is expected to be introduced +:::note + +Further down the road, the support for synchronizing more entities is expected to be introduced + +::: **Using Postgres in Medusa (optional)** @@ -157,7 +172,11 @@ projectConfig: { }, ``` -> Note: the `DATABASE_URL` variable should use the Postgres database created in the previous step +:::tip + +The `DATABASE_URL` variable should use the Postgres database created in the previous step + +::: ## Summary and next steps diff --git a/docs/content/advanced/backend/payment/frontend-payment-flow-in-checkout.md b/docs/content/advanced/backend/payment/frontend-payment-flow-in-checkout.md index f18c3746aa..eeb1ba83a9 100644 --- a/docs/content/advanced/backend/payment/frontend-payment-flow-in-checkout.md +++ b/docs/content/advanced/backend/payment/frontend-payment-flow-in-checkout.md @@ -2,12 +2,17 @@ ## Introduction The purpose of this guide is to describe a checkout flow in Medusa. It is assumed that you've completed our [Quickstart](https://docs.medusajs.com/quickstart/quick-start) or [Tutorial](https://docs.medusajs.com/tutorial/set-up-your-development-environment) and are familiar with the technologies we use in our stack. Additionally, having an understanding of the [core API](https://docs.medusajs.com/api/store/auth) would serve as a great foundation for this walkthrough. -> All code snippets in the following guide, use the JS SDK distributed through **npm**. To install it, run: + +:::note + +All code snippets in the following guide, use the JS SDK distributed through **npm**. To install it, run: ```bash npm2yarn npm install @medusajs/medusa-js ``` +::: + ## Glossary - **Cart**: The Cart contains all the information needed for customers to complete an Order. In the Cart customers gather the items they wish to purchase, they add shipping and billing details and complete payment information. - **LineItem**: Line Items represent an expense added to a Cart. Typically this will be a Product Variant and a certain quantity of the same variant. Line Items hold descriptive fields that help communicate its contents and price. @@ -17,7 +22,12 @@ npm install @medusajs/medusa-js ## Checkout flow To create an order from a cart, we go through the following flow. -> At this point, it assumed that the customer has created a cart, added items and is now at the initial step of the checkout flow. + +:::note + +At this point, it assumed that the customer has created a cart, added items and is now at the initial step of the checkout flow. + +::: ### Initializing the checkout The first step in the flow is to _initialize_ the configured Payment Sessions for the Cart. If you are using the `medusa-starter-default` starter, this call will result in the `cart.payment_sessions` array being filled with one Payment Session for the manual payment provider. diff --git a/docs/content/advanced/backend/subscribers/create-subscriber.md b/docs/content/advanced/backend/subscribers/create-subscriber.md index c902ca7d0a..f8e711419d 100644 --- a/docs/content/advanced/backend/subscribers/create-subscriber.md +++ b/docs/content/advanced/backend/subscribers/create-subscriber.md @@ -69,7 +69,11 @@ export default OrderNotifierSubscriber; This subscriber will register the method `handleOrder` as one of the handlers of the `order.placed` event. The method `handleOrder` will be executed every time an order is placed, and it will receive the order ID in the `data` parameter. You can then use the order’s details to perform any kind of task you need. -> The `data` object will not contain other order data. Only the ID of the order. You can retrieve the order information using the `orderService`. +:::note + +The `data` object will not contain other order data. Only the ID of the order. You can retrieve the order information using the `orderService`. + +::: ## Using Services in Subscribers diff --git a/docs/content/guides/plugins.md b/docs/content/guides/plugins.md index 2516702c5c..07fcf5e36d 100644 --- a/docs/content/guides/plugins.md +++ b/docs/content/guides/plugins.md @@ -12,7 +12,11 @@ Plugins offer a way to extend and integrate the core functionality of Medusa. In most commerce solutions, you can extend the basic features but it often comes with the expense of having to build standalone web applications. Our architecture is built such that plugins run within the same process as the core eliminating the need for extra server capacity, infrastructure and maintenance. As a result, the plugins can use all other services as dependencies and access the database. -> You will notice that plugins vary in naming. The name should signal what functionality they provide. +:::note + +You will notice that plugins vary in naming. The name should signal what functionality they provide. + +::: In the following sections, we will go through the basics of implementing a generic plugin. And finally, how to use it as part of your commerce setup. @@ -34,7 +38,11 @@ We've already gone through the process of building custom services, endpoints, a To quickly get started with the implementation, we advise you to copy `/services/welcome.js`, `/api/index.js`, `/subscribers/welcome.js` and the config files from the tutorial and add them in `/src`. As a result, you should have the following folder structure: -> Please note: since the container resolution paths are automatically generated from the used directories and filenames you should avoid pre- or suffixing your file (e.g. `services/welcomeService.js` would result in the service being registered as `WelcomeServiceService`). +:::note + +Since the container resolution paths are automatically generated from the used directories and filenames you should avoid pre- or suffixing your file (e.g. `services/welcomeService.js` would result in the service being registered as `WelcomeServiceService`). + +::: ```js . @@ -55,7 +63,11 @@ Please note that you will need some build step before being able to properly loa It is worth mentioning the difference between building a generic and a non-generic plugin. A non-generic plugin has a specific purpose such as processing payments or creating fulfillments. Medusa core depends on a specific implementation from such plugins, which is why we've created interfaces that enforce this. These can be found in `medusa-interfaces`. -> Note: Non-generic plugins are required to extend the correct interface, otherwise they will not be loaded correctly as part of your Medusa setup. +:::note + +Non-generic plugins are required to extend the correct interface, otherwise they will not be loaded correctly as part of your Medusa setup. + +::: For a more comprehensive walkthrough of the implementation of such plugins, see our guides: diff --git a/docs/content/homepage.mdx b/docs/content/homepage.mdx index 65950a1444..63a7c8740d 100644 --- a/docs/content/homepage.mdx +++ b/docs/content/homepage.mdx @@ -23,35 +23,35 @@ You can learn more about Medusa's architecture in [our introduction](/introducti ![Medusa's Architecture](https://i.imgur.com/ZHvM2bu.png) -
-
-
- -
+
+
+
+ +

Tutorial

Set up your local development environment

-
- -
+
+ +

Make it your own

Create custom endpoints, services, or subscribers.

-
- -
+
+ +

Plugins

Add or build a plugin to make your engine more powerful.

-
- -
+
+ +

Deploy in seconds

Use one of our guides to deploy your Medusa project in seconds.

@@ -66,28 +66,28 @@ Visit our [Quickstart](https://github.com/medusajs/medusa#-quickstart) to get up ## What you'll find here -
-
-
- -
+
+
+
+ +

Quickstart

A short guide to get you quickly started.

-
- -
+
+ +

How-to and guides

Guides and walkthroughs of concepts, tools, deployment and APIs.

{/* Ref */} -
- -
+
+ +

Reference

Technical documentation of the Medusa API.

diff --git a/docs/content/how-to/deploying-admin-on-netlify.md b/docs/content/how-to/deploying-admin-on-netlify.md index 018b99422b..c956b08c65 100644 --- a/docs/content/how-to/deploying-admin-on-netlify.md +++ b/docs/content/how-to/deploying-admin-on-netlify.md @@ -6,7 +6,11 @@ title: "Deploying Admin on Netlify" This is a guide for deploying Medusa Admin on Netlify. Netlify is a platform that offers hosting and backend services for applications and static websites. -> At this point, you should have a running instance of Medusa Admin. If not, check out [these steps](https://github.com/medusajs/admin#-setting-up-admin) or use `npx create-medusa-app` to set up your application in a matter of minutes. For the latter, see [this guide](https://docs.medusajs.com/how-to/create-medusa-app) for a small walkthrough. +:::note + +At this point, you should have a running instance of Medusa Admin. If not, check out [these steps](https://github.com/medusajs/admin#-setting-up-admin) or use `npx create-medusa-app` to set up your application in a matter of minutes. For the latter, see [this guide](https://docs.medusajs.com/how-to/create-medusa-app) for a small walkthrough. + +::: ### 1. Install the Netlify CLI @@ -62,7 +66,11 @@ git push origin main Within a couple of minutes, your Medusa Admin is live and running on Netlify. -> If you experience CORS issues in your new setup, you might need to add your admin url as part of the ADMIN_CORS environment variable in your server setup. +:::tip + +If you experience CORS issues in your new setup, you might need to add your admin url as part of the ADMIN_CORS environment variable in your server setup. + +::: ### What's next? diff --git a/docs/content/how-to/deploying-on-digital-ocean.md b/docs/content/how-to/deploying-on-digital-ocean.md index 3b6f8bded5..ecfb8a120e 100644 --- a/docs/content/how-to/deploying-on-digital-ocean.md +++ b/docs/content/how-to/deploying-on-digital-ocean.md @@ -2,7 +2,11 @@ This is a guide for deploying a Medusa project on DigitalOcean App Platform. -> It is assumed, that you are currently running a local instance of Medusa. If not, check out our [Quickstart](https://docs.medusajs.com/quickstart/quick-start) or use `npx create-medusa-app` to set up your application in a matter of minutes. For the latter, see [this guide](https://docs.medusajs.com/how-to/create-medusa-app) for a small walkthrough. +:::note + +It is assumed, that you are currently running a local instance of Medusa. If not, check out our [Quickstart](https://docs.medusajs.com/quickstart/quick-start) or use `npx create-medusa-app` to set up your application in a matter of minutes. For the latter, see [this guide](https://docs.medusajs.com/how-to/create-medusa-app) for a small walkthrough. + +::: ### 1. Configure Medusa @@ -83,7 +87,11 @@ Navigate to the top-right dropdown **Create** and select **Apps**. Choose **GitHub** or **GitLab** and select the repository that holds your Medusa project. Check **Autodeploy code changes**, if you want DigitalOcean to deploy on every push to your repository. -> It's important, that DigitalOcean is pointing to the directory holding the Medusa store engine as it is only this which that will be deployed (If you followed the quickstart guide this will simply be the created project, and if you used the npx command this will be the backend folder inside of the newly created project). +:::tip + +It's important, that DigitalOcean is pointing to the directory holding the Medusa store engine as it is only this which that will be deployed (If you followed the quickstart guide this will simply be the created project, and if you used the npx command this will be the backend folder inside of the newly created project). + +::: ### 5. Configure environment variables @@ -100,7 +108,11 @@ JWT_SECRET=your-jwt-secret COOKIE_SECRET=your-cookie-secret ``` -> Make sure to use actual secrets in a production environment +:::tip + +Make sure to use actual secrets in a production environment + +::: ### 6. Set up a Database diff --git a/docs/content/how-to/deploying-on-heroku.md b/docs/content/how-to/deploying-on-heroku.md index 2d9013ae1d..7695b94217 100644 --- a/docs/content/how-to/deploying-on-heroku.md +++ b/docs/content/how-to/deploying-on-heroku.md @@ -12,7 +12,11 @@ This is a guide for deploying a Medusa project on Heroku. Heroku is at PaaS that
-> We assume, that you are currently running a local instance of Medusa. If not, check out our [Quickstart](https://docs.medusajs.com/quickstart/quick-start) or use `npx create-medusa-app` to set up your application in a matter of minutes. For the latter, see [this guide](https://docs.medusajs.com/how-to/create-medusa-app) for a small walkthrough. +:::note + +We assume, that you are currently running a local instance of Medusa. If not, check out our [Quickstart](https://docs.medusajs.com/quickstart/quick-start) or use `npx create-medusa-app` to set up your application in a matter of minutes. For the latter, see [this guide](https://docs.medusajs.com/how-to/create-medusa-app) for a small walkthrough. + +::: ### 1. Install the Heroku CLI @@ -45,7 +49,11 @@ Connect to your Heroku account from your terminal: heroku login ``` -> Follow the instructions on your terminal +:::note + +Follow the instructions on your terminal + +::: ### 3. Create an app on Heroku @@ -60,7 +68,11 @@ heroku git:remote -a medusa-test-app Medusa requires a Postgres database and a Redis instance to work. These are added through the Heroku CLI using the following commands. -> In this below example, we initialize the resources on free plans. This is not a valid configuration for a production environment. +:::tip + +In this below example, we initialize the resources on free plans. This is not a valid configuration for a production environment. + +::: #### Postgresql @@ -76,7 +88,11 @@ You can find more informations, plans and pricing about Heroku Postgres [here](h Add a Redis instance to your Heroku app -> The addon `redistogo:nano` is free, but Heroku requires you to add a payment method to proceed. +:::note + +The addon `redistogo:nano` is free, but Heroku requires you to add a payment method to proceed. + +::: ```bash heroku addons:create redistogo:nano @@ -94,8 +110,11 @@ heroku config:set JWT_SECRET=your-super-secret heroku config:set COOKIE_SECRET=your-super-secret-pt2 heroku config:set NPM_CONFIG_PRODUCTION=false ``` +:::tip -> Make sure to use actual secrets in a production environment. +Make sure to use actual secrets in a production environment. + +::: Additionally, we need to set the buildpack to Node.js diff --git a/docs/content/how-to/deploying-on-qovery.md b/docs/content/how-to/deploying-on-qovery.md index 23c221384d..811691a983 100644 --- a/docs/content/how-to/deploying-on-qovery.md +++ b/docs/content/how-to/deploying-on-qovery.md @@ -2,7 +2,11 @@ This is a guide for deploying a Medusa project to Qovery. Qovery is a Continuous Deployment Platform, that provides you with the developer experience of Heroku on top of your cloud provider (e.g. AWS, DigitalOcean). -> We assume, that you are currently running a local instance of Medusa. If not, check out our [Quickstart](https://docs.medusajs.com/quickstart/quick-start) or use `npx create-medusa-app` to set up your application in a matter of minutes. For the latter, see [this guide](https://docs.medusajs.com/how-to/create-medusa-app) for a small walkthrough. +:::note + +We assume, that you are currently running a local instance of Medusa. If not, check out our [Quickstart](https://docs.medusajs.com/quickstart/quick-start) or use `npx create-medusa-app` to set up your application in a matter of minutes. For the latter, see [this guide](https://docs.medusajs.com/how-to/create-medusa-app) for a small walkthrough. + +::: ### 1. Qovery Console @@ -16,7 +20,11 @@ Create a project and an environment. Add a new app to your Qovery environment and connect the Git repository that holds your Medusa project. In your application settings, set the port to 9000 unless something else is specified in your setup. -> If you used our `npx` starter, your repository will most likely hold all components; storefront, admin and backend. Ensure that **Root application path** in Qovery is pointing to your Medusa project (`/backend`). +:::note + +If you used our `npx` starter, your repository will most likely hold all components; storefront, admin and backend. Ensure that **Root application path** in Qovery is pointing to your Medusa project (`/backend`). + +::: ### 4. Add a database @@ -61,10 +69,14 @@ module.exports = { }; ``` -> **IMPORTANT**: We are using the Qovery community plan, that does not allow SSL connections for the database, so this is disabled. -> -> In a production environment, you would need the following in the config: -> `database_extra: { ssl: { rejectUnauthorized: false } }` +:::caution IMPORTANT + +We are using the Qovery community plan, that does not allow SSL connections for the database, so this is disabled. + +In a production environment, you would need the following in the config: + `database_extra: { ssl: { rejectUnauthorized: false } }` + +::: #### Add some extra variables @@ -75,7 +87,11 @@ JTW_SECRET=something_secret_jwt COOKIE_SECRET=something_secret_cookie ``` -> Make sure to use actual secrets in a production environment. +:::tip + +Make sure to use actual secrets in a production environment. + +::: #### Update `package.json` diff --git a/docs/content/how-to/headless-ecommerce-store-with-gatsby-contentful-medusa.md b/docs/content/how-to/headless-ecommerce-store-with-gatsby-contentful-medusa.md index adfddc1311..506017afcf 100644 --- a/docs/content/how-to/headless-ecommerce-store-with-gatsby-contentful-medusa.md +++ b/docs/content/how-to/headless-ecommerce-store-with-gatsby-contentful-medusa.md @@ -4,7 +4,11 @@ title: Create a headless ecommerce store with Gatsby, Contentful & Medusa # Creating a headless ecommerce store with Gatsby, Contentful and Medusa -> Medusa is an open source headless commerce engine that allow you to create amazing digital commerce experiences. Medusa is highly customizable, allowing you to extend the core to fit your needs. +:::info About Medusa + +Medusa is an open source headless commerce engine that allow you to create amazing digital commerce experiences. Medusa is highly customizable, allowing you to extend the core to fit your needs. + +::: ## Introduction @@ -33,7 +37,11 @@ If you want to jump straight to the code for this series you can checkout: ## Prerequisites -> For a full guide to how to set up your development environment for Medusa please see [the tutorial](https://docs.medusajs.com/tutorials/set-up-your-development-environment) +:::note + +For a full guide to how to set up your development environment for Medusa please see [the tutorial](https://docs.medusajs.com/tutorials/set-up-your-development-environment) + +::: In order to get you started with your Gatsby, Contentful, Medusa store you must complete a couple of installations: diff --git a/docs/content/how-to/making-your-store-more-powerful-with-contentful.md b/docs/content/how-to/making-your-store-more-powerful-with-contentful.md index dbe0f65eb9..afb3a9a346 100644 --- a/docs/content/how-to/making-your-store-more-powerful-with-contentful.md +++ b/docs/content/how-to/making-your-store-more-powerful-with-contentful.md @@ -76,11 +76,13 @@ npm run migrate:contentful --file contentful-migrations/update-page-module-valid To use your new Rich Text module **Content > Page > About**, and click **Add Content > Page**. You will now make use of the new Rich Text module to add some more details about your store. You can write your own text or use the text provided below if you just want to copy/paste. -> ### About Medusa -> -> Medusa is an open-source headless commerce engine for fast-growing businesses. Getting started with Medusa is very easy and you will be able to start selling online with a basic setup in no time, however, the real power of Medusa starts showing up when you add custom functionality and extend your core to fit your needs. -> -> The core Medusa package and all the official Medusa plugins ship as individual NPM packages that you install into a Node project. You store and plugins are configured in your medusa-config.js file making it very easy to manage your store as your business grows. Custom functionality doesn't have to come from plugins, you can also add project-level functionality by simply adding files in your `src/` folder. Medusa will automatically register your custom functionalities in the bootstrap phase. +:::info About Medusa + + Medusa is an open-source headless commerce engine for fast-growing businesses. Getting started with Medusa is very easy and you will be able to start selling online with a basic setup in no time, however, the real power of Medusa starts showing up when you add custom functionality and extend your core to fit your needs. + + The core Medusa package and all the official Medusa plugins ship as individual NPM packages that you install into a Node project. You store and plugins are configured in your medusa-config.js file making it very easy to manage your store as your business grows. Custom functionality doesn't have to come from plugins, you can also add project-level functionality by simply adding files in your `src/` folder. Medusa will automatically register your custom functionalities in the bootstrap phase. + +::: ![](https://i.imgur.com/hqiaoFq.png) @@ -88,7 +90,11 @@ When you have added your text you can click **Publish changes** (make sure the A ## Updating the storefront to support the Rich Text module -> If you want to jump straight to the final frontend code visit [medusajs/medusa-contentful-storefront@part-2](https://github.com/medusajs/medusa-contentful-storefront/tree/part-2). +:::note + + If you want to jump straight to the final frontend code visit [medusajs/medusa-contentful-storefront@part-2](https://github.com/medusajs/medusa-contentful-storefront/tree/part-2). + +::: To display your newly created Rich Text module open up the storefront code and create a new file at `src/components/rich-text/rich-text.jsx`. diff --git a/docs/content/how-to/notification-api.md b/docs/content/how-to/notification-api.md index c00f1508b4..2e39c2523a 100644 --- a/docs/content/how-to/notification-api.md +++ b/docs/content/how-to/notification-api.md @@ -78,8 +78,12 @@ class MyService extends NotificationService { export default MyService; ``` -> **Note:** a notification service must have a static property called `identifier` this is used to determine which classes are called when subscribing to different events. In this case the service identifier is `my-service` so to subscribe to notifications you must use: -> `notificationService.subscribe([eventname], "my-service")` +:::note + + A notification service must have a static property called `identifier` this is used to determine which classes are called when subscribing to different events. In this case the service identifier is `my-service` so to subscribe to notifications you must use: + `notificationService.subscribe([eventname], "my-service")` + +::: The above class is an example implementation of a NotificationService. It uses a fictional email service called `CoolEmailSender` to send emails to a customer whenever an order is placed. The `sendNotification` implementation gets the event name and fetches relevant data based on what event is being processed; in this case it retrieves an order, which is later used when requesting `CoolEmailSender` to dispatch an email. The address to send the email to is likewise fetched from the order. diff --git a/docs/content/how-to/setting-up-a-nextjs-storefront-for-your-medusa-project.md b/docs/content/how-to/setting-up-a-nextjs-storefront-for-your-medusa-project.md index 7b04466b0f..b9015c23c5 100644 --- a/docs/content/how-to/setting-up-a-nextjs-storefront-for-your-medusa-project.md +++ b/docs/content/how-to/setting-up-a-nextjs-storefront-for-your-medusa-project.md @@ -4,8 +4,12 @@ title: Setting up a Next.js storefront for your Medusa project # Setting up a Next.js storefront for your Medusa project -> Medusa is a headless open source commerce platform giving engineers the foundation for building unique and scalable digital commerce projects through our API-first engine. -> Being headless, our starters serve as a good foundation for you to get coupled with a frontend in a matter of minutes. +:::note + +Medusa is a headless open source commerce platform giving engineers the foundation for building unique and scalable digital commerce projects through our API-first engine. +Being headless, our starters serve as a good foundation for you to get coupled with a frontend in a matter of minutes. + +::: This article assumes you already have the Medusa project created and ready to be linked to your Next.js starter. diff --git a/docs/content/how-to/uploading-images-to-minio.md b/docs/content/how-to/uploading-images-to-minio.md index df96e1b730..a1debe2340 100644 --- a/docs/content/how-to/uploading-images-to-minio.md +++ b/docs/content/how-to/uploading-images-to-minio.md @@ -46,7 +46,11 @@ Then configure your `medusa-config.js` to include the plugin alongside the requi The two access keys in the options are the ones created in the previous section. -> Make sure to use an environment variable for the secret key in a live environment. +:::tip + +Make sure to use an environment variable for the secret key in a live environment. + +::: ### Try it out diff --git a/docs/content/how-to/uploading-images-to-s3.md b/docs/content/how-to/uploading-images-to-s3.md index 12c8a36ff5..2688fb54af 100644 --- a/docs/content/how-to/uploading-images-to-s3.md +++ b/docs/content/how-to/uploading-images-to-s3.md @@ -78,7 +78,11 @@ https://[bucket].s3.[region].amazonaws.com The two access keys in the options are the ones created in the previous section. -> Make sure to use an environment variable for the secret key in a live environment. +:::tip + +Make sure to use an environment variable for the secret key in a live environment. + +::: ### Try it out diff --git a/docs/content/how-to/uploading-images-to-spaces.md b/docs/content/how-to/uploading-images-to-spaces.md index 4ad47a48d6..46ffcab614 100644 --- a/docs/content/how-to/uploading-images-to-spaces.md +++ b/docs/content/how-to/uploading-images-to-spaces.md @@ -41,7 +41,11 @@ Then configure your `medusa-config.js` to include the plugin alongside the requi In the above options, a `spaces_url` is included. This can be found in your Space overview. The `bucket` should point to the name you gave your Space. The `endpoint` identifies the region in which you created the Space. And finally the two keys are the ones created in the previous section. -> Make sure to use an environment variable for the secret key in a live environment. +:::tip + +Make sure to use an environment variable for the secret key in a live environment. + +::: ### Try it out! diff --git a/docs/content/quickstart/quick-start.md b/docs/content/quickstart/quick-start.md index c41b518a41..75a6db3794 100644 --- a/docs/content/quickstart/quick-start.md +++ b/docs/content/quickstart/quick-start.md @@ -50,7 +50,11 @@ We have created two starters for you that can help you lay a foundation for your - [Nextjs Starter](https://github.com/medusajs/nextjs-starter-medusa) - [Gatsby Starter](https://github.com/medusajs/gatsby-starter-medusa) -> Note: Medusa runs on port 9000 by default and the storefront starters are both configured to run on port 8000. If you wish to run your storefront starter on another port you should update your CORS settings in your project's `medusa-config.js`. +:::tip + +Medusa runs on port 9000 by default and the storefront starters are both configured to run on port 8000. If you wish to run your storefront starter on another port you should update your CORS settings in your project's `medusa-config.js`. + +:::