asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: add documentation for v1.8 (#3669)

Browse Source
This commit is contained in:
Shahed Nasser
2023-04-03 13:50:59 +02:00
committed by GitHub
parent 0cca13779d
commit c6bfad14d8
123 changed files with 7610 additions and 2697 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content/user-guide/products/_category_.json
+1 -1
View File
@@ -1,5 +1,5 @@
{
"position": 4,
"position": 3,
"collapsed": false,
"link": null,
"label": "Products",
docs/content/user-guide/products/categories.mdx
+78
View File
@@ -0,0 +1,78 @@
---
sidebar_position: 3
description: 'This user guide explains how to manage categories on the Medusa admin. Learn how to create a category, edit existing categories, delete a category, and more.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Categories
In this document, you’ll learn how to create a category, edit existing categories, delete a category, and more.
:::note
Product Categories are available as a beta feature and must be enabled first. If you want to use them, ask your technical team to enable them first.
:::
## Create a Category
To create a product category:
1. Go to the Categories Page.
2. Click on the “Add category” button at the top right.
3. In the form that opens:
1. Enter the name of the category. This is the only required field.
2. You can enter a handle if you don’t want to use a default handle. A handle is generally used to format the URL shown on your storefront. The default handle will lower-case the category name, and replace spaces with a dash (-). For example, if you name the category “Men Clothing” the handle will be `men-clothing`.
3. You can change the Status to “Inactive” if you’re creating the category, but you’re still not ready to use it.
4. You can change the Visibility to “Private” if you’re creating an internal category that shouldn’t be shown to the customer.
4. Once you’re done, click the “Save category” button.
---
## Edit a Category
To edit a product category:
1. Go to the Categories page.
2. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon at the right of the category you want to edit.
3. Choose Edit from the dropdown.
4. In the form that opens, you can edit any of the fields of the category.
5. Once you’re done, click the “Save and close” button.
---
## Add a Nested Category
To add a new category that should be nested inside another category:
1. Go to the Categories page.
2. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999131/Medusa%20Docs/UI%20Icons/1hL8NiW_lqmjcq.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999150/Medusa%20Docs/UI%20Icons/8LtkPqW_jyqz5i.png" alt="plus" /> icon at the right of the category you’re adding the new category inside.
3. In the form that opens, enter the details as described in the [Create a Category section](#create-a-category).
4. Once you’re done, click on the “Save category” button.
---
## Organize Categories
To organize categories and adjust their hierarchy:
1. Go to the Categories page.
2. Click and hold the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999654/Medusa%20Docs/UI%20Icons/zp2QTbO_io0f7i.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999668/Medusa%20Docs/UI%20Icons/ZPpOcvi_h14vyz.png" alt="grip" /> icon next to the category you want to move. Keep holding the icon until step four.
3. Move the category to the new destination. You can make it a parent category to another category, nest it inside another category, or move it to the top hierarchy.
4. Once you move it to the new destination, release the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999654/Medusa%20Docs/UI%20Icons/zp2QTbO_io0f7i.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999668/Medusa%20Docs/UI%20Icons/ZPpOcvi_h14vyz.png" alt="grip" /> icon.
---
## Delete a Category
:::warning
Deleting a category can’t be undone, and its data can’t be restored.
:::
1. Go to the Categories page.
2. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon at the right of the category.
3. Choose Delete from the dropdown.
docs/content/user-guide/products/collections.mdx
+1 -1
View File
@@ -1,5 +1,5 @@
---
sidebar_position: 3
sidebar_position: 4
description: 'This user guide explains how to manage collections on the Medusa admin. Learn how to create, edit, and delete collections.'
addHowToData: true
---
docs/content/user-guide/products/export.mdx
+1 -1
View File
@@ -1,5 +1,5 @@
---
sidebar_position: 4
sidebar_position: 5
description: 'This user guide explains how to export a list of products on the Medusa admin.'
addHowToData: true
---
docs/content/user-guide/products/import.mdx
+1 -1
View File
@@ -1,5 +1,5 @@
---
sidebar_position: 5
sidebar_position: 6
description: 'This user guide explains how to import a list of products into Medusa using the admin.'
addHowToData: true
---
docs/content/user-guide/products/index.mdx
+4 -1
View File
@@ -15,7 +15,9 @@ Products are the goods you sell in your store. They can be physical or digital p
You can create products and edit their details. That includes basic info, sales channels, inventory management, prices management, and much more.
Part of the products domain is Collections. Collections are used to split products based on their type or function. For example, if you sell furniture and clothing, you can have two collections: Furniture and Clothing.
Part of the product domain is Categories. Categories allow you to organize products into more than one category. You can also manage the hierarchy of the category. An example of a category could be "Women" with "Shirt" as a nested category.
Another part of the domain is Collections. Collections are used to split products for a marketing or sales purpose. For example, you can create a "Summer Collection" to showcase products for the summer.
---
@@ -50,6 +52,7 @@ In the list, you can see collection details such as the title, handle, and the n
## Learn More About Products
- [Manage Products](./manage.mdx)
- [Manage Categories](./categories.mdx)
- [Manage Collections](./collections.mdx)
- [Export Products](./export.mdx)
- [Import Products](./import.mdx)
docs/content/user-guide/products/manage.mdx
+39 -4
View File
@@ -28,11 +28,18 @@ This opens a new form with different sections. The only field required is the Ti
### Organize Section
:::note
If you don't see a categories field, it's because this feature is currently in beta and must be manually enabled by your technical team.
:::
All fields in this section allow you to better group and filter your products using types, collections, and tags.
1. You can either choose from a list of types or create a new one.
2. You can choose from a list of collections.
3. Tags are comma-separated. After entering a tag’s value, add a comma “,” and it will create the tag. You can remove the tag by pressing the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999180/Medusa%20Docs/UI%20Icons/kvGRHQR_s0ptsm.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999200/Medusa%20Docs/UI%20Icons/RJ4SLIu_n30zqr.png" alt="X" /> icon next to it.
3. You can choose one or more categories. If you don't have any categories, you can learn how to create them in the [Manage Categories documentation](./categories.mdx). If you want to choose a nested category, you can click on a parent category which will show the categories nested inside it.
4. Tags are comma-separated. After entering a tag’s value, add a comma “,” and it will create the tag. You can remove the tag by pressing the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999180/Medusa%20Docs/UI%20Icons/kvGRHQR_s0ptsm.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999200/Medusa%20Docs/UI%20Icons/RJ4SLIu_n30zqr.png" alt="X" /> icon next to it.
### Variants Section
@@ -94,6 +101,8 @@ To save the product you can either:
1. Click the “Save as draft” button to save the product without publishing it.
2. Click the “Publish product” button to save the product and publish it.
---
## View Product Details
To view a product’s details:
@@ -101,6 +110,8 @@ To view a product’s details:
1. Go to the Products page.
2. Click on the product you want to view.
---
## Edit a Product’s General Information
To edit a product’s general information:
@@ -111,6 +122,8 @@ To edit a product’s general information:
4. Edit any of the information in the window.
5. Once done, click on the Save button.
---
## Change a Product’s Status
A product’s status can either be Draft or Published.
@@ -121,6 +134,8 @@ To change a product’s status:
2. Click on the status at the top right of the first section. For example, if the current status of the product is Draft, you should see Draft written at the top right of the first section.
3. Click on the status in the dropdown to change the status.
---
## Manage Product Options
:::info
@@ -140,13 +155,18 @@ To manage a product’s option:
3. You can delete an option by clicking the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999273/Medusa%20Docs/UI%20Icons/7hztVhj_mj6mxu.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999290/Medusa%20Docs/UI%20Icons/1yp4PNt_vzwnhf.png" alt="trash" /> icon.
5. Once you’re done, click on the "Save and close" button.
---
## Manage Product Variants
### Add a Variant
:::info
Multiple variants can’t have the same options combination.
Please note the following:
- Multiple variants can’t have the same options combination.
- The steps regarding managing the inventory of a product variant requires the Inventory and Stock Location modules to be installed. You can refer to the [Multi-Warehouse user guide](../multiwarehouse/index.md) for more details about that.
:::
@@ -162,8 +182,13 @@ To add a variant to a product:
1. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999595/Medusa%20Docs/UI%20Icons/A91y4rk_doqj9s.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999615/Medusa%20Docs/UI%20Icons/knwwocb_ll4l6m.png" alt="right arrow" /> icon next to the currency. This expands a list of regions below the currency. These are regions that use this currency.
2. Enter the price for the region you want.
4. In the Stock & Inventory section, you can manage how Medusa handles the product’s inventory, the quantity in Stock, and more.
1. If Manage Inventory is enabled, Medusa will change the available quantity of the variant when orders or returns are made.
2. If Allow Backorders is enabled, customers can purchase this variant even if it’s out-of-stock.
1. If you disable the Manage Inventory field, Medusa will assume the product is always in stock.
2. If you enable the Manage Inventory field:
1. Under the Quantity section, click on the "Manage locations" button.
2. Enable the locations a product is enabled in.
3. Click on the "Save and go back" button.
4. For each location you added, enter the quantity available in stock.
3. If Allow Backorders is enabled, customers can purchase this variant even if it’s out-of-stock. You can only enable "Allow Backorders" if "Manage Inventory" is enabled.
5. In the Shipping section, you can specify information relevant to shipping such as Height, Weight, Country of origin, and more.
5. Once you’re done, click on the “Save and close” button.
@@ -216,6 +241,8 @@ To delete a variant:
3. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon.
4. Click on Delete Variant from the dropdown.
---
## Edit a Product’s Attributes
To edit a product’s attributes:
@@ -226,6 +253,8 @@ To edit a product’s attributes:
4. In the new window that opens, you can edit any of the attribute information of the product.
5. Once you’re done, click on the Save button.
---
## Manage Thumbnails
### Set Thumbnail
@@ -259,6 +288,8 @@ To delete a thumbnail:
2. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999273/Medusa%20Docs/UI%20Icons/7hztVhj_mj6mxu.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999290/Medusa%20Docs/UI%20Icons/1yp4PNt_vzwnhf.png" alt="trash" /> icon at the top right of the Thumbnail section.
3. Click the Confirm button.
---
## Manage Images
:::info
@@ -280,6 +311,8 @@ To manage a product’s images
2. Click on Delete from the dropdown.
4. Once you’re done, click Save and close.
---
## Duplicate a Product
To duplicate a product:
@@ -290,6 +323,8 @@ To duplicate a product:
This creates a product with the same information as the original but as a draft.
---
## Delete a Product
:::warning