Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: redesigned documentation #2539

Merged
merged 16 commits into from
Nov 3, 2022
Merged

docs: redesigned documentation #2539

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
1c73fcc
docs: redesigned navigation bar (#2478)
shahednasser Oct 20, 2022
e5ec16d
docs: redesigned homepage (#2480)
shahednasser Oct 20, 2022
fd41137
docs: redesigned notes (#2491)
shahednasser Oct 24, 2022
5172c18
docs: Applied Typography redesign rules (#2516)
shahednasser Oct 31, 2022
e114a50
docs: redesigned table of content (#2518)
shahednasser Nov 1, 2022
8822907
docs: redesigned code blocks (#2519)
shahednasser Nov 1, 2022
23bc7c1
docs: redesigned survey and content footer (#2522)
shahednasser Nov 2, 2022
d1efefc
docs: redesigned footer (#2523)
shahednasser Nov 2, 2022
2a157ad
docs: changed dark mode colors (#2524)
shahednasser Nov 2, 2022
b6d8518
docs: redesigned sidebar (#2535)
shahednasser Nov 3, 2022
8903483
docs: redesigned search modal (#2537)
shahednasser Nov 3, 2022
d8ec55a
docs: resolved loose ends (#2538)
shahednasser Nov 3, 2022
4f51e9e
Merge branch 'master' into docs/redesign
shahednasser Nov 3, 2022
75ca0a8
added spacing for tabs
shahednasser Nov 3, 2022
17e0887
docs: added no-zoom class for deploy images
shahednasser Nov 3, 2022
30aefbb
fix to tooltip design for inline code
shahednasser Nov 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/content/admin/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ If you’re not very familiar with Medusa’s architecture, you can learn more a

Instead of manually following this guide to install then later deploy the Medusa Admin, you can deploy the Medusa Admin to Netlify with this button:

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https:/medusajs/admin)
<a href="https://app.netlify.com/start/deploy?repository=https:/medusajs/admin" class="img-url">
<img src="https://www.netlify.com/img/deploy/button.svg" alt="Deploy to Netlify" class="no-zoom-img" />
</a>

## Install the Admin

Expand Down
8 changes: 4 additions & 4 deletions docs/content/advanced/admin/import-prices.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The first step is to upload the CSV file to import prices from.

You can do that by sending the following request to the [Upload Files](https://docs.medusajs.com/api/admin/#tag/Upload/operation/PostUploads) endpoint:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -111,7 +111,7 @@ To start a new price import, you must create a batch job.

You can do that by sending the following request to the [Create a Batch Job](https://docs.medusajs.com/api/admin/#tag/Batch-Job/operation/PostBatchJobs) endpoint:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -196,7 +196,7 @@ After creating the batch job, it will be pre-processed. At this point, the CSV f

You can retrieve all the details of the batch job, including its status and the brief statistics related to the prices by sending the following request:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -255,7 +255,7 @@ A batch job can be confirmed only once the batch job has the status `pre_process

To confirm a batch job send the following request:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down
8 changes: 4 additions & 4 deletions docs/content/advanced/admin/import-products.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The first step is to upload the CSV file that you want to import products.

You can do that by sending the following request to the [Upload Files](https://docs.medusajs.com/api/admin/#tag/Upload/operation/PostUploads) endpoint:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -105,7 +105,7 @@ To start a new product import, you must create a batch job.

You can do that by sending the following request to the [Create a Batch Job](https://docs.medusajs.com/api/admin/#tag/Batch-Job/operation/PostBatchJobs) endpoint:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -184,7 +184,7 @@ After creating the batch job, it will be pre-processed. At this point, the CSV f

You can retrieve all the details of the batch job, including its status and the brief statistics related to the products by sending the following request:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -243,7 +243,7 @@ A batch job can be confirmed only once the batch job has the status `pre_process

To confirm a batch job send the following request:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down
16 changes: 8 additions & 8 deletions docs/content/advanced/admin/use-customergroups-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ You can learn more about [authenticating as an admin user in the API reference](

You can create a customer group by sending a request to the Create Customer Group endpoint:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -93,7 +93,7 @@ This request requires the `name` parameter and optionally accepts the `metadata`

You can get a list of all customer groups by sending a request to the List Customer Groups endpoint:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -135,7 +135,7 @@ You can also pass filters and other selection query parameters to the request. C

You can retrieve a single customer group by sending a request to the Get a Customer Group endpoint:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -175,7 +175,7 @@ This request accepts the ID of the customer group to retrieve as a path paramete

You can update a customer group’s data by sending a request to the Update Customer Group endpoint:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -235,7 +235,7 @@ This request accepts the ID of the customer group as a path parameter, and optio

You can delete a customer group by sending a request to the Delete a Customer Group endpoint:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -279,7 +279,7 @@ This request accepts the ID of the customer group to delete as a path parameter.

You can add a customer to a group by sending a request to the Customer Group’s Add Customer endpoint:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -343,7 +343,7 @@ This request accepts the ID of the customer group as a path parameter. In its bo

You can retrieve a list of all customers in a customer group using the List Customers endpoint:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -387,7 +387,7 @@ Removing customers from a group does not remove them entirely. They’ll still b

You can remove customers from a customer group by sending a request to the Remove Customers endpoint:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down
6 changes: 3 additions & 3 deletions docs/content/advanced/backend/batch-jobs/create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ The first step is to create a batch job using the [Create Batch Job endpoint](ht

For example, this creates a batch job of the type `publish-products`:

<Tabs groupId="request-types">
<Tabs groupId="request-types" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -314,7 +314,7 @@ Make sure to replace `<YOUR_SERVER>` with the server URL where applicable.

You can retrieve the batch job afterward to get its status and view details about the process in the `result` property:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -367,7 +367,7 @@ Based on the batch job strategy implemented in this documentation, the `result`

To process the batch job, send a request to [confirm the batch job](https://docs.medusajs.com/api/admin/#tag/Batch-Job/operation/PostBatchJobsBatchJobConfirmProcessing):

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down
14 changes: 7 additions & 7 deletions docs/content/advanced/backend/price-lists/use-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ You can learn more about what the conditions you can apply on a price list and i

For example, sending the following request creates a price list with two prices: one that is applied when the maximum quantity of the product variant in the cart is 3; another is applied when the minimum quantity of the same variant in the cart is 4:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -172,7 +172,7 @@ You can check the full list of request body parameters in the [API reference](ht

You can retrieve all of a price list’s details using the Get a Price List endpoint:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -212,7 +212,7 @@ After creating a price list, you can update all of its fields including its stat

For example, by sending the following request the end date of the price list will be updated:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -274,7 +274,7 @@ You can also set the `override` request body parameter to `true` to replace the

For example, sending the following request adds a new price to the price list:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -346,7 +346,7 @@ For a full list of request body parameters, check out the [API reference](https:

You can delete all the prices of a product’s variants using the [Delete Product Prices](https://docs.medusajs.com/api/admin/#tag/Price-List/operation/DeletePriceListsPriceListProductsProductPrices) endpoint:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -386,7 +386,7 @@ This request returns the IDs of the deleted prices.

You can delete all the prices of a variant using the [Delete Variant Prices](https://docs.medusajs.com/api/admin/#tag/Price-List/operation/DeletePriceListsPriceListVariantsVariantPrices) endpoint:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -428,7 +428,7 @@ This request returns the IDs of the deleted prices.

You can delete a price list, and subsequently all prices defined in it, using the [Delete Price List](https://docs.medusajs.com/api/admin/#tag/Price-List/operation/DeletePriceListsPriceList) endpoint:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down
18 changes: 9 additions & 9 deletions docs/content/advanced/backend/sales-channels/manage-admin.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ You can learn more about [authenticating as an admin user in the API reference](

You can create a sales channel by sending a request to the Create a Sales Channel endpoint:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -111,7 +111,7 @@ It returns the created sales channel.

You can list all sales channels by sending a request to the List Sales Channels endpoint:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -151,7 +151,7 @@ This request returns an array of all sales channels in your store. You can also

You can retrieve a sales channel’s details by its ID using the Get Sales Channel endpoint:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -191,7 +191,7 @@ This request returns the sales channel with the specified ID.

You can update a Sales Channel’s details and attributes by sending a request to the Update Sales Channel endpoint:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -249,7 +249,7 @@ You can check out [the API Reference for a full list of body parameters](https:/

You can delete a sales channel by sending a request to the Delete Sales Channel endpoint with the ID of the sales channel to delete:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -293,7 +293,7 @@ The ID of the deleted sales channel is returned in the response.

To add a product to a sales channel, send a request to the Sales Channel’s Add Products endpoint:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -359,7 +359,7 @@ This request returns the sales channel.

You can list the products available in a sales channel by sending a request to the List Products endpoint and passing the `sales_channel_id` query parameter to filter by a specific sales channel:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -407,7 +407,7 @@ Deleting a product from a sales channel doesn't delete it completely. It only ma

You can delete a product from a sales channel by sending a request to the Sales Channel’s Delete Products endpoint:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down Expand Up @@ -475,7 +475,7 @@ This request returns the sales channel.

You can filter orders by a specific sales channel by sending a request to the List Orders endpoint and passing the `sales_channel_id` query parameter to filter by a specific sales channel:

<Tabs groupId="request-type">
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>

```jsx
Expand Down
4 changes: 4 additions & 0 deletions docs/content/advanced/backend/upgrade-guides/1-3-0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: 'Actions Required for v.1.3.0'
---

# v1.3.0

Version 1.3.0 of Medusa introduces new features including the addition of Line Item Adjustments and a more advanced Promotions API, as well as a change in loading environment variables into your Medusa server. The changes do not affect the public APIs and require only running necessary data migrations.
Expand Down
4 changes: 4 additions & 0 deletions docs/content/advanced/backend/upgrade-guides/1-3-6.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: 'Actions Required for v.1.3.0'
---

# v1.3.6

Following the addition of feature flags in version v1.3.3 and the addition of the Sales Channels API in v1.3.5, v1.3.6 introduces a data migration script that moves all products into the Default Sales Channel.
Expand Down
4 changes: 4 additions & 0 deletions docs/content/advanced/backend/upgrade-guides/1-3-8.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: 'Actions Required for v.1.3.0'
---

# v1.3.8

Updating your medusa server to version `1.3.8` may cause issues when using NPM. Please refer to this guide for more details on how to resolve it.
Expand Down
Loading