docs: localization with contentful guide (#12202)

2025-04-30 13:27:31 +03:00
parent ceb504db2c
commit 4a9ac0d4be
15 changed files with 21807 additions and 15832 deletions
--- a/www/apps/book/public/llms-full.txt
+++ b/www/apps/book/public/llms-full.txt
--- a/www/apps/resources/app/integrations/guides/algolia/page.mdx
+++ b/www/apps/resources/app/integrations/guides/algolia/page.mdx
@@ -46,6 +46,8 @@ By following this tutorial, you'll learn how to:
 - Trigger Algolia reindexing when a product is created, updated, deleted, or when the admin manually triggers a reindex.
 - Customize the Next.js Starter Storefront to allow searching for products through Algolia.

+![Diagram illustrating the integration of Algolia with Medusa](https://res.cloudinary.com/dza7lstvk/image/upload/v1742889842/Medusa%20Resources/algolia-summary_lhegrr.jpg)
+
 <CardList items={[
  {
    href: "https://github.com/medusajs/examples/tree/main/algolia-integration",
@@ -463,7 +465,7 @@ Finally, you pass the products you received in the input to Algolia to create or

 A step function must return a `StepResponse` instance. The `StepResponse` constructor accepts two parameters:

-1. The step's output, which is the review created.
+1. The step's output, which in this case is `undefined`.
 2. Data to pass to the step's compensation function.

 #### Compensation Function
--- a/www/apps/resources/app/integrations/guides/contentful/page.mdx
+++ b/www/apps/resources/app/integrations/guides/contentful/page.mdx
--- a/www/apps/resources/app/integrations/page.mdx
+++ b/www/apps/resources/app/integrations/page.mdx
@@ -44,6 +44,14 @@ Integrate a third-party Content-Management System (CMS) to utilize rich content-

 <CardList
  items={[
+    {
+      href: "/integrations/guides/contentful",
+      title: "Contentful (Localization)",
+      badge: {
+        variant: "blue",
+        children: "Tutorial"
+      }
+    },
    {
      href: "/integrations/guides/sanity",
      title: "Sanity",
--- a/www/apps/resources/generated/edit-dates.mjs
+++ b/www/apps/resources/generated/edit-dates.mjs
@@ -6218,5 +6218,6 @@ export const generatedEditDates = {
  "references/core_flows/interfaces/core_flows.UpdateDraftOrderStepInput/page.mdx": "2025-04-24T08:23:57.295Z",
  "references/core_flows/interfaces/core_flows.ValidateDraftOrderStepInput/page.mdx": "2025-04-24T08:23:57.277Z",
  "app/commerce-modules/product/guides/variant-inventory/page.mdx": "2025-04-25T14:22:42.329Z",
-  "app/troubleshooting/validation-error/page.mdx": "2025-04-25T14:14:57.568Z"
+  "app/troubleshooting/validation-error/page.mdx": "2025-04-25T14:14:57.568Z",
+  "app/integrations/guides/contentful/page.mdx": "2025-04-30T09:54:16.698Z"
 }
--- a/www/apps/resources/generated/files-map.mjs
+++ b/www/apps/resources/generated/files-map.mjs
@@ -879,6 +879,10 @@ export const filesMap = [
    "filePath": "/www/apps/resources/app/integrations/guides/algolia/page.mdx",
    "pathname": "/integrations/guides/algolia"
  },
+  {
+    "filePath": "/www/apps/resources/app/integrations/guides/contentful/page.mdx",
+    "pathname": "/integrations/guides/contentful"
+  },
  {
    "filePath": "/www/apps/resources/app/integrations/guides/magento/page.mdx",
    "pathname": "/integrations/guides/magento"
--- a/www/apps/resources/generated/generated-commerce-modules-sidebar.mjs
+++ b/www/apps/resources/generated/generated-commerce-modules-sidebar.mjs
@@ -11348,6 +11348,14 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
              "title": "Implement Product Reviews",
              "path": "https://docs.medusajs.com/resources/how-to-tutorials/tutorials/product-reviews",
              "children": []
+            },
+            {
+              "loaded": true,
+              "isPathHref": true,
+              "type": "ref",
+              "title": "Localization with Contentful",
+              "path": "https://docs.medusajs.com/resources/integrations/guides/contentful",
+              "children": []
            }
          ]
        },
--- a/www/apps/resources/generated/generated-how-to-tutorials-sidebar.mjs
+++ b/www/apps/resources/generated/generated-how-to-tutorials-sidebar.mjs
@@ -375,6 +375,15 @@ const generatedgeneratedHowToTutorialsSidebarSidebar = {
          "description": "Learn how to implement a loyalty points system in your Medusa store.",
          "children": []
        },
+        {
+          "loaded": true,
+          "isPathHref": true,
+          "type": "ref",
+          "title": "Localization with Contentful",
+          "path": "/integrations/guides/contentful",
+          "description": "Learn how to implement localization in Medusa by integrating Contentful.",
+          "children": []
+        },
        {
          "loaded": true,
          "isPathHref": true,
--- a/www/apps/resources/generated/generated-integrations-sidebar.mjs
+++ b/www/apps/resources/generated/generated-integrations-sidebar.mjs
@@ -45,6 +45,14 @@ const generatedgeneratedIntegrationsSidebarSidebar = {
      "title": "CMS",
      "initialOpen": true,
      "children": [
+        {
+          "loaded": true,
+          "isPathHref": true,
+          "type": "link",
+          "path": "/integrations/guides/contentful",
+          "title": "Contentful",
+          "children": []
+        },
        {
          "loaded": true,
          "isPathHref": true,
--- a/www/apps/resources/sidebars/how-to-tutorials.mjs
+++ b/www/apps/resources/sidebars/how-to-tutorials.mjs
@@ -92,6 +92,13 @@ While tutorials show you a specific use case, they also help you understand how
        description:
          "Learn how to implement a loyalty points system in your Medusa store.",
      },
+      {
+        type: "ref",
+        title: "Localization with Contentful",
+        path: "/integrations/guides/contentful",
+        description:
+          "Learn how to implement localization in Medusa by integrating Contentful.",
+      },
      {
        type: "ref",
        title: "Magento Migration",
--- a/www/apps/resources/sidebars/integrations.mjs
+++ b/www/apps/resources/sidebars/integrations.mjs
@@ -30,6 +30,11 @@ export const integrationsSidebar = [
    title: "CMS",
    initialOpen: true,
    children: [
+      {
+        type: "link",
+        path: "/integrations/guides/contentful",
+        title: "Contentful",
+      },
      {
        type: "link",
        path: "/integrations/guides/sanity",
--- a/www/packages/tags/src/tags/product.ts
+++ b/www/packages/tags/src/tags/product.ts
@@ -75,6 +75,10 @@ export const product = [
    "title": "Implement Product Reviews",
    "path": "https://docs.medusajs.com/resources/how-to-tutorials/tutorials/product-reviews"
  },
+  {
+    "title": "Localization with Contentful",
+    "path": "https://docs.medusajs.com/resources/integrations/guides/contentful"
+  },
  {
    "title": "Build Wishlist Plugin",
    "path": "https://docs.medusajs.com/resources/plugins/guides/wishlist"
--- a/www/packages/tags/src/tags/server.ts
+++ b/www/packages/tags/src/tags/server.ts
@@ -71,6 +71,10 @@ export const server = [
    "title": "Use Workflow Engine Module",
    "path": "https://docs.medusajs.com/resources/infrastructure-modules/workflow-engine/how-to-use"
  },
+  {
+    "title": "Integrate Contentful",
+    "path": "https://docs.medusajs.com/resources/integrations/guides/contentful"
+  },
  {
    "title": "Build Wishlist Plugin",
    "path": "https://docs.medusajs.com/resources/plugins/guides/wishlist"
--- a/www/packages/tags/src/tags/tutorial.ts
+++ b/www/packages/tags/src/tags/tutorial.ts
@@ -35,6 +35,10 @@ export const tutorial = [
    "title": "Product Reviews",
    "path": "https://docs.medusajs.com/resources/how-to-tutorials/tutorials/product-reviews"
  },
+  {
+    "title": "Integrate Contentful",
+    "path": "https://docs.medusajs.com/resources/integrations/guides/contentful"
+  },
  {
    "title": "Build Wishlist Plugin",
    "path": "https://docs.medusajs.com/resources/plugins/guides/wishlist"
--- a/www/vale/styles/docs/ModuleNames.yml
+++ b/www/vale/styles/docs/ModuleNames.yml
@@ -19,4 +19,5 @@ exceptions:
  - the specified module
  - the associated module
  - the stored module
-  - the read-only module
+  - the read-only module
+  - the necessary module