docs: improved SEO of documentation (#3117)

* docs: added description to documentation pages

* docs: added more descriptions

* docs: finished improving meta description

* docs: added searchbox structured data

* docs: added breadcrumbs structured data

* docs: added how to structured data

* docs: improved 404 page

* docs: added how-to frontmatter option
This commit is contained in:
Shahed Nasser
2023-01-26 15:58:33 +02:00
committed by GitHub
parent 4e82ec0734
commit 589cb18f98
158 changed files with 699 additions and 48 deletions
@@ -1,5 +1,7 @@
---
sidebar_position: 3
description: 'This user guide explains how to manage customer groups on the Medusa admin. Learn how to create and edit customer groups.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
@@ -1,5 +1,6 @@
---
sidebar_position: 1
description: 'Medusa admin allows merchants to manage customers and customer groups.'
---
# Customers Overview
@@ -1,5 +1,7 @@
---
sidebar_position: 2
description: 'This user guide explains how to manage customers on the Medusa admin. Learn how to view and edit customers.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
@@ -1,5 +1,7 @@
---
sidebar_position: 2
description: 'This user guide explains how to create a discount on the Medusa admin.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
@@ -1,5 +1,6 @@
---
sidebar_position: 1
description: 'Medusa admin allows merchants to manage discounts. Merchants can create discounts and manage their conditions.'
---
# Discounts Overview
@@ -1,5 +1,7 @@
---
sidebar_position: 3
description: 'This user guide explains how to manage discounts on the Medusa admin. Learn how to edit and delete discounts'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
@@ -1,5 +1,7 @@
---
sidebar_position: 3
description: 'This user guide explains how to manage custom gift cards on the Medusa admin. Learn how to create and edit custom gift cards.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
@@ -1,5 +1,6 @@
---
sidebar_position: 1
description: 'Medusa admin allows merchants to manage gift cards. Merchants can manage main and custom gift cards.'
---
# Gift Cards Overview
@@ -1,5 +1,7 @@
---
sidebar_position: 2
description: 'This user guide explains how to manage the main gift card on the Medusa admin. Learn how to create, edit, and delete a gift card.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
+1
View File
@@ -1,6 +1,7 @@
---
sidebar_position: 1
sidebar_label: Introduction
description: 'The user guide explains how to use the Medusa Admin for non technical users. Learn through easy steps how to use the Medusa admin to perform different operations and ecommerce tasks.'
---
import UiIcon from '@site/src/components/UiIcon';
+1
View File
@@ -1,5 +1,6 @@
---
sidebar_position: 2
description: 'Learn how to use utility features in the Medusa Admin including lists, quick and advanced filters, pagination, and search functionalities. You can also customize quick features.'
---
import UiIcon from '@site/src/components/UiIcon';
@@ -1,5 +1,7 @@
---
sidebar_position: 8
description: 'This user guide explains how to manage order claims on the Medusa Admin. Learn how to create claims, manage their returns and fulfillments, and more.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
@@ -1,5 +1,7 @@
---
sidebar_position: 5
description: 'This user guide explains how to manage draft orders on the Medusa Admin. Learn how to create a draft order, view its details, edit a draft order, cancel a draft order, and more.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
@@ -1,5 +1,7 @@
---
sidebar_position: 7
description: 'This user guide explains how to manage exchanges in the Medusa Admin. Learn how to create an order exchange, create an order exchange, mark an order exchange return as received, and cancel an exchange.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
@@ -1,5 +1,7 @@
---
sidebar_position: 9
description: 'This user guide explains how to export a list of orders on the Medusa admin.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
@@ -1,6 +1,8 @@
---
sidebar_position: 4
sidebar_label: Manage Fulfillments
description: 'This user guide explains how to manage order fulfillments in the Medusa Admin. Learn how to create fulfillments, mark fulfillments as shipped, and cancel fulfillments.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
+1
View File
@@ -1,6 +1,7 @@
---
sidebar_position: 1
sidebar_label: Overview
description: 'Medusa Admin allows merchants to manage orders. Merchants can view order information, capture payment, create shipments and fulfillments, and more.'
---
# Orders Overview
@@ -1,6 +1,8 @@
---
sidebar_position: 2
sidebar_label: Manage Details
description: 'Learn in this user guide how to manage orders on the Medusa Admin. Learn how to find the order details page, what information can be found on that page, and how to manage the order details such as shipping address or email.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
@@ -1,6 +1,7 @@
---
sidebar_position: 3
sidebar_label: Manage Payments
addHowToData: true
---
# Manage Order's Payments
@@ -1,6 +1,8 @@
---
sidebar_position: 6
sidebar_label: Manage Returns
description: 'This user guide explains how to manage order returns on the Medusa Admin. Learn how to request a return for an order, mark a return as received, and cancel a return.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
@@ -1,5 +1,7 @@
---
sidebar_position: 3
description: 'This user guide explains how to import prices to a price list on the Medusa admin.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
@@ -1,5 +1,6 @@
---
sidebar_position: 1
description: 'Medusa admin allows merchants to manage their price lists. Merchants can override prices or create sales using price lists.'
---
# Price Lists Overview
@@ -1,5 +1,7 @@
---
sidebar_position: 2
description: 'This user guide explains how to manage price lists on the Medusa admin. Learn how to create, edit, and delete price lists.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
@@ -1,5 +1,7 @@
---
sidebar_position: 3
description: 'This user guide explains how to manage collections on the Medusa admin. Learn how to create, edit, and delete collections.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
@@ -1,5 +1,7 @@
---
sidebar_position: 4
description: 'This user guide explains how to export a list of products on the Medusa admin.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
@@ -1,5 +1,7 @@
---
sidebar_position: 5
description: 'This user guide explains how to import a list of products into Medusa using the admin.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
@@ -1,5 +1,6 @@
---
sidebar_position: 1
description: 'Medusa admin allows merchants to manage products. Merchants can view products and collections, edit them, and more.'
---
import UiIcon from '@site/src/components/UiIcon';
@@ -1,5 +1,7 @@
---
sidebar_position: 2
description: 'This user guide explains how to manage products on the Medusa admin. Learn how to create a product, edit a product, and more.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
+1
View File
@@ -1,5 +1,6 @@
---
sidebar_position: 1
description: 'Medusa admin allows merchants to manage regions. Regions represent different countries within an ecommerce store.'
---
# Regions Overview
@@ -1,5 +1,7 @@
---
sidebar_position: 2
description: 'This user guide explains how to manage regions on the Medusa admin. Learn how to create and edit regions.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
@@ -1,11 +1,13 @@
---
sidebar_position: 3
sidebar_label: Manage Providers
description: 'This user guide explains how to manage payment and fulfillment providers in a region on the Medusa admin.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Payment and Fulfillment Providers
# Manage Payment and Fulfillment Providers in a Region
In this document, youll learn how to manage a regions payment and fulfillment providers in your Medusa Admin.
@@ -1,10 +1,13 @@
---
sidebar_position: 4
sidebar_label: Manage Shipping Options
description: 'This user guide explains how to manage shipping options in a region on the Medusa admin.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Shipping Options
# Manage Shipping Options in a Region
In this document, youll learn how to manage a regions shipping options in your Medusa Admin.
@@ -1,17 +1,12 @@
---
sidebar_position: 1
description: 'Medusa admin allows merchants to manage their sales channels. Merchants can separate products into multiple sales channels.'
---
# Sales Channels Overview
In this document, youll get an overview of sales channels in Medusa and learn about their importance in your ecommerce store.
:::note
Sales Channels are currently in beta mode and need to be [manually enabled in your store using feature flags](../../advanced/backend/feature-flags/toggle.md). If youre unsure how that works, please contact your technical team.
:::
## Overview
Sales Channels are multiple channels that you can sell your products through. For example, you can have a sales channel for the web storefront, another for the mobile app, and another for selling across social media platforms.
@@ -1,5 +1,7 @@
---
sidebar_position: 2
description: 'This user guide explains how to manage sales channels on the Medusa admin. Learn how to create, edit, and delete sales channels.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
@@ -1,6 +1,8 @@
---
sidebar_position: 3
sidebar_label: Manage Products
description: 'This user guide explains how to manage products in sales channels on the Medusa admin.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
@@ -1,5 +1,7 @@
---
sidebar_position: 2
description: 'This user guide explains how to manage currencies on the Medusa admin. Learn how to add currencies and set default currency.'
addHowToData: true
---
# Manage Currencies
@@ -1,5 +1,7 @@
---
sidebar_position: 4
description: 'This user guide explains how to manage publishable API keys on the Medusa admin. Learn how to create, edit, copy, and revoke publishable API keys.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
@@ -1,5 +1,7 @@
---
sidebar_position: 3
description: 'This user guide explains how to manage return reasons on the Medusa admin. Learn how to add, edit, and remove return reasons.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
@@ -1,5 +1,6 @@
---
sidebar_position: 1
description: 'This user guide explains how to manage the store details on the Medusa admin.'
---
# Manage Store Details
+1
View File
@@ -1,5 +1,6 @@
---
sidebar_position: 1
description: 'Medusa admin allows merchants to manage their taxes. Merchants can specify and configure taxes per region.'
---
# Taxes Overview
+2
View File
@@ -1,5 +1,7 @@
---
sidebar_position: 2
description: 'This user guide explains how to manage taxes on the Medusa admin. Learn how to edit their configurations.'
addHowToData: true
---
# Manage Taxes
@@ -1,5 +1,7 @@
---
sidebar_position: 5
description: 'This user guide explains how to manage tax inclusive pricing on the Medusa admin.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
@@ -1,5 +1,7 @@
---
sidebar_position: 4
description: 'This user guide explains how to manage tax overrides on the Medusa admin. Learn how to add, edit, and delete overrides.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
@@ -1,5 +1,7 @@
---
sidebar_position: 3
description: 'This user guide explains how to manage tax rates on the Medusa admin. Learn how to create, edit, and delete tax rates.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
+1
View File
@@ -1,5 +1,6 @@
---
sidebar_position: 1
description: 'Medusa admin can be accessed more than one user. Merchants can have users added into their team to use the Medusa admin.'
---
# Users Overview
+3 -1
View File
@@ -1,5 +1,7 @@
---
sidebar_position: 1
sidebar_position: 2
description: 'This user guide explains how to manage user profile on the Medusa admin. Learn how to edit a user profile and reset user password.'
addHowToData: true
---
# Manage Profile
+9 -1
View File
@@ -1,5 +1,7 @@
---
sidebar_position: 2
sidebar_position: 3
description: 'This user guide explains how to manage the team on the Medusa admin. Learn how to invite users to your team and edit their details.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
@@ -12,6 +14,8 @@ In this document, youll learn how to invite new users, edit other users in
You can view your team by going to Settings → The Team.
---
## Manage Invites
To add a new user to your team, you must invite them. Invites are sent by email, but you can also copy the invite link and send it personally to the user.
@@ -60,6 +64,8 @@ To remove an invite:
3. Click on “Remove invitation” from the dropdown.
4. Confirm removing the invitation by clicking the “Yes, remove” button in the pop-up.
---
## Edit a Users Details
To edit a users details in your team:
@@ -69,6 +75,8 @@ To edit a users details in your team:
3. In the new form, edit any of the users information.
4. Once done, click on the Save button.
---
## Remove a User
:::warning