docs: redesigned admonitions (#5689)

2023-11-22 17:07:29 +00:00
1 parent 00d59e28e9
commit 2850e9a772
@@ -211,7 +211,7 @@ YARN_PRODUCTION=false
 NODE_ENV=production
 ```

-:::caution
+:::warning

 It’s highly recommended to use strong, randomly generated secrets for `JWT_SECRET` and `COOKIE_SECRET`.

@@ -14,7 +14,7 @@ This document includes the installation instructions for the tools required to u

 Node.js is the environment that makes it possible for Medusa to run, so you must install Node.js on your machine to start Medusa development.

-:::caution
+:::warning

 Medusa supports v16+ of Node.js. You can check your Node.js version using the following command:

@@ -15,7 +15,7 @@ If a feature flag is enabled/disabled by default, you don’t need to manually e

 ## Enable Feature Flags

-:::caution
+:::warning

 Features guarded by feature flags are experimental and beta features. Enable them with caution.

@@ -50,7 +50,7 @@ When you run your Medusa backend, the Payment Processor will be registered on yo

 Once the Payment Processor is added to the backend, the store operator will be able to choose using the [admin dashboard](../../admin/quickstart.mdx) the payment processors available in a region. You can alternatively do that using the [admin APIs](https://docs.medusajs.com/api/admin). These payment processors are shown to the customer at checkout as payment methods to choose from and use.

-:::caution
+:::warning

 It’s important to enable a payment processor in a region, or else the payment processor cannot be used by customers on checkout.

@@ -15,7 +15,7 @@ In this document, you’ll learn how to bulk import prices into a price list usi

 Using Medusa’s [Batch Job Admin APIs](https://docs.medusajs.com/api/admin#batch-jobs), you can import prices into a price list.

-:::caution
+:::warning

 Importing prices into a price list removes all existing prices in the price list and adds the imported prices.

@@ -49,7 +49,7 @@ const plugins = [
 ]
 ```

-:::caution
+:::warning

 If you have multiple storage plugins configured, the last plugin declared in the `medusa-config.js` file will be used.

@@ -63,7 +63,7 @@ To generate access keys for your plugin:
 3. This will open a new form with randomly-generated keys. Click on the Create button.
 4. A pop-up will then show the value for your Access Key and Secret Key. Copy them to use in the next section.

-:::caution
+:::warning

 You will not be able to access the Secret Key after closing the pop-up. So, make sure to store it somewhere to use later when configuring the plugin.

@@ -107,7 +107,7 @@ const plugins = [
 ]
 ```

-:::caution
+:::warning

 If you have multiple storage plugins configured, the last plugin declared in the `medusa-config.js` file will be used.

@@ -152,7 +152,7 @@ S3_PREFIX=<YOUR_BUCKET_PREFIX>
 ```


-:::caution
+:::warning

 If you have multiple storage plugins configured, the last plugin declared in the `medusa-config.js` file will be used.

@@ -67,7 +67,7 @@ This shows a table with the Name field editable. Enter a name for the Access Key

 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.

-:::caution
+:::warning

 The secret access key will not be shown again after you leave the page. Make sure to copy it when you see it or you’ll need to re-generate a new one.

@@ -124,7 +124,7 @@ const plugins = [
 ]
 ```

-:::caution
+:::warning

 If you have multiple storage plugins configured, the last plugin declared in the `medusa-config.js` file will be used.

@@ -124,7 +124,7 @@ In the handler function, you resolve the `twilioSmsService` and `orderService` u

 The `sendSms` method of the Twilio service accepts an object of parameters. These parameters are based on Twilio’s SMS APIs. You can check their [API documentation](https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource) for more fields that you can add.

-:::caution
+:::warning

 If you’re on a Twilio trial make sure that the phone number you entered on checkout is a [verified Twilio number on your console](https://console.twilio.com/us1/develop/phone-numbers/manage/verified).

@@ -26,7 +26,7 @@ npm install medusa-interfaces@latest

 ### Use Legacy Peer Dependencies Option

-:::caution
+:::warning

 This solution can be used as a workaround and should be used with caution to avoid any issues while using Medusa.

@@ -112,7 +112,7 @@ To edit a discount’s condition:

 ### Delete a Condition

-:::caution
+:::warning

 Deleting a condition can't be undone. You can still add a new condition of the same type afterward.

@@ -148,7 +148,7 @@ If you face any errors or difficulties while uploading an image, please contact

 ### Delete Gift Card Image

-:::caution
+:::warning

 If you delete an image, you won’t be able to restore it.

@@ -167,7 +167,7 @@ To delete a gift card image:

 ## Unpublish Gift Card

-:::caution
+:::warning

 Unpublishing a gift card prevents customers from seeing the gift card in the storefront, purchasing it, or using it.

@@ -20,7 +20,7 @@ When a claim is created, you can choose whether the claim will be resolved throu

 ## Create a Claim

-:::caution
+:::warning

 If you create a claim of type Refund, a refund is issued to the customer right after the claim is created. Before you can create a claim for an order, you must capture the order’s payment, and create fulfillment in the order for the items included in the claim.

@@ -79,7 +79,7 @@ To mark a claim’s return as received:

 ### Cancel a Claim’s Return

-:::caution
+:::warning

 Canceling a return can’t be undone.

@@ -95,7 +95,7 @@ To cancel a return of a claim:

 ## Manage a Claim’s Fulfillments

-:::caution
+:::warning

 This section only applies if the Claim’s type is Replace.

@@ -135,7 +135,7 @@ Shipment details can be seen in the Timeline section.

 ### Cancel a Claim’s Fulfillment

-:::caution
+:::warning

 If you cancel a fulfillment, it can’t be reverted. Only a fulfillment that hasn’t been marked as shipped can be canceled.

@@ -160,7 +160,7 @@ A claim of type Refund can be canceled by just [canceling the return of the clai

 ### For Replace Claims

-:::caution
+:::warning

 Canceling a claim can’t be undone. The [return of the claim must be canceled](#cancel-a-claims-return) before the claim itself is canceled.

@@ -99,7 +99,7 @@ To cancel a draft order:

 ## Mark Draft Order as Paid

-:::caution
+:::warning

 When you mark a draft order as paid, a new order is created and associated with this draft order. This can’t be undone, but the new order created can be canceled.

@@ -47,7 +47,7 @@ You can check the fulfillment details in the Fulfillment and Timeline sections.

 ## Mark a Fulfillment Shipped

-:::caution
+:::warning

 Once a fulfillment is marked as shipped, it can’t be reverted. You must [create a fulfillment](#create-fulfillment) first before you can mark it as shipped.

@@ -71,7 +71,7 @@ Shipment details can be seen in the Timeline section.

 ## Cancel a Fulfillment

-:::caution
+:::warning

 If you cancel a fulfillment, it can’t be reverted. Only a fulfillment that hasn’t been marked as shipped can be canceled.

@@ -166,7 +166,7 @@ The note will be added and can be seen in the timeline.

 ## Delete a Note

-:::caution
+:::warning

 Deleted notes can’t be retrieved.

@@ -34,7 +34,7 @@ To capture an order’s payment:

 ## Refund Payment

-:::caution
+:::warning

 Refunding payments can’t be undone. Payment can only be refunded after it has been captured.

@@ -61,7 +61,7 @@ To request a return for an order:

 ## Receive Return

-:::caution
+:::warning

 Once the return is marked as received, a refund will be issued to the customer. A return can only be marked as “received” if the payment of the order or the items chosen in the return is captured.

@@ -20,7 +20,7 @@ For a list of accepted columns, refer to [this guide](../../modules/price-lists/

 :::

-:::caution
+:::warning

 When you import prices into a price list, it removes existing prices and adds new prices.

@@ -146,7 +146,7 @@ To delete a product from a price list and remove the pricing changes as well:

 ## Delete Price List

-:::caution
+:::warning

 Deleting a price list cannot be undone. Prices defined in the price list will no longer be available for the customers.

@@ -300,7 +300,7 @@ To manage the thumbnail of a product:

 ### Delete Thumbnail

-:::caution
+:::warning

 Deleting a thumbnail can’t be undone.

@@ -55,7 +55,7 @@ By default, taxes are calculated automatically by Medusa. They’re calculated i

 If you use a third-party tax provider and you want to avoid sending too many requests to the tax provider, you can disable this behavior.

-:::caution
+:::warning

 If you switch off automatic taxes calculation, the taxes must be calculated manually on checkout. If you’re unsure how that works, please contact your technical team.

@@ -64,7 +64,7 @@ To edit an override:

 ## Delete Override

-:::caution
+:::warning

 If you delete an override you won’t be able to restore it and it won’t be applied during checkout. If you want to, instead, remove some entries from an override type, you should [edit the override](#edit-override) instead.