From beeb0d6154d7b42af97d5c3d7655ec6432a35338 Mon Sep 17 00:00:00 2001
From: Shahed Nasser <shahednasser@gmail.com>
Date: Fri, 15 Sep 2023 18:21:00 +0300
Subject: [PATCH] docs: added docs for multi-language support (#5026)

* docs: added docs for multi-language support

* fix sidebar

* fix sidebar ref

* added config step
---
 www/docs/content/admin/quickstart.mdx         | 14 +++++
 .../contribution/admin-translations.md        | 56 +++++++++++++++++++
 .../docs.md}                                  |  7 ++-
 www/docs/content/user-guide.mdx               |  6 ++
 www/docs/content/user-guide/users/profile.md  | 18 ++++++
 www/docs/sidebars.js                          | 13 ++++-
 www/docs/vercel.json                          |  4 ++
 7 files changed, 115 insertions(+), 3 deletions(-)
 create mode 100644 www/docs/content/contribution/admin-translations.md
 rename www/docs/content/{contribution-guidelines.md => contribution/docs.md} (99%)

diff --git a/www/docs/content/admin/quickstart.mdx b/www/docs/content/admin/quickstart.mdx
index d11177b183..4bc9143492 100644
--- a/www/docs/content/admin/quickstart.mdx
+++ b/www/docs/content/admin/quickstart.mdx
@@ -163,6 +163,20 @@ You can learn more about the admin dashboard and its features in the [User Guide
 
 ---
 
+## Multi-Language Support
+
+Medusa supports multiple languages and translations.
+
+Refer to this user guide to learn how to switch the language of the Medusa admin.
+
+:::note
+
+Can't find your language? Learn how you can contribute by translating the admin to other languages [here](../contribution/admin-translations.md).
+
+:::
+
+---
+
 ## Troubleshooting Installation
 
 <Troubleshooting
diff --git a/www/docs/content/contribution/admin-translations.md b/www/docs/content/contribution/admin-translations.md
new file mode 100644
index 0000000000..3d3436d92e
--- /dev/null
+++ b/www/docs/content/contribution/admin-translations.md
@@ -0,0 +1,56 @@
+---
+sidebar_label: "Admin Translation"
+sidebar_position: 2
+---
+
+# Contribute by Translating Admin
+
+In this document, you'll learn how you can contribute to Medusa by translating the Medusa admin.
+
+## Overview
+
+The Medusa admin supports multiple languages, with the default being English. To ensure a wide support for different languages, your contribution by translating to other languages you're fluent in is highly appreciated.
+
+This type of contribution is a no-code contribution, meaning you don't need advanced technical skills to contribute.
+
+---
+
+## How to Contribute Translation
+
+1\. Clone the [Medusa monorepository](https://github.com/medusajs/medusa) to your local machine:
+
+```bash
+git clone https://github.com/medusajs/medusa.git
+```
+
+If you already have it cloned, make sure to pull the latest changes from the `develop` branch.
+
+2\. Create a branch that will be used to open the pull request later:
+
+```bash
+git check -b feat/translate-<LANGUAGE>
+```
+
+Where `<LANGUAGE>` is your language name. For example, `feat/translate-da`.
+
+3\. Create a new directory under `packages/admin-ui/ui/public/locales` with its name being the [ISO 2 character code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) of your language. For example, `da`. In the new directory, create the file `translation.json`.
+
+4\. Copy the content of the English translation file located at `packages/admin-ui/ui/public/locales/en/translation.json` and paste it in your new `translation.json` file.
+
+5\. In the file, leave the key names as-is, and only translate the values.
+
+6\. Next, you need to add the new language into the multi-language configurations. To do that, go to the file `packages/admin-ui/ui/src/i18n/index.ts`.
+
+7\. In `packages/admin-ui/ui/src/i18n/index.ts`, add the new language to the `supportedLanguages` array as an object. The object accepts two properties: `locale` for the ISO 2 character code, and `name` for the name of the language. The name of the language should be the translated name, not the English name. For example:
+
+```ts title=packages/admin-ui/ui/src/i18n/index.ts
+export const supportedLanguages = [
+  // other languages...
+  {
+    locale: "da",
+    name: "Dansk",
+  },
+]
+```
+
+8\. Once you're done, push the changes into your branch and open a pull request on GitHub.
diff --git a/www/docs/content/contribution-guidelines.md b/www/docs/content/contribution/docs.md
similarity index 99%
rename from www/docs/content/contribution-guidelines.md
rename to www/docs/content/contribution/docs.md
index 6f86c2cc30..9db892e772 100644
--- a/www/docs/content/contribution-guidelines.md
+++ b/www/docs/content/contribution/docs.md
@@ -1,4 +1,9 @@
-# Contribution Guidelines
+---
+sidebar_label: "Docs"
+sidebar_position: 1
+---
+
+# Docs Contribution Guidelines
 
 Thank you for your interest in contributing to the documentation! You will be helping the open source community and other developers interested in learning more about Medusa and using it.
 
diff --git a/www/docs/content/user-guide.mdx b/www/docs/content/user-guide.mdx
index 11a77ab7f0..cb2f5c0aa5 100644
--- a/www/docs/content/user-guide.mdx
+++ b/www/docs/content/user-guide.mdx
@@ -61,6 +61,12 @@ At the top right you’ll find a <UiIcon lightIcon="https://res.cloudinary.com/d
 
 ![Notifications Window](https://res.cloudinary.com/dza7lstvk/image/upload/v1667924034/Medusa%20Docs/User%20Guide/cTIu9yP_ubsbqx.png)
 
+### Change Language
+
+The Medusa admin supports multiple-languages, with English being the default one.
+
+Learn how to change the language in [this guide](./user-guide/users/profile.md#change-admin-language).
+
 ### Quick Actions
 
 At the top left in the sidebar, you’ll find an avatar icon. By clicking this icon, you’ll see a dropdown. You can use this dropdown to access settings or sign out.
diff --git a/www/docs/content/user-guide/users/profile.md b/www/docs/content/user-guide/users/profile.md
index 5b7078261e..79e702299a 100644
--- a/www/docs/content/user-guide/users/profile.md
+++ b/www/docs/content/user-guide/users/profile.md
@@ -36,6 +36,24 @@ To edit your profile details:
 
 ---
 
+## Change Admin Language
+
+The Medusa admin supports multiple languages, and you can change the default language from your profile settings.
+
+To change the language:
+
+1. Go to Settings → Personal Information.
+2. For the Language field, select the language you want from the dropdown.
+3. The language will be saved and changed.
+
+:::tip
+
+Can't find your language? Learn how you can contribute by translating the admin to other languages [here](../../contribution/admin-translations.md).
+
+:::
+
+---
+
 ## Edit Analytics Preferences
 
 To edit your analytics collection preferences:
diff --git a/www/docs/sidebars.js b/www/docs/sidebars.js
index 38e06dc77d..88625c2821 100644
--- a/www/docs/sidebars.js
+++ b/www/docs/sidebars.js
@@ -440,13 +440,22 @@ module.exports = {
       className: "homepage-sidebar-item",
     },
     {
-      type: "doc",
-      id: "contribution-guidelines",
+      type: "category",
+      link: {
+        type: "doc",
+        id: "contribution/docs",
+      },
       label: "Contribution Guidelines",
       customProps: {
         sidebar_icon: "document-text",
       },
       className: "homepage-sidebar-item",
+      items: [
+        {
+          type: "autogenerated",
+          dirName: "contribution",
+        },
+      ],
     },
     {
       type: "doc",
diff --git a/www/docs/vercel.json b/www/docs/vercel.json
index f69491cd4a..5c658cde20 100644
--- a/www/docs/vercel.json
+++ b/www/docs/vercel.json
@@ -476,6 +476,10 @@
     {
       "source": "/recipes/rbac",
       "destination": "/modules/users/backend/rbac"
+    },
+    {
+      "source": "/contribution-guidelines",
+      "destination": "/contribution/docs"
     }
   ]
 }
\ No newline at end of file