chore: reorganize docs apps (#7228)

* reorganize docs apps

* add README

* fix directory

* add condition for old docs
This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-05-03 17:36:38 +03:00
1 parent 224ebb2154
commit 4fe28f5a95
6187 files changed
+601447 -598226

No files matched your search

@@ -0,0 +1,41 @@
---
sidebar_position: 1
---
import { EllipsisHorizontal } from "@medusajs/icons"
export const metadata = {
title: `Manage Inventory`,
}
# {metadata.title}
In this document, you’ll learn how to manage inventory in the Medusa Admin.
## Check Inventory
To check your store’s inventory, go to the Inventory page. Here, you’ll see the all available inventory of product variants.
### Filter by Location
To filter the shown results by location:
1. Click on the "Add filter" button.
2. Select Location from the dropdown.
3. Select the location(s) to filter ther results by.
---
## Change Variant Inventory Quantity
{/* TODO check info for correctness */}
To change a product variant’s inventory quantity:
1. Go to the Inventory page.
2. Click the product variant to edit its inventory.
3. Under the "Location levels" section, find the location to edit the quantity in.
4. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right of the location.
5. Choose "Adjust availability" from the dropdown.
6. In the drawer that opens, edit the "In Stock" field with the new stock quantity of the variant.
7. Once you're done, click the Save button.
@@ -0,0 +1,33 @@
---
sidebar_autogenerate_exclude: true
---
export const metadata = {
title: `Inventory`,
}
# {metadata.title}
In this document, you’ll get an overview of the inventory domain of the Medusa Admin.
## Overview
When a product variant's "Manage Inventory" is enabled, inventory items are created for that variant to manage its quantity.
An inventory item has different quantities for each [location](../settings/locations/page.mdx).
<Note>
The following aren't explained within this section of the user guide:
- Item allocation and locations in orders: this is explained in the [Manage Orders guide](../orders/manage/page.mdx).
- Managing general inventory of a product variant: this is explained in the [Manage Products guide](../products/manage/page.mdx).
</Note>
---
## Learn More About Inventory
- [Manage Inventory](./inventory/page.mdx)
- [Manage Reservations](./reservations/page.mdx)
@@ -0,0 +1,79 @@
---
sidebar_position: 3
---
import { EllipsisHorizontal } from "@medusajs/icons"
export const metadata = {
title: `Manage Reservations`,
}
# {metadata.title}
In this document, you’ll learn how to manage reservations in your store.
## View Reservations
To view reservations, go to Inventory from the sidebar, the click the Reservations sub-item shown in the sidebar.
In the reservations page, you can view all reservations.
### Filter by Location
To filter reservations by location:
1. Click the "Add filter" button.
2. Choose Location from the dropdown.
3. Choose the locations(s) to filter the list by.
---
## Create a Reservation
{/* TODO check info for correctness */}
Reservations are created manually when an order is created. You can also manage them from the order’s page.
To manually create a reservation item:
1. Go to Inventory → Reservations.
2. Click on the Create button.
3. In the form that opens:
1. For the “Location” field, select the location the reservation is created in.
2. For the “Item to reserve” field, enter or choose the SKU of the item you want to create a reservation for.
3. Set the reserved quantity in the "Reserve amount" field.
4. You can optionally add a description in the Description field, or add additional data as key-value pairs under the Metadata section.
4. Once you’re done, click the Save button.
---
## Edit Reservation
{/* TODO check info for correctness */}
To edit a reservation:
1. Go to Inventory → Reservations
2. Find the reservation you want to edit, and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon on its right.
3. Choose Edit from the dropdown.
4. In the drawer that opens, edit the reservation's details.
5. Once you’re done, click the Save button.
---
## Delete Reservation
<Note type="warning">
Deleting a reservation is irreversible.
</Note>
{/* TODO check info for correctness */}
To delete a reservation:
1. Go to Inventory → Reservations
2. Find the reservation you want to delete, and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon on its right.
3. Choose Delete from the dropdown.
4. Confirm deleting the reservation by clicking the Remove button in the pop-up.