From 11679702110253a23fcebbb0deb5160e9859b1d2 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Tue, 8 Nov 2022 13:30:43 +0200 Subject: [PATCH] docs: added manage collections user guide (#2564) --- docs/content/add-plugins/klarna.md | 14 ++- .../user-guide/discounts/conditions.md | 1 + docs/content/user-guide/discounts/create.md | 1 + docs/content/user-guide/discounts/edit.md | 1 + docs/content/user-guide/gift-cards/custom.md | 1 + .../user-guide/products/collections.md | 11 --- .../user-guide/products/collections.mdx | 90 +++++++++++++++++++ docs/content/user-guide/products/index.mdx | 3 +- .../user-guide/products/manage-digital.md | 11 --- .../content/user-guide/taxes/tax-inclusive.md | 1 + 10 files changed, 108 insertions(+), 26 deletions(-) delete mode 100644 docs/content/user-guide/products/collections.md create mode 100644 docs/content/user-guide/products/collections.mdx delete mode 100644 docs/content/user-guide/products/manage-digital.md diff --git a/docs/content/add-plugins/klarna.md b/docs/content/add-plugins/klarna.md index ad3678c20b..9309d6ce89 100644 --- a/docs/content/add-plugins/klarna.md +++ b/docs/content/add-plugins/klarna.md @@ -1,3 +1,13 @@ -# Klarna (Documentation coming soon) +--- +hide_footer: true +--- -[View plugin here](https://github.com/medusajs/medusa/tree/master/packages/medusa-payment-klarna) +# Klarna + +:::note + +This guide is coming soon. + +::: + +[View plugin](https://github.com/medusajs/medusa/tree/master/packages/medusa-payment-klarna) \ No newline at end of file diff --git a/docs/content/user-guide/discounts/conditions.md b/docs/content/user-guide/discounts/conditions.md index 7186f78c19..e3b2e9436f 100644 --- a/docs/content/user-guide/discounts/conditions.md +++ b/docs/content/user-guide/discounts/conditions.md @@ -1,5 +1,6 @@ --- sidebar_position: 2 +hide_footer: true --- # Discount Conditions Overview diff --git a/docs/content/user-guide/discounts/create.md b/docs/content/user-guide/discounts/create.md index dc1d12b904..96912a0019 100644 --- a/docs/content/user-guide/discounts/create.md +++ b/docs/content/user-guide/discounts/create.md @@ -1,5 +1,6 @@ --- sidebar_position: 3 +hide_footer: true --- # Create a Discount diff --git a/docs/content/user-guide/discounts/edit.md b/docs/content/user-guide/discounts/edit.md index 1074bfbc01..4ae88e1054 100644 --- a/docs/content/user-guide/discounts/edit.md +++ b/docs/content/user-guide/discounts/edit.md @@ -1,5 +1,6 @@ --- sidebar_position: 4 +hide_footer: true --- # Edit a Discount diff --git a/docs/content/user-guide/gift-cards/custom.md b/docs/content/user-guide/gift-cards/custom.md index 2681d72963..3e360297ac 100644 --- a/docs/content/user-guide/gift-cards/custom.md +++ b/docs/content/user-guide/gift-cards/custom.md @@ -1,5 +1,6 @@ --- sidebar_position: 3 +hide_footer: true --- # Manage Custom Gift Cards diff --git a/docs/content/user-guide/products/collections.md b/docs/content/user-guide/products/collections.md deleted file mode 100644 index 158fc079ac..0000000000 --- a/docs/content/user-guide/products/collections.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Manage Collections - -:::note - -This guide is coming soon. - -::: diff --git a/docs/content/user-guide/products/collections.mdx b/docs/content/user-guide/products/collections.mdx new file mode 100644 index 0000000000..5ac074e35f --- /dev/null +++ b/docs/content/user-guide/products/collections.mdx @@ -0,0 +1,90 @@ +--- +sidebar_position: 3 +--- + +import UiIcon from '@site/src/components/UiIcon'; + +# Manage Collections + +In this document, you’ll learn how to create a new collection, edit an existing collection, delete a collection, and more. + +## Create a Collection + +To create a collection: + +1. Go to the Products page. +2. Click on the Collections header at the top left of the products list. +3. Click on the New collection button. +4. In the form that opens: + 1. You're required to enter a name for the collection + 2. You can optionally specify the handle of the collection. + 3. To add metadata, click on the Add Metadata button. + 4. To remove metadata, click on the icon next to it. +5. Once done, click on the “Publish collection” button. + +--- + +## View a Collection’s Details + +To view a collection’s details: + +1. Go to the Products page. +2. Click on the Collections header at the top left of the products list. +3. From the table, choose the collection you want to view. + +--- + +## Edit a Collection + +To edit a collection: + +1. Go to the Collection’s Details page. +2. Click on the icon at the top right of the first section. +3. Choose Edit Collection from the dropdown. +4. In the new form that opens, edit any of the collection details. +5. Once done, click on the “Save collection” button. + +--- + +## Manage a Collection’s Products + +### Add Products to a Collection + +To add products to a collection: + +1. Go to the Collection’s Details page. +2. In the Products section, click on the Edit Products button. +3. From the list of products, check the box next to the products you want to add to the collection. +4. Once done, click on the Save button. + +### Remove a Product from a Collection + +:::info + +Removing a product from a collection doesn't delete the product from Medusa. + +::: + +To remove a product from a collection: + +1. Go to the Collection’s Details page. +2. In the Products section, find the product you want to remove from the collection. +3. Click on the icon at the right side of the product. +4. Confirm removing the product by clicking the “Yes, remove" button in the pop-up. + +--- + +## Delete a Collection + +:::warning + +Deleting a collection can’t be undone. You will lose all data related to the collection. Products in the collection will not be lost. + +::: + +To delete a collection: + +1. Go to the Collections page. +2. Find the collection you want to delete, then click on the icon at its right. +3. Choose Delete from the dropdown. +4. Confirm deleting the collection by clicking the “Yes, confirm" button in the pop-up. \ No newline at end of file diff --git a/docs/content/user-guide/products/index.mdx b/docs/content/user-guide/products/index.mdx index c343efe116..c660574295 100644 --- a/docs/content/user-guide/products/index.mdx +++ b/docs/content/user-guide/products/index.mdx @@ -49,7 +49,6 @@ 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 Digital Products](./manage-digital.md) -- [Manage Collections](./collections.md) +- [Manage Collections](./collections.mdx) - [Export Products](./export.mdx) - [Import Products](./import.mdx) \ No newline at end of file diff --git a/docs/content/user-guide/products/manage-digital.md b/docs/content/user-guide/products/manage-digital.md deleted file mode 100644 index 6315575415..0000000000 --- a/docs/content/user-guide/products/manage-digital.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Manage Digital Products - -:::note - -This guide is coming soon. - -::: diff --git a/docs/content/user-guide/taxes/tax-inclusive.md b/docs/content/user-guide/taxes/tax-inclusive.md index 071dcca614..6c54140fa6 100644 --- a/docs/content/user-guide/taxes/tax-inclusive.md +++ b/docs/content/user-guide/taxes/tax-inclusive.md @@ -1,5 +1,6 @@ --- sidebar_position: 5 +hide_footer: true --- # Tax Inclusive Pricing Overview