docs: documentation changes for release (#4300)
* docs: added manage reservations user guide (#4290) * docs: added manage reservations user guide * removed feature flag details * docs: added how-to for custom reservations (#4292) * docs: added how-to for custom reservations * eslint fixes * docs: added product module documentation (#4287) * docs: added product module documentation * added details about optional environment variables * small fixes * Remove reference link * added example usages * added link to sample project * address PR feedback * docs: moved product module guide + added product module tabs (#4307) * added product module tab * adjust design of badge * docs: added onboarding features (#4168) * added marketplace page * added subscription roadmap * added rating for onboarding * added learning path components * small fixes * fix build error * fix eslint errors * change roadmaps to recipes * small change in text * optimize learning path and notifications * fix tracking usage * fix eslint errors * added enter/exit animation * allow starting a path using a query parameter * fix gap between notifications * address vercel comments * fixed links issue * changed create-medusa-app docs steps * move troubleshooting section * improved tracking across docs * fix build errors * remove console * added a note about `boilerplate` option * added troubleshooting section for eagain * added invite option in cli reference * added track event for finished onboarding * update boilerplate option name * redesigned learning path component * docs: added how to create widget docs (#4318) * docs: added how to create widget docs * remove development guide * added types * docs: added details about createCustomAdminHooks (#4288) * docs: added details about createCustomAdminHooks * small improvement * added missing import * small changes * docs: added onboarding guide (#4320) * docs: added how to create widget docs * remove development guide * docs: added onboarding guide * added types * added recipes link * small adjustments * fixed eslint errors * styling fixes * change to singular product module * updated the what's new section * shorten down medusa react card * updated tailwind configurations * fix build error * fix newspaper icon * style fixes * change modal shadow * fix color of line numbers * fix code fade color * docs: updated admin documentations * eslint fixes * text changes * added a note about beta version * remove empty object argument * remove demo repo url * fix selection color for code headers * general fixes * fix eslint error * changed code theme * added preparation step * changes regarding beta version * Update docs/content/modules/products/serverless-module.md Co-authored-by: Riqwan Thamir <rmthamir@gmail.com> * Update docs/content/modules/products/serverless-module.md Co-authored-by: Riqwan Thamir <rmthamir@gmail.com> --------- Co-authored-by: Riqwan Thamir <rmthamir@gmail.com> Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
Shahed Nasser
GitHub
202
www/docs/src/utils/learning-paths.tsx
Normal file
202
www/docs/src/utils/learning-paths.tsx
Normal file
@@ -0,0 +1,202 @@
|
||||
import React from "react"
|
||||
import { LearningPathType } from "../providers/LearningPath"
|
||||
import Link from "@docusaurus/Link"
|
||||
|
||||
const paths: LearningPathType[] = [
|
||||
{
|
||||
name: "simple-quickstart",
|
||||
label: "Start Selling in 3 Steps",
|
||||
description: "Create and deploy a full-fledged ecommerce store.",
|
||||
steps: [
|
||||
{
|
||||
title: "Create a Next.js storefront",
|
||||
description:
|
||||
"Create a Next.js storefront and connect it to your Medusa backend.",
|
||||
path: "/starters/nextjs-medusa-starter",
|
||||
},
|
||||
{
|
||||
title: "Deploy the backend",
|
||||
path: "/deployments/server/deploying-on-railway",
|
||||
descriptionJSX: (
|
||||
<>
|
||||
Deploy your backend to Railway. You can alternatively check out{" "}
|
||||
<Link href="/deployments/server">other deployment guides</Link>
|
||||
</>
|
||||
),
|
||||
},
|
||||
{
|
||||
title: "Deploy the storefront",
|
||||
description: "Deploy your storefront to your preferred hosting.",
|
||||
path: "/deployments/storefront",
|
||||
},
|
||||
],
|
||||
finish: {
|
||||
type: "rating",
|
||||
step: {
|
||||
title: "Congratulations on building your store!",
|
||||
description: "Please rate your experience using this learning path.",
|
||||
eventName: "rating_path_simple-quickstart",
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "marketplace",
|
||||
label: "Build a marketplace",
|
||||
description:
|
||||
"Customize the backend and handle events to build a marketplace.",
|
||||
steps: [
|
||||
{
|
||||
title: "Extend entities",
|
||||
descriptionJSX: (
|
||||
<>
|
||||
Extend entities, such as <code>User</code> or <code>Product</code>{" "}
|
||||
entites, to associate them with the <code>Store</code> entity.
|
||||
</>
|
||||
),
|
||||
path: "/development/entities/extend-entity",
|
||||
},
|
||||
{
|
||||
title: "Access logged-in user",
|
||||
description:
|
||||
"Create a middleware that registers the logged-in user in the dependency container.",
|
||||
path: "/development/endpoints/example-logged-in-user",
|
||||
},
|
||||
{
|
||||
title: "Extend services",
|
||||
descriptionJSX: (
|
||||
<>
|
||||
Extend services, such as <code>ProductService</code> to customize
|
||||
data management functionalities
|
||||
</>
|
||||
),
|
||||
path: "/development/services/extend-service",
|
||||
},
|
||||
{
|
||||
title: "Handle events",
|
||||
descriptionJSX: (
|
||||
<>
|
||||
Listen to events like <code>order.placed</code> and handle them with
|
||||
subscribers
|
||||
</>
|
||||
),
|
||||
path: "/development/events/create-subscriber",
|
||||
},
|
||||
{
|
||||
title: "Add Payment Provider",
|
||||
path: "/plugins/payment",
|
||||
descriptionJSX: (
|
||||
<>
|
||||
Add a payment provider to your Medusa backend. You can choose to
|
||||
install a plugin or{" "}
|
||||
<Link href="/modules/carts-and-checkout/backend/add-payment-provider">
|
||||
create your own provider
|
||||
</Link>
|
||||
.
|
||||
</>
|
||||
),
|
||||
},
|
||||
{
|
||||
title: "Create a storefront",
|
||||
path: "/starters/nextjs-medusa-starter",
|
||||
descriptionJSX: (
|
||||
<>
|
||||
Build a storefront either using the Next.js starter or{" "}
|
||||
<Link href="/storefront/roadmap">from scratch</Link>.
|
||||
</>
|
||||
),
|
||||
},
|
||||
{
|
||||
title: "Deploy the backend",
|
||||
path: "/deployments/server/deploying-on-railway",
|
||||
descriptionJSX: (
|
||||
<>
|
||||
Deploy your backend to Railway. You can alternatively check out{" "}
|
||||
<Link href="/deployments/server">other deployment guides</Link>
|
||||
</>
|
||||
),
|
||||
},
|
||||
],
|
||||
finish: {
|
||||
type: "rating",
|
||||
step: {
|
||||
title: "Congratulations on building your marketplace!",
|
||||
description: "Please rate your experience using this learning path.",
|
||||
eventName: "rating_path_marketplace",
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "subscriptions",
|
||||
label: "Build Subscription-based Purchases",
|
||||
description:
|
||||
"Customize the backend and handle events to implement subscriptions",
|
||||
steps: [
|
||||
{
|
||||
title: "Extend entities",
|
||||
path: "/development/entities/extend-entity",
|
||||
descriptionJSX: (
|
||||
<>
|
||||
Extend entities, such as the <code>Order</code> entity, to associate
|
||||
them with the <code>Store</code> entity. You can also{" "}
|
||||
<Link href="/development/entities/create">
|
||||
Create a custom entity
|
||||
</Link>
|
||||
.
|
||||
</>
|
||||
),
|
||||
},
|
||||
{
|
||||
title: "Handle events",
|
||||
descriptionJSX: (
|
||||
<>
|
||||
Create a subscriber that listens to the <code>order.placed</code>{" "}
|
||||
event, or other{" "}
|
||||
<Link href="/development/events/events-list">events</Link>, and
|
||||
handles creating the subscription in Medusa.
|
||||
</>
|
||||
),
|
||||
path: "/development/events/create-subscriber",
|
||||
},
|
||||
{
|
||||
title: "Create a Scheduled Job",
|
||||
description:
|
||||
"Create a scheduled job that checks daily for subscriptions that needs renewal.",
|
||||
path: "/development/scheduled-jobs/create",
|
||||
},
|
||||
{
|
||||
title: "Create a storefront",
|
||||
path: "/starters/nextjs-medusa-starter",
|
||||
descriptionJSX: (
|
||||
<>
|
||||
Build a storefront either using the Next.js starter or{" "}
|
||||
<Link href="/storefront/roadmap">from scratch</Link>.
|
||||
</>
|
||||
),
|
||||
},
|
||||
{
|
||||
title: "Deploy the backend",
|
||||
path: "/deployments/server/deploying-on-railway",
|
||||
descriptionJSX: (
|
||||
<>
|
||||
Deploy your backend to Railway. You can alternatively check out{" "}
|
||||
<Link href="/deployments/server">other deployment guides</Link>
|
||||
</>
|
||||
),
|
||||
},
|
||||
],
|
||||
finish: {
|
||||
type: "rating",
|
||||
step: {
|
||||
title: "Congratulations on implementing subscription-based purchases!",
|
||||
description: "Please rate your experience using this learning path.",
|
||||
eventName: "rating_path_subscriptions",
|
||||
},
|
||||
},
|
||||
},
|
||||
]
|
||||
|
||||
export const getLearningPaths = () => paths
|
||||
|
||||
export const getLearningPath = (
|
||||
pathName: string
|
||||
): LearningPathType | undefined => paths.find((path) => path.name === pathName)
|
||||
Reference in New Issue
Block a user