Skip to content

Commit

Permalink
docs: added manage collections user guide (#2564)
Browse files Browse the repository at this point in the history
  • Loading branch information
shahednasser authored Nov 8, 2022
1 parent e16d076 commit 1167970
Show file tree
Hide file tree
Showing 10 changed files with 108 additions and 26 deletions.
14 changes: 12 additions & 2 deletions docs/content/add-plugins/klarna.md
Original file line number Diff line number Diff line change
@@ -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)
1 change: 1 addition & 0 deletions docs/content/user-guide/discounts/conditions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 2
hide_footer: true
---

# Discount Conditions Overview
Expand Down
1 change: 1 addition & 0 deletions docs/content/user-guide/discounts/create.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 3
hide_footer: true
---

# Create a Discount
Expand Down
1 change: 1 addition & 0 deletions docs/content/user-guide/discounts/edit.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 4
hide_footer: true
---

# Edit a Discount
Expand Down
1 change: 1 addition & 0 deletions docs/content/user-guide/gift-cards/custom.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 3
hide_footer: true
---

# Manage Custom Gift Cards
Expand Down
11 changes: 0 additions & 11 deletions docs/content/user-guide/products/collections.md

This file was deleted.

90 changes: 90 additions & 0 deletions docs/content/user-guide/products/collections.mdx
Original file line number Diff line number Diff line change
@@ -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 <UiIcon lightIcon="https://i.imgur.com/7hztVhj.png" darkIcon="https://i.imgur.com/1yp4PNt.png" alt="trash" /> 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 <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> 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 <UiIcon lightIcon="https://i.imgur.com/7hztVhj.png" darkIcon="https://i.imgur.com/1yp4PNt.png" alt="trash" /> 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 <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> 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.
3 changes: 1 addition & 2 deletions docs/content/user-guide/products/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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)
11 changes: 0 additions & 11 deletions docs/content/user-guide/products/manage-digital.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/content/user-guide/taxes/tax-inclusive.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 5
hide_footer: true
---

# Tax Inclusive Pricing Overview
Expand Down

0 comments on commit 1167970

Please sign in to comment.