docs: translation module (#14271)
* docs: translation module * fix link in JS SDK * add translations user guides [WIP] * updates * fix broken link * remove mentions of default locale * change header * updates * updated user guides * handle todos * fix build error * fix lint errors
This commit is contained in:
Shahed Nasser
@@ -0,0 +1,49 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
sidebar_label: "Export Orders"
|
||||
tags:
|
||||
- user guide
|
||||
- order
|
||||
products:
|
||||
- order
|
||||
---
|
||||
|
||||
import { BellAlert, ArrowDownTray } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Export Orders in Medusa Admin`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this guide, you’ll learn how to export all orders in your Medusa store.
|
||||
|
||||
<Note>
|
||||
|
||||
Order exports are available from [Medusa v2.12.3](https://github.com/medusajs/medusa/releases/tag/v2.12.3). If you don't see the button to export orders in your Medusa Admin, request your technical team to [upgrade your Medusa application](!docs!/learn/update).
|
||||
|
||||
</Note>
|
||||
|
||||
## Export Orders as CSV
|
||||
|
||||
When you export your orders, you download a CSV with the orders' details. This is useful to import into external systems, or for creating backups.
|
||||
|
||||
---
|
||||
|
||||
## Export Orders
|
||||
|
||||
To export orders:
|
||||
|
||||
1. Go to the Orders page.
|
||||
2. If you want to export a subset of orders matching filters, apply the filters first to the orders list.
|
||||
3. Click on the Export button in the main section's header.
|
||||
4. In the side window that opens, you can see any filters you've applied.
|
||||
5. Click on the Export button to start the export.
|
||||
6. To check the export's status, click the <InlineIcon Icon={BellAlert} alt="bell" /> notifications icon in the page's header. You should see your new export loading.
|
||||
7. Once the export is ready, click the <InlineIcon Icon={ArrowDownTray} alt="download" /> icon.
|
||||
|
||||
<Note>
|
||||
|
||||
If you face any errors or difficulties, please contact your technical support team as this could be an issue in the [storage integration](!resources!/infrastructure-modules/file) used.
|
||||
|
||||
</Note>
|
||||
@@ -94,6 +94,26 @@ To edit a product category:
|
||||
|
||||
---
|
||||
|
||||
## Manage Product Category's Translations
|
||||
|
||||
<Note>
|
||||
|
||||
Locales are available from [Medusa v2.12.3](https://github.com/medusajs/medusa/releases/tag/v2.12.3). If you don't see the translation management in your Medusa Admin, request your technical team to [upgrade your Medusa application](!docs!/learn/update).
|
||||
|
||||
</Note>
|
||||
|
||||
Product categories can be translated to locales (languages) [supported by your store](../../settings/store/page.mdx#manage-store-locales). You can either manage translations [in bulk](../../settings/translations/page.mdx), or manage translations for an individual product category from its details page.
|
||||
|
||||
To manage translations for the product category:
|
||||
|
||||
1. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section's header.
|
||||
2. Choose "Manage translations" from the dropdown.
|
||||
3. In the [bulk editor](../../tips/bulk-editor/page.mdx) that opens, you can view and edit translations for the product category's title and description in each locale supported by your store.
|
||||
- To edit text with multi-line support, double click the respective cell to open a larger text area.
|
||||
4. Once you're done editing, click the Save button to apply the changes.
|
||||
|
||||
---
|
||||
|
||||
## Edit Product Category Metadata
|
||||
|
||||
Metadata is custom data that can be associated with the product category in key-value pairs. This is usually used by developers for custom integrations or to store additional information about the product category.
|
||||
|
||||
@@ -72,6 +72,26 @@ To edit a collection:
|
||||
|
||||
---
|
||||
|
||||
## Manage Product Collection's Translations
|
||||
|
||||
<Note>
|
||||
|
||||
Locales are available from [Medusa v2.12.3](https://github.com/medusajs/medusa/releases/tag/v2.12.3). If you don't see the translation management in your Medusa Admin, request your technical team to [upgrade your Medusa application](!docs!/learn/update).
|
||||
|
||||
</Note>
|
||||
|
||||
Product collections can be translated to locales (languages) [supported by your store](../../settings/store/page.mdx#manage-store-locales). You can either manage translations [in bulk](../../settings/translations/page.mdx), or manage translations for an individual product collection from its details page.
|
||||
|
||||
To manage translations for the product collection:
|
||||
|
||||
1. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section's header.
|
||||
2. Choose "Manage translations" from the dropdown.
|
||||
3. In the [bulk editor](../../tips/bulk-editor/page.mdx) that opens, you can view and edit translations for the product collection's title in each locale supported by your store.
|
||||
- To edit text with multi-line support, double click the respective cell to open a larger text area.
|
||||
4. Once you're done editing, click the Save button to apply the changes.
|
||||
|
||||
---
|
||||
|
||||
## Edit Product Collection Metadata
|
||||
|
||||
Metadata is custom data that can be associated with the product collection in key-value pairs. This is usually used by developers for custom integrations or to store additional information about the product collection.
|
||||
|
||||
@@ -71,11 +71,29 @@ In the first section's header, you can see the product's status. A product can h
|
||||
|
||||
To edit the product's general details:
|
||||
|
||||
1. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the section's header.
|
||||
1. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section's header.
|
||||
2. Choose "Edit" from the dropdown.
|
||||
3. In the side window that opens, you can edit the product's status, title, subtitle, handle, material, description, and whether it's discountable.
|
||||
4. Once you're done, click the "Save" button.
|
||||
|
||||
### Manage Product's Translations
|
||||
|
||||
<Note>
|
||||
|
||||
Locales are available from [Medusa v2.12.3](https://github.com/medusajs/medusa/releases/tag/v2.12.3). If you don't see the translation management in your Medusa Admin, request your technical team to [upgrade your Medusa application](!docs!/learn/update).
|
||||
|
||||
</Note>
|
||||
|
||||
Products can be translated to locales (languages) [supported by your store](../../settings/store/page.mdx#manage-store-locales). You can either manage translations [in bulk](../../settings/translations/page.mdx), or manage translations for an individual product from its details page.
|
||||
|
||||
To manage translations for the product:
|
||||
|
||||
1. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section's header.
|
||||
2. Choose "Manage translations" from the dropdown.
|
||||
3. In the [bulk editor](../../tips/bulk-editor/page.mdx) that opens, you can view and edit translations for the product's title, description, subtitle, and more in each locale supported by your store.
|
||||
- To edit text with multi-line support, double click the respective cell to open a larger text area.
|
||||
4. Once you're done editing, click the Save button to apply the changes.
|
||||
|
||||
### Delete Product
|
||||
|
||||
In this section, you can also delete the product.
|
||||
@@ -88,7 +106,7 @@ Deleting a product is irreversible.
|
||||
|
||||
To delete the product:
|
||||
|
||||
1. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the section's header.
|
||||
1. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section's header.
|
||||
2. Choose "Delete" from the dropdown.
|
||||
3. Confirm deleting the product by clicking the "Delete" button in the pop-up.
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ products:
|
||||
- product
|
||||
---
|
||||
|
||||
import { EllipsisVertical, TaxExclusive, TaxInclusive, ArrowUpRightOnBox } from "@medusajs/icons"
|
||||
import { EllipsisVertical, TaxExclusive, TaxInclusive, ArrowUpRightOnBox, EllipsisHorizontal } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Product Variants in Medusa Admin`,
|
||||
@@ -86,6 +86,28 @@ To edit a product variant's general details:
|
||||
|
||||
---
|
||||
|
||||
## Manage Product Variant's Translations
|
||||
|
||||
<Note>
|
||||
|
||||
Locales are available from [Medusa v2.12.3](https://github.com/medusajs/medusa/releases/tag/v2.12.3). If you don't see the translation management in your Medusa Admin, request your technical team to [upgrade your Medusa application](!docs!/learn/update).
|
||||
|
||||
</Note>
|
||||
|
||||
Product variants can be translated to locales (languages) [supported by your store](../../settings/store/page.mdx#manage-store-locales). You can either manage translations [in bulk](../../settings/translations/page.mdx), or manage translations for an individual product variant from its details page.
|
||||
|
||||
To manage translations for the product:
|
||||
|
||||
1. Go to its product's details page.
|
||||
2. In the Variants section, click on the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> in its row.
|
||||
3. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section's header.
|
||||
4. Choose "Manage translations" from the dropdown.
|
||||
5. In the [bulk editor](../../tips/bulk-editor/page.mdx) that opens, you can view and edit translations for the product's title and material in each locale supported by your store.
|
||||
- To edit text with multi-line support, double click the respective cell to open a larger text area.
|
||||
6. Once you're done editing, click the Save button to apply the changes.
|
||||
|
||||
---
|
||||
|
||||
## Edit Product Variant Prices
|
||||
|
||||
To edit the prices of product variants:
|
||||
|
||||
@@ -67,6 +67,26 @@ To edit the details of a product tag:
|
||||
|
||||
---
|
||||
|
||||
## Manage Product Tag's Translations
|
||||
|
||||
<Note>
|
||||
|
||||
Locales are available from [Medusa v2.12.3](https://github.com/medusajs/medusa/releases/tag/v2.12.3). If you don't see the translation management in your Medusa Admin, request your technical team to [upgrade your Medusa application](!docs!/learn/update).
|
||||
|
||||
</Note>
|
||||
|
||||
Product tags can be translated to locales (languages) [supported by your store](../store/page.mdx#manage-store-locales). You can either manage translations [in bulk](../translations/page.mdx), or manage translations for an individual product tag from its details page.
|
||||
|
||||
To manage translations for the product tag:
|
||||
|
||||
1. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section's header.
|
||||
2. Choose "Manage translations" from the dropdown.
|
||||
3. In the [bulk editor](../../tips/bulk-editor/page.mdx) that opens, you can view and edit translations for the product tag's value in each locale supported by your store.
|
||||
- To edit text with multi-line support, double click the respective cell to open a larger text area.
|
||||
4. Once you're done editing, click the Save button to apply the changes.
|
||||
|
||||
---
|
||||
|
||||
## Manage Products in Tag
|
||||
|
||||
You can manage the tag of a product in the [product's details page](../../products/edit/page.mdx#manage-product-organization).
|
||||
|
||||
@@ -67,6 +67,26 @@ To edit the details of a product type:
|
||||
|
||||
---
|
||||
|
||||
## Manage Product Type's Translations
|
||||
|
||||
<Note>
|
||||
|
||||
Locales are available from [Medusa v2.12.3](https://github.com/medusajs/medusa/releases/tag/v2.12.3). If you don't see the translation management in your Medusa Admin, request your technical team to [upgrade your Medusa application](!docs!/learn/update).
|
||||
|
||||
</Note>
|
||||
|
||||
Product types can be translated to locales (languages) [supported by your store](../store/page.mdx#manage-store-locales). You can either manage translations [in bulk](../translations/page.mdx), or manage translations for an individual product type from its details page.
|
||||
|
||||
To manage translations for the product type:
|
||||
|
||||
1. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section's header.
|
||||
2. Choose "Manage translations" from the dropdown.
|
||||
3. In the [bulk editor](../../tips/bulk-editor/page.mdx) that opens, you can view and edit translations for the product type's value in each locale supported by your store.
|
||||
- To edit text with multi-line support, double click the respective cell to open a larger text area.
|
||||
4. Once you're done editing, click the Save button to apply the changes.
|
||||
|
||||
---
|
||||
|
||||
## Manage Products in Type
|
||||
|
||||
You can manage the type of a product in the [product's details page](../../products/edit/page.mdx#manage-product-organization).
|
||||
|
||||
@@ -5,8 +5,12 @@ tags:
|
||||
- user guide
|
||||
- store
|
||||
- currency
|
||||
- name: translation
|
||||
label: Manage Store Locales
|
||||
products:
|
||||
- currency
|
||||
- translation
|
||||
- store
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
|
||||
@@ -86,6 +90,39 @@ To remove a currency:
|
||||
|
||||
---
|
||||
|
||||
## Manage Store Locales
|
||||
|
||||
<Note>
|
||||
|
||||
Locales are available from [Medusa v2.12.3](https://github.com/medusajs/medusa/releases/tag/v2.12.3). If you don't see the locale settings in your Medusa Admin, request your technical team to [upgrade your Medusa application](!docs!/learn/update).
|
||||
|
||||
</Note>
|
||||
|
||||
Locales define the languages that your store supports for displaying content to customers. You can manage the store's available locales in the store settings. Then, you can translate content like product titles and descriptions into these locales from the [Translations](../translations/page.mdx) settings.
|
||||
|
||||
## Add Locales to Store
|
||||
|
||||
To add supported locales to your store:
|
||||
|
||||
1. Go to Settings → Store.
|
||||
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the "Locales" section's header.
|
||||
3. Choose Add from the dropdown.
|
||||
4. In the list that opens, check the locales you want to add to the store.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
You can now add translations for resources in the added locales on the [Translations](../translations/page.mdx) settings.
|
||||
|
||||
### Remove Locales from Store
|
||||
|
||||
To remove a locale from your store:
|
||||
|
||||
1. Go to Settings → Store.
|
||||
2. Under the Locales section, check the checkbox next to the locales you want to remove.
|
||||
3. Press <Kbd>R</Kbd> or click the Remove button at the bottom center of the page.
|
||||
4. Confirm removing the locales by clicking the Remove button in the pop-up.
|
||||
|
||||
---
|
||||
|
||||
## Manage Store Metadata
|
||||
|
||||
Metadata is custom data that can be associated with the store in key-value pairs. This is usually used by developers for custom integrations or to store additional information about the store.
|
||||
|
||||
@@ -0,0 +1,83 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
sidebar_label: "Manage Translations"
|
||||
tags:
|
||||
- user guide
|
||||
- translation
|
||||
products:
|
||||
- translation
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Translations in Medusa Admin`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this guide, you’ll learn how to manage translations of resources like products in the Medusa Admin.
|
||||
|
||||
<Note>
|
||||
|
||||
Translations are available from [Medusa v2.12.3](https://github.com/medusajs/medusa/releases/tag/v2.12.3). If you don't see the locale settings in your Medusa Admin, request your technical team to [upgrade your Medusa application](!docs!/learn/update).
|
||||
|
||||
</Note>
|
||||
|
||||
## Translations Overview
|
||||
|
||||
Medusa allows you to translate various resources in your store, such as product titles and descriptions, into multiple locales (languages) supported by your store.
|
||||
|
||||
<Note title="Tip">
|
||||
|
||||
You can set supported locales for your store in the [Store](../store/page.mdx#manage-store-locales) settings page.
|
||||
|
||||
</Note>
|
||||
|
||||
Then, in the storefront, customers can view content in their preferred language based on the available locales.
|
||||
|
||||
You can view and manage translations in the Medusa Admin dashboard by going to Settings → Translations. This page allows you to manage translations of resources in bulk.
|
||||
|
||||
Alternatively, you can manage translations for individual resources directly from their respective pages (for example, from a product's detail page).
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Manage Translations in Bulk
|
||||
|
||||
In the Translations settings page, you can view and manage translations in bulk for various resources in your store, including products and variants.
|
||||
|
||||
<Note>
|
||||
|
||||
Currently, Medusa supports translations for product-related resources only. Future versions will include support for translating more core resources, as well as custom resources.
|
||||
|
||||
</Note>
|
||||
|
||||
For example, to manage product translations in bulk:
|
||||
|
||||
1. Go to Settings → Translations.
|
||||
2. Click on the Edit button in the "Products" row.
|
||||
3. This will open a [bulk editor](../../tips/bulk-editor/page.mdx) where you can view and edit translations for product titles, descriptions, subtitles, and more in each [locale supported in your store](../store/page.mdx#manage-store-locales).
|
||||
- You can switch between locales using the Locales dropdown at the top of the bulk editor.
|
||||
- You can click the "Save Changes" button at any time to save your progress without closing the bulk editor.
|
||||
4. Once you're done editing, click the "Save and close" button to apply the changes.
|
||||
|
||||
Customers will then see the translated content in the storefront based on their selected locale.
|
||||
|
||||
---
|
||||
|
||||
## View Translation Statistics
|
||||
|
||||
Each resource row in the Translations settings page displays how many fields have been translated out of the total translatable fields for that resource.
|
||||
|
||||
The "Translated fields" section also shows a general progress bar of how many fields have been translated across all resources and locales in your store. You can use this summary to track your overall translation progress.
|
||||
|
||||
|
||||
|
||||
There are two charts in this section:
|
||||
|
||||
1. A progress bar showing the overall translation progress across all resources and locales.
|
||||
2. A bar chart showing the number of translated fields per locale.
|
||||
|
||||
These charts help you visualize your translation efforts and identify which locales may need more attention.
|
||||
Reference in New Issue
Block a user