Skip to content

Commit

Permalink
docs: added customize medusa admin docs (#2870)
Browse files Browse the repository at this point in the history
  • Loading branch information
shahednasser authored Dec 21, 2022
1 parent 34b5b63 commit 7c0ae7f
Show file tree
Hide file tree
Showing 4 changed files with 117 additions and 4 deletions.
100 changes: 100 additions & 0 deletions docs/content/admin/development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
# Customize Medusa Admin

In this document, you’ll learn how to customize the Medusa admin by forking it, and how to keep it updated with changes from the main repository.

## Overview

Although Medusa provides an intuitive admin that should cover all your ecommerce needs, you are free to customize the Medusa admin as you see fit.

For customization and development, it’s recommended that you fork the main Medusa admin repository. That way, you can configure your forked repository to pull changes from the main Medusa admin repository for any latest updates.

In this document, you’ll learn how to:

- Fork the Medusa admin repository.
- Configure the Medusa admin repository as an upstream repository.
- Pull changes from the upstream repository to keep your fork synced with the Medusa admin repository.

---

## Prerequisites

### Required Tools

[Git CLI tool](../tutorial/0-set-up-your-development-environment.mdx#git)

### Required Accounts

[GitHub](https://github.com/)

---

## Fork the Medusa Admin Repository

To fork the Medusa admin:

1. Go to the [Medusa admin repository](https://github.com/medusajs/admin).
2. Click on the Fork button at the top right.
3. You can optionally change the name of the repository and description.
4. Once done, click on the Create fork button.
5. After your fork is created, you can clone it using the following command:

```bash
git clone <REPOSITORY_URL>
```

Where `<REPOSITORY_URL>` is the HTTPS URL of your repository. You can obtain it from your forked repository’s GitHub page by clicking on the Code button and copying the URL.

---

## Configure Upstream Repository

To configure the Medusa admin as the upstream repository:

1. Change to the directory of your cloned forked repository.
2. Run the following command to add the Medusa admin repository as an upstream repository:

```bash
git remote add upstream https://github.com/medusajs/admin
```

1. You can verify that it has been added by running the following command:

```bash
git remote -v
```

You should see an `origin` repository which is your forked repository, and an `upstream` repository which is the Medusa admin repository.

---

## Update your Fork with Latest Changes

To update your fork with the latest changes from the Medusa admin repository:

1. Change to the directory of your cloned forked repository.
2. Run the following command to fetch the latest changes from the Medusa admin repository:

```bash
git fetch upstream
```

1. Make sure you’re on your `main` or `master` branch of the forked repository:

```bash
git checkout main
```

1. Merge the changes from the `main` branch of the Medusa admin repository:

```bash
git merge upstream/main
```

If your forked repository doesn’t have any conflicts with the changes from the Medusa admin repository, the merge will be done successfully. Otherwise, you’ll need to [resolve these conflicts](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line).

---

## What’s Next

- Check out the [Admin API reference](/api/admin).
- Learn about [local development of the Medusa server](../usage/local-development.md).
1 change: 1 addition & 0 deletions docs/content/admin/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,5 +135,6 @@ You can learn more about Medusa admin and its features in the [User Guide](../us

## What’s Next

- Learn how to [Customize Medusa Admin](./development.md)
- Install the [Next.js](../starters/nextjs-medusa-starter.md) or [Gatsby](../starters/gatsby-medusa-starter.md) storefront starters.
- [Learn how you can use `create-medusa-app` to install all of Medusa’s 3 components.](../usage/create-medusa-app.mdx)
2 changes: 1 addition & 1 deletion docs/content/usage/local-development.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Local Development
# Local Development of Medusa Server and Monorepo

In this document, you’ll learn how to customize Medusa’s core and run tests.

Expand Down
18 changes: 15 additions & 3 deletions www/docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -207,9 +207,21 @@ module.exports = {
]
},
{
type: "doc",
id: "usage/local-development",
},
type: "category",
label: 'Local Development',
items: [
{
type: "doc",
id: "usage/local-development",
label: "Server and Monorepo"
},
{
type: "doc",
id: "admin/development",
label: "Medusa Admin"
}
]
}
]
},
{
Expand Down

0 comments on commit 7c0ae7f

Please sign in to comment.