-
+
Technical documentation of the Medusa API.
diff --git a/docs/content/how-to/create-medusa-app.md b/docs/content/how-to/create-medusa-app.md index a3394df3c0..77080fda4a 100644 --- a/docs/content/how-to/create-medusa-app.md +++ b/docs/content/how-to/create-medusa-app.md @@ -110,8 +110,8 @@ Create initial git commit in my-medusa-store/admin To learn more about Medusa to go through our docs to get some inspiration and guidance for the next steps and further development: -- [Find out how to set up a Medusa project with Gatsby and Contentful](https://docs.medusa-commerce.com/how-to/headless-ecommerce-store-with-gatsby-contentful-medusa) -- [Move your Medusa setup to the next level with some custom functionality](https://docs.medusa-commerce.com/tutorial/adding-custom-functionality) -- [Create your own Medusa plugin](https://docs.medusa-commerce.com/how-to/plugins) +- [Find out how to set up a Medusa project with Gatsby and Contentful](https://docs.medusajs.com/how-to/headless-ecommerce-store-with-gatsby-contentful-medusa) +- [Move your Medusa setup to the next level with some custom functionality](https://docs.medusajs.com/tutorial/adding-custom-functionality) +- [Create your own Medusa plugin](https://docs.medusajs.com/how-to/plugins) If you have any follow-up questions or want to chat directly with our engineering team we are always happy to meet you at our [Discord](https://discord.gg/DSHySyMu). diff --git a/docs/content/how-to/deploying-admin-on-netlify.md b/docs/content/how-to/deploying-admin-on-netlify.md index 22cd735a5d..c41ae32829 100644 --- a/docs/content/how-to/deploying-admin-on-netlify.md +++ b/docs/content/how-to/deploying-admin-on-netlify.md @@ -6,7 +6,7 @@ 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.medusa-commerce.com/how-to/create-medusa-app) for a small walkthrough. +> 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 @@ -66,4 +66,4 @@ Within a couple of minutes, your Medusa Admin is live and running on Netlify. ### What's next? -If you haven't deployed your Medusa server to use with your new admin, check out our guide [Deploying on Heroku](https://docs.medusa-commerce.com/how-to/deploying-on-heroku). +If you haven't deployed your Medusa server to use with your new admin, check out our guide [Deploying on Heroku](https://docs.medusajs.com/how-to/deploying-on-heroku). diff --git a/docs/content/how-to/deploying-gatsby-on-netlify.md b/docs/content/how-to/deploying-gatsby-on-netlify.md index 1298333ca1..a500fd5eb3 100644 --- a/docs/content/how-to/deploying-gatsby-on-netlify.md +++ b/docs/content/how-to/deploying-gatsby-on-netlify.md @@ -6,7 +6,7 @@ title: "Deploying your Gatsby storefront on Netlify" This is a guide for deploying our [Gatsby storefront starter](https://github.com/medusajs/gatsby-starter-medusa) on Netlify. Netlify is a platform that offers hosting and backend services for applications and static websites. The steps in this guide will work for most Gatsby projects. -> At this point, you should have a local Gatsby storefront project running. If not, check out [our starter](https://github.com/medusajs/gatsby-starter-medusa) or use `npx create-medusa-app` to set up your application in a matter of minutes. For the latter, see [this guide](https://docs.medusa-commerce.com/how-to/create-medusa-app) for a small walkthrough. +> At this point, you should have a local Gatsby storefront project running. If not, check out [our starter](https://github.com/medusajs/gatsby-starter-medusa) 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 @@ -66,6 +66,6 @@ Within a couple of minutes, your Gatsby storefront is up and running on Netlify. ### What's next? -If you haven't deployed your Medusa server to use with your new storefront, check out our guide [Deploying on Heroku](https://docs.medusa-commerce.com/how-to/deploying-on-heroku). +If you haven't deployed your Medusa server to use with your new storefront, check out our guide [Deploying on Heroku](https://docs.medusajs.com/how-to/deploying-on-heroku). Gatsby is not your thing? Check out our [Next.js storefront starter](https://github.com/medusajs/nextjs-starter-medusa). diff --git a/docs/content/how-to/deploying-on-digital-ocean.md b/docs/content/how-to/deploying-on-digital-ocean.md index a4e961fa6b..3b6f8bded5 100644 --- a/docs/content/how-to/deploying-on-digital-ocean.md +++ b/docs/content/how-to/deploying-on-digital-ocean.md @@ -2,7 +2,7 @@ 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.medusa-commerce.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.medusa-commerce.com/how-to/create-medusa-app) for a small walkthrough. +> 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 @@ -163,5 +163,5 @@ You now have an application running on DigitalOcean. This can be scaled and conf Furthermore, you can deploy a Medusa Admin for your application, such that you can start managing your store from an interface. -- [Deploy Admin on Netlify](https://docs.medusa-commerce.com/how-to/deploying-admin-on-netlify) +- [Deploy Admin on Netlify](https://docs.medusajs.com/how-to/deploying-admin-on-netlify) - Deploy Admin on Gatsby Cloud (Coming soon) diff --git a/docs/content/how-to/deploying-on-heroku.md b/docs/content/how-to/deploying-on-heroku.md index 780e25eb23..3fde4d3e56 100644 --- a/docs/content/how-to/deploying-on-heroku.md +++ b/docs/content/how-to/deploying-on-heroku.md @@ -6,7 +6,7 @@ title: "Deploying on Heroku" This is a guide for deploying a Medusa project on Heroku. Heroku is at PaaS that allows you to easily deploy your applications in the cloud. -> We assume, that you are currently running a local instance of Medusa. If not, check out our [Quickstart](https://docs.medusa-commerce.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.medusa-commerce.com/how-to/create-medusa-app) for a small walkthrough. +> 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 @@ -197,5 +197,5 @@ You now have a production ready application running on Heroku. This can be scale Furthermore, you can deploy a Medusa Admin for your application, such that you can start managing your store from an interface. -- [Deploy Admin on Netlify](https://docs.medusa-commerce.com/how-to/deploying-admin-on-netlify) +- [Deploy Admin on Netlify](https://docs.medusajs.com/how-to/deploying-admin-on-netlify) - Deploy Admin on Gatsby Cloud (Coming soon) diff --git a/docs/content/how-to/deploying-on-qovery.md b/docs/content/how-to/deploying-on-qovery.md index ac343b35dd..ab6312c8e2 100644 --- a/docs/content/how-to/deploying-on-qovery.md +++ b/docs/content/how-to/deploying-on-qovery.md @@ -2,7 +2,7 @@ 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.medusa-commerce.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.medusa-commerce.com/how-to/create-medusa-app) for a small walkthrough. +> 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 @@ -118,5 +118,5 @@ You now have an application running on Qovery. This can be scaled and configured Furthermore, you can deploy Medusa Admin for your application, such that you can start managing your store from an interface. -- [Deploy Admin on Netlify](https://docs.medusa-commerce.com/how-to/deploying-admin-on-netlify) +- [Deploy Admin on Netlify](https://docs.medusajs.com/how-to/deploying-admin-on-netlify) - Deploy Admin on Gatsby Cloud (Coming soon) 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 de5c214fcf..b94b227c90 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 @@ -33,7 +33,7 @@ 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.medusa-commerce.com/tutorials/set-up-your-development-environment) +> 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: @@ -142,7 +142,7 @@ module.exports = { #### `/src` -In the `/src` directory there are 4 special subdirectories that are added for you already. These special directories can be used to add custom functionality to your store. Custom functionality can include custom endpoints (configured in `/api`), custom business logic (configured in `/services`), pub/sub-like subscriptions for asyncrhonous integration tasks (configured in `/subscribers`) and finally loader functions to be called when your Medusa server starts up (configured in `/loaders`). If you want to learn more about how to add custom functionality you can checkout [the tutorial](https://docs.medusa-commerce.com/tutorials/adding-custom-functionality). +In the `/src` directory there are 4 special subdirectories that are added for you already. These special directories can be used to add custom functionality to your store. Custom functionality can include custom endpoints (configured in `/api`), custom business logic (configured in `/services`), pub/sub-like subscriptions for asyncrhonous integration tasks (configured in `/subscribers`) and finally loader functions to be called when your Medusa server starts up (configured in `/loaders`). If you want to learn more about how to add custom functionality you can checkout [the tutorial](https://docs.medusajs.com/tutorials/adding-custom-functionality). #### `/data` 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 df29cc86df..b60a8a9ba7 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 @@ -4,7 +4,7 @@ title: Making your store more powerful with Contentful # Making your store more powerful with Contentful -In [part 1](https://docs.medusa-commerce.com/how-to/headless-ecommerce-store-with-gatsby-contentful-medusa/) of this series you have set up [Medusa](https://medusa-commerce.com) with Contentful as your CMS system and added a Gatsby storefront. In this part you will get a further introduction to Contentful and learn how [`medusa-plugin-contentful`](https://github.com/medusajs/medusa/tree/master/packages/medusa-plugin-contentful) can be leveraged to make your store more powerful. Apart from a front page, product pages and a checkout flow, most ecommerce stores also need miscalleneous pages like About and Contact pages. In this guide you will add a Rich Text content module to your Contentful space so that you can make this pages cool. You will also see how the content modules can be used to give your product pages more life. +In [part 1](https://docs.medusajs.com/how-to/headless-ecommerce-store-with-gatsby-contentful-medusa/) of this series you have set up [Medusa](https://medusa-commerce.com) with Contentful as your CMS system and added a Gatsby storefront. In this part you will get a further introduction to Contentful and learn how [`medusa-plugin-contentful`](https://github.com/medusajs/medusa/tree/master/packages/medusa-plugin-contentful) can be leveraged to make your store more powerful. Apart from a front page, product pages and a checkout flow, most ecommerce stores also need miscalleneous pages like About and Contact pages. In this guide you will add a Rich Text content module to your Contentful space so that you can make this pages cool. You will also see how the content modules can be used to give your product pages more life. What you will do in this guide: @@ -306,5 +306,5 @@ In this guide you created a new content model for Rich Text input in Contentful In the next part of this guide you will learn how to implement further commerce functionalities to your site such as adding support for discount codes, region based shopping and more. (Coming soon) -- [Deploying Medusa on Heroku](https://docs.medusa-commerce.com/how-to/deploying-on-heroku) -- [Deploying Medusa Admin on Netlify](https://docs.medusa-commerce.com/how-to/deploying-admin-on-netlify) +- [Deploying Medusa on Heroku](https://docs.medusajs.com/how-to/deploying-on-heroku) +- [Deploying Medusa Admin on Netlify](https://docs.medusajs.com/how-to/deploying-admin-on-netlify) diff --git a/docs/content/how-to/notification-api.md b/docs/content/how-to/notification-api.md index 0e49ec72fd..a3f1e40c6c 100644 --- a/docs/content/how-to/notification-api.md +++ b/docs/content/how-to/notification-api.md @@ -6,7 +6,7 @@ title: Notifications and automated flows ### Introduction -Plugins offer a way to extend and integrate the core functionality of Medusa. For a walkthrough of the implementation details behind these, please see [Plugins in Medusa](https://docs.medusa-commerce.com/how-to/plugins). +Plugins offer a way to extend and integrate the core functionality of Medusa. For a walkthrough of the implementation details behind these, please see [Plugins in Medusa](https://docs.medusajs.com/how-to/plugins). Medusa makes it possible for plugins to implement the Notification API. The API allows for different types of implementations of notifications (emails, text messages, Slack messages, etc), that are sent as a reaction to events in Medusa. All Notifications are stored in the database with information about the receiver of the notification and what plugin was in charge of sending it. This allows merchants to resend notifications, but also gives an overview of what communication has been sent to customers. diff --git a/docs/content/how-to/uploading-images-to-s3.md b/docs/content/how-to/uploading-images-to-s3.md index bc71a22736..f6b8fec896 100644 --- a/docs/content/how-to/uploading-images-to-s3.md +++ b/docs/content/how-to/uploading-images-to-s3.md @@ -4,7 +4,7 @@ In order to work with images in Medusa, you need a file service plugin responsib ### Before you start -At this point, you should have an instance of our store engine running. If not, we have a [full guide](https://docs.medusa-commerce.com/tutorial/set-up-your-development-environment) for setting up your local environment. +At this point, you should have an instance of our store engine running. If not, we have a [full guide](https://docs.medusajs.com/tutorial/set-up-your-development-environment) for setting up your local environment. ### Set up up AWS diff --git a/docs/content/how-to/uploading-images-to-spaces.md b/docs/content/how-to/uploading-images-to-spaces.md index c0c1dc6d85..88a1588a8a 100644 --- a/docs/content/how-to/uploading-images-to-spaces.md +++ b/docs/content/how-to/uploading-images-to-spaces.md @@ -4,7 +4,7 @@ In order to work with images in Medusa, you need a file service plugin responsib ### Before you start -At this point, you should have an instance of our store engine running. If not, we have a [full guide](https://docs.medusa-commerce.com/tutorial/set-up-your-development-environment) for setting up your local environment. +At this point, you should have an instance of our store engine running. If not, we have a [full guide](https://docs.medusajs.com/tutorial/set-up-your-development-environment) for setting up your local environment. ### Set up up DigitalOcean diff --git a/docs/content/quickstart/quick-start.md b/docs/content/quickstart/quick-start.md index fcc16e9475..e904285596 100644 --- a/docs/content/quickstart/quick-start.md +++ b/docs/content/quickstart/quick-start.md @@ -1,6 +1,6 @@ # Quickstart -This quickstart is intended for experienced developers, that are accustomed with concepts like JavaScript, Node.js, SQL and the command line. For a more gentle introduction, see our tutorial on [how to set up your development environment](https://docs.medusa-commerce.com/tutorial/set-up-your-development-environment). +This quickstart is intended for experienced developers, that are accustomed with concepts like JavaScript, Node.js, SQL and the command line. For a more gentle introduction, see our tutorial on [how to set up your development environment](https://docs.medusajs.com/tutorial/set-up-your-development-environment). ## Getting started @@ -21,7 +21,7 @@ This quickstart is intended for experienced developers, that are accustomed with curl localhost:9000/store/products | python -m json.tool ``` -After these four steps and only a couple of minutes, you now have a complete commerce engine running locally. You may now explore [the documentation](https://docs.medusa-commerce.com/api) to learn how to interact with the Medusa API. You may also add [plugins](https://github.com/medusajs/medusa/tree/master/packages) to your Medusa store by specifying them in your `medusa-config.js` file. +After these four steps and only a couple of minutes, you now have a complete commerce engine running locally. You may now explore [the documentation](https://docs.medusajs.com/api) to learn how to interact with the Medusa API. You may also add [plugins](https://github.com/medusajs/medusa/tree/master/packages) to your Medusa store by specifying them in your `medusa-config.js` file. ## What's next? @@ -34,4 +34,4 @@ We have created two starters for you that can help you lay a foundation for your +With your project in local development you can link your Medusa instance to Medusa Cloud - this will allow you to manage your store, view orders and test out the amazing functionalities that you are building. [Get started here](https://docs.medusajs.com/tutorial/linking-your-local-project-with-medusa-cloud). --> diff --git a/packages/medusa-file-s3/README.md b/packages/medusa-file-s3/README.md index e5ea97a571..d7b22d3355 100644 --- a/packages/medusa-file-s3/README.md +++ b/packages/medusa-file-s3/README.md @@ -12,4 +12,4 @@ Upload files to an AWS S3 bucket. region: [region of your bucket], ``` -Follow [this guide](https://docs.medusa-commerce.com/how-to/uploading-images-to-s3) to configure the plugin. +Follow [this guide](https://docs.medusajs.com/how-to/uploading-images-to-s3) to configure the plugin. diff --git a/packages/medusa-file-spaces/README.md b/packages/medusa-file-spaces/README.md index f756dc1cde..ea1a72e246 100644 --- a/packages/medusa-file-spaces/README.md +++ b/packages/medusa-file-spaces/README.md @@ -12,4 +12,4 @@ Upload files to a DigitalOcean Space. endpoint: [endpoint of you DigitalOcean space], ``` -Follow [this guide](https://docs.medusa-commerce.com/how-to/uploading-images-to-spaces) to configure the plugin. +Follow [this guide](https://docs.medusajs.com/how-to/uploading-images-to-spaces) to configure the plugin. diff --git a/packages/medusa-js/README.md b/packages/medusa-js/README.md index ecf063546d..4c7b89fdfb 100644 --- a/packages/medusa-js/README.md +++ b/packages/medusa-js/README.md @@ -6,7 +6,7 @@ The Medusa JS Client provides easy access to the Medusa API from a client writte ## Documentation -See our [API reference](https://docs.medusa-commerce.com/api/store). +See our [API reference](https://docs.medusajs.com/api/store). ## Installation diff --git a/www/docs/docusaurus.config.js b/www/docs/docusaurus.config.js index 69e4e1abc6..246e0f4f0b 100644 --- a/www/docs/docusaurus.config.js +++ b/www/docs/docusaurus.config.js @@ -8,7 +8,7 @@ const algoliaApiKey = process.env.ALGOLIA_API_KEY || "temp" module.exports = { title: "Medusa Commerce", tagline: "Explore and learn how to use Medusa", - url: "https://docs.medusa-commerce.com", + url: "https://docs.medusajs.com", baseUrl: "/", onBrokenLinks: "throw", onBrokenMarkdownLinks: "warn", @@ -47,7 +47,7 @@ module.exports = { }, items: [ { - href: "https://docs.medusa-commerce.com", + href: "https://docs.medusajs.com", label: "Overview", }, { @@ -56,7 +56,7 @@ module.exports = { label: "Tutorial", }, { - href: `https://docs.medusa-commerce.com/api/store`, + href: `https://docs.medusajs.com/api/store`, target: "_self", label: "Reference", }, diff --git a/www/docs/src/theme/SearchBar/index.js b/www/docs/src/theme/SearchBar/index.js index d89f2aa655..294b743ba0 100644 --- a/www/docs/src/theme/SearchBar/index.js +++ b/www/docs/src/theme/SearchBar/index.js @@ -134,7 +134,7 @@ function DocSearch({ contextualSearch, ...props }) { const url = replaceUrl(item) // Need to type out the entire URL to prevent it from attempting to open the page // as part of the docusaurus project. Which will fail. - window.location = `https://docs.medusa-commerce.com${url}` + window.location = `https://docs.medusajs.com${url}` }, navigateNewTab({ item }) { const url = replaceUrl(item) diff --git a/www/reference/README.md b/www/reference/README.md index 0bb8cdc35c..258e35c3c5 100644 --- a/www/reference/README.md +++ b/www/reference/README.md @@ -1,3 +1,3 @@ # Medusa Docs -Visit: docs.medusa-commerce.com to browse docs. +Visit: docs.medusajs.com to browse docs. diff --git a/www/reference/src/components/topbar.js b/www/reference/src/components/topbar.js index 94554ee5d7..617ebb8c8e 100644 --- a/www/reference/src/components/topbar.js +++ b/www/reference/src/components/topbar.js @@ -100,7 +100,7 @@ const Topbar = ({ data, api }) => { justifyContent: "flex-end", }} > - + Docs