From 483f7b556c7ad306ca1d4c0b6dc4439e3c120a40 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Fri, 14 Feb 2025 17:02:49 +0200 Subject: [PATCH] docs: update tips in user guide (#11477) * updated bulk editor tips * docs: update tips in user guide --- .../user-guide/app/tips/bulk-editor/page.mdx | 33 ++++++---- .../user-guide/app/tips/languages/page.mdx | 29 +++++---- www/apps/user-guide/app/tips/lists/page.mdx | 60 +++++++++---------- www/apps/user-guide/generated/edit-dates.mjs | 6 +- 4 files changed, 66 insertions(+), 62 deletions(-) diff --git a/www/apps/user-guide/app/tips/bulk-editor/page.mdx b/www/apps/user-guide/app/tips/bulk-editor/page.mdx index 7013d572e5..d2b0566866 100644 --- a/www/apps/user-guide/app/tips/bulk-editor/page.mdx +++ b/www/apps/user-guide/app/tips/bulk-editor/page.mdx @@ -10,17 +10,19 @@ export const metadata = { # {metadata.title} -In this document, you'll learn about different tips and shortcuts to using the bulk editor. +In this guide, you'll learn about different tips and shortcuts to using the bulk editor. -## Overview +![Bulk Editor Example](https://res.cloudinary.com/dza7lstvk/image/upload/v1739535694/User%20Guide/Screenshot_2025-02-14_at_2.20.10_PM_wjsfcg.png) + +## Manage Large Data in Bulk The bulk editor allows you to edit prices or values using a spreadsheet-interface. It simplifies the editing process when working with a large number of data, and provides you with an intuitive user experience. -The bulk editor is used in different areas of the Medusa Admin. +The bulk editor is used in different areas of the Medusa Admin, such as product-variant pricing. {/* TODO do we still need this next section? */} -{/* --- +--- ## Toggle Columns View @@ -29,29 +31,38 @@ As the bulk editor may include a large number of columns, such as the different To do that: 1. Click on the "View" button at the top left. -2. Check or uncheck a column by clicking on it in the dropdown. */} +2. Check or uncheck a column by clicking on it in the dropdown. + +![Change viewed columns](https://res.cloudinary.com/dza7lstvk/image/upload/v1739536402/User%20Guide/Screenshot_2025-02-14_at_2.32.59_PM_a6sf4t.png) --- -## Selecting Cells +## Perform Action on Multiple Cells -You can select multiple cells to apply an action on them. To do that: +You can select multiple cells to perform an action on them. To do that: 1. Click and hold the mouse on a cell 2. Drag the mouse in the direction of the other cells you want to select. 3. Once you're done selecting, release the hold. +4. Perform the action on the cells: + - Press backspace to clear the values of the selected cells. + - Press {getOsShortcut()} + Z to undo a change you made on the selected cells. + +![Select multple cells](https://res.cloudinary.com/dza7lstvk/image/upload/v1739536835/User%20Guide/Screenshot_2025-02-14_at_2.40.17_PM_bcygtk.png) --- -## Editing Cells +## Editing Cell Values -There are multiple ways you can edit cells in a bulk editor: +There are multiple ways you can edit cells' values in a bulk editor: 1. To edit the value, click the cell, then enter your new value. 3. To apply a value of a cell to other adjacent cells: 1. Click on a cell - 2. Hold and Drag the blue dot at the corner of that cell to adjacent cells you want to apply the value to. - 3. Once you're done, release the hold on the blue dot. + 2. Hold and Drag the blue dot at the corner of that cell to the cells below it that you want to apply the value to. + 3. Once you're done, release the hold on the blue dot. The value of the first cell will be applied to the other cells. + +![Draggable blue dot](https://res.cloudinary.com/dza7lstvk/image/upload/v1739537029/User%20Guide/Screenshot_2025-02-14_at_2.43.22_PM_bcefnr.png) --- diff --git a/www/apps/user-guide/app/tips/languages/page.mdx b/www/apps/user-guide/app/tips/languages/page.mdx index e22b96e4d9..54aa8bfbda 100644 --- a/www/apps/user-guide/app/tips/languages/page.mdx +++ b/www/apps/user-guide/app/tips/languages/page.mdx @@ -8,9 +8,9 @@ export const metadata = { # {metadata.title} -{/* TODO check whether the languages here are still valid. */} +Medusa Admin comes with multi-language support. Multi-language support is only for the Medusa Admin interface, not for the content, such as product description. -Medusa Admin comes with multi-language support. This document covers the complete list of available languages, both official and by the community. +This document covers the complete list of available languages, both official and by the community. To learn how to change the language, refer to [this documentation](../../settings/profile/page.mdx). @@ -21,8 +21,6 @@ Can't find your language? Learn how you can contribute by translating the admin ## Official Languages - English -- French -- Portuguese ## Community Translations @@ -32,21 +30,22 @@ Languages listed in this section are contributed by the Medusa community. So, th -- Bosanski -- Deutsch - Español -- Hindi -- Hrvatski +- Ελληνικά +- Deutsch +- Français - Italiano -- 한국어 - 日本語 - Polski -- Русский -- Slovenščina -- Tamil -- Tiếng Việt +- Português (Brasil) +- Türkçe +- ไทย - Українська +- Română +- Македонски +- Монгол - العربية -- Čeština - 简体中文 -- Български +- فارسی +- Čeština +- Русский diff --git a/www/apps/user-guide/app/tips/lists/page.mdx b/www/apps/user-guide/app/tips/lists/page.mdx index e3e47e65ca..78822958e6 100644 --- a/www/apps/user-guide/app/tips/lists/page.mdx +++ b/www/apps/user-guide/app/tips/lists/page.mdx @@ -1,52 +1,33 @@ --- sidebar_position: 3 +sidebar_label: "Lists" --- -import { XMark } from "@medusajs/icons" +import { BarsArrowDown } from "@medusajs/icons" export const metadata = { - title: `Lists`, + title: `Lists Tips`, } # {metadata.title} -In this document, you’ll get an overview of lists in Medusa including filters, searching, and more! +In this guide, you’ll get an overview of lists in Medusa including filters, searching, and more. Each domain in the Medusa Admin, such as products or orders, has a list view displaying the items in that domain. Generally, you can apply advanced filters, search for items, and sort items. + +![List Overview](https://res.cloudinary.com/dza7lstvk/image/upload/v1739538757/User%20Guide/Screenshot_2025-02-14_at_3.07.21_PM_p3vkey.png) ## Filter Items Use filters to retrieve items in a list matching specific criteria. -{/* TODO check if the next section still applies */} - -{/* ### Quick Filters - -On a table with a list of items, you’ll find quick filters at the top of the list. - -You can click on one of these filters to quickly apply it to the list of items. - -![Quick filters for lists](https://res.cloudinary.com/dza7lstvk/image/upload/v1667998663/Medusa%20Docs/User%20Guide/eVwD0JP_ukor4r.png) */} - To do that: 1. Click on the "Add filter" button at the top of the list. -2. From the dropdown, choose the criteria you want to filter. -3. This shows a new set of values to filter the list by. -4. After selecting the value, the list only includes the items matching your filters. You can also apply multiple filters. +2. From the dropdown, choose the criteria you want to filter by, such as Tag. +3. This shows a new set of values to filter the list by. Select the value(s) you want to filter by. -![Selected Filters](https://res.cloudinary.com/dza7lstvk/image/upload/v1710230676/User%20Guide/Screenshot_2024-03-12_at_10.04.20_AM_rz4xnn.png) +After selecting the value(s), the list only includes the items matching your filters. You can also apply multiple filters. -The filters you create are saved and are applied everytime you view the same list. - -### Edit Saved Filters - -To edit a saved filter: - -1. Click on the filter. -2. Choose the new value of the filter. - -### Delete Saved Filters - -To delete any saved filter you’ve created, click the icon next to the filter. +![Add Filters](https://res.cloudinary.com/dza7lstvk/image/upload/v1739538873/User%20Guide/Screenshot_2025-02-14_at_3.13.51_PM_jq7o7f.png) ### Clear Filters @@ -58,10 +39,23 @@ To clear all applied filters, click on the "Clear all" link at the end of the li To search for items in a list: -1. Click the search bar at the top right of the list. -2. Enter your search term. The list is updated in real-time. +1. Click the search input at the top right of the list. +2. Enter your search term. The list is updated in real-time with items matching the search query. -![Search items in a list](https://res.cloudinary.com/dza7lstvk/image/upload/v1710233000/User%20Guide/Screenshot_2024-03-12_at_10.43.09_AM_upv15y.png) +![Search Items](https://res.cloudinary.com/dza7lstvk/image/upload/v1739540581/User%20Guide/Screenshot_2025-02-14_at_3.42.41_PM_ijhthi.png) + +--- + +## Sort Items + +To configure the sorting of items in the list: + +1. Click on the button. +2. Choose the field to filter by (for example, Created date) and the direction of filter (ascending or descending). + +On clicking the new configuration, the list will be updated with the new sorting. + +![Sort Items](https://res.cloudinary.com/dza7lstvk/image/upload/v1739540693/User%20Guide/Screenshot_2025-02-14_at_3.44.37_PM_roprfq.png) --- @@ -69,4 +63,4 @@ To search for items in a list: Lists in the Medusa Admin span across multiple pages if the number of items in that list are more than twenty. -Navigate between pages using the "Prev" and "Next" buttons at the bottom of the list. \ No newline at end of file +You can navigate between pages using the "Prev" and "Next" buttons at the bottom of the list. diff --git a/www/apps/user-guide/generated/edit-dates.mjs b/www/apps/user-guide/generated/edit-dates.mjs index dee818dba9..2e4a14776b 100644 --- a/www/apps/user-guide/generated/edit-dates.mjs +++ b/www/apps/user-guide/generated/edit-dates.mjs @@ -1,7 +1,7 @@ export const generatedEditDates = { - "app/tips/languages/page.mdx": "2024-05-03T17:36:38+03:00", - "app/tips/bulk-editor/page.mdx": "2024-05-03T17:36:38+03:00", - "app/tips/lists/page.mdx": "2024-05-03T17:36:38+03:00", + "app/tips/languages/page.mdx": "2025-02-14T14:16:04.867Z", + "app/tips/bulk-editor/page.mdx": "2025-02-14T14:16:04.867Z", + "app/tips/lists/page.mdx": "2025-02-14T14:16:04.867Z", "app/settings/sales-channels/page.mdx": "2024-05-03T17:36:38+03:00", "app/settings/users/page.mdx": "2024-05-03T17:36:38+03:00", "app/settings/regions/manage/page.mdx": "2024-05-03T17:36:38+03:00",