docs: added new recipes (#4793)

* added new recipes

* added more recipes
This commit is contained in:
Shahed Nasser
2023-08-17 20:37:40 +03:00
committed by GitHub
parent 3b5590ccec
commit 57bb391146
12 changed files with 392 additions and 63 deletions
@@ -4,6 +4,7 @@ description: 'Learn what entities are in Medusa. There are entities defined in t
import DocCardList from '@theme/DocCardList';
import Icons from '@theme/Icon';
import LearningPath from '@site/src/components/LearningPath';
# Entities
@@ -17,6 +18,8 @@ Aside from the entities in the Medusa core package, you can also create custom e
Entities are based on [Typeorms Entities](https://typeorm.io/entities) and use Typeorm decorators. Each entity also require a [repository](./repositories.md) to be created. A repository provides basic methods to access and manipulate the entity's data.
<LearningPath pathName="entity-and-api" />
---
## Base Entities
@@ -5,11 +5,16 @@ addHowToData: true
import DocCardList from '@theme/DocCardList';
import Icons from '@theme/Icon';
import LearningPath from '@site/src/components/LearningPath';
# How to Create a Plugin
In this document, youll learn how to create a plugin and some tips for develoment. If youre interested to learn more about what plugins are and where to find available official and community plugins, check out the [overview document](./overview.mdx).
Alternatively, you can follow this recipe to create a plugin with step-by-step guidance.
<LearningPath pathName="plugin" />
## Prerequisites
You must have an existing Medusa project that you want to create the plugin with.
@@ -4,6 +4,7 @@ description: 'Learn what Plugins are and how they are used in Medusa. Plugins ar
import DocCardList from '@theme/DocCardList';
import Icons from '@theme/Icon';
import LearningPath from '@site/src/components/LearningPath';
# Plugins
@@ -23,6 +24,8 @@ Plugins run within the same process as the core Medusa backend eliminating the n
Plugins can contain customizations to the Medusa backend or the admin dashboard.
<LearningPath pathName="plugin" />
---
## Using Existing Plugins
+14 -2
View File
@@ -3,6 +3,7 @@ import DocCard from '@theme/DocCard';
import Icons from '@theme/Icon';
import Feedback from '@site/src/components/Feedback';
import LearningPath from '@site/src/components/LearningPath';
import LearningPathList from '@site/src/components/LearningPath/List';
import LargeCard from '@site/src/components/LargeCard';
import Button from '@site/src/components/Button';
@@ -60,15 +61,26 @@ Follow this guide if you want to implement subscription-based purhcases with Med
}
}} />
---
## Other Recipes
This section includes general recipes available to guide you through your development with Medusa.
<LearningPathList ignore={[
"simple-quickstart",
"marketplace",
"subscriptions"
]} />
<Feedback
event="survey_use_cases"
question="Did your find your use case?"
positiveQuestion="Is there anything that should improved?"
negativeQuestion="What was your use case?"
showLongForm={false}
/>
---
<!-- vale docs.HeadingPunctuation = NO -->
## Can't find your path?
+5
View File
@@ -5,6 +5,7 @@ description: 'Learn about the different resources you need and the general steps
import DocCardList from '@theme/DocCardList';
import DocCard from '@theme/DocCard';
import Icons from '@theme/Icon';
import LearningPath from '@site/src/components/LearningPath';
# Build Your Own Storefront Roadmap
@@ -16,6 +17,10 @@ Although Medusa provides a [Next.js Starter Template](../starters/nextjs-medusa-
This guide provides a roadmap that can guide you into how you can build your own storefront, regardless of what tools youre using.
You can instead follow this recipe that will guide you through implementing features in your storefront step-by-step.
<LearningPath pathName="storefront" />
---
## Connect to the Backend