From d5e13fe3b621eb9a997dd8b41c6f1e7959e63505 Mon Sep 17 00:00:00 2001
From: HuyNguyen <quanghnguyen@linagora.com>
Date: Mon, 11 Mar 2024 17:55:06 +0700
Subject: [PATCH] TW-984: Add the documentation for configuration app grid

---
 docs/configurations/app_grid_configuration.md | 49 +++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 docs/configurations/app_grid_configuration.md

diff --git a/docs/configurations/app_grid_configuration.md b/docs/configurations/app_grid_configuration.md
new file mode 100644
index 0000000000..5223fb9f41
--- /dev/null
+++ b/docs/configurations/app_grid_configuration.md
@@ -0,0 +1,49 @@
+## Configuration for App Grid
+
+### Context
+- Twake Chat is a service inside Twake Workspace which include other services
+- User need to access other services from Twake Chat
+- Just only support for web version
+
+### How to config
+
+1. Add services to configuration file
+
+- Each service have the information:
+```
+    {
+      "appName": "Twake Chat",
+      "icon": "ic_twake_chat.svg",
+      "appLink": "https://beta.twake.app/",
+    }
+```
+
+- All services must be added to the configuration file [configurations\app_dashboard.json](https://github.com/linagora/twake-on-matrix/blob/main/configurations/app_dashboard.json)
+  For example:
+```
+{
+  "apps": [
+    {
+      "appName": "Twake Mail",
+      "icon": "ic_twake_mail.svg",
+      "appLink": "http://tmail.linagora.com/"
+    },
+    {
+      "appName": "Twake Chat",
+      "icon": "ic_twake_chat.svg",
+      "appLink": "https://beta.twake.app/"
+    },
+    ...
+  ]
+}
+```
+
+- `appName`: The name will be showed in App Grid
+- `icon`: Name of icon was added in `configurations\icons` folder
+- `appLink`: Service URL
+
+2. Enable it in [config.sample.json](https://github.com/linagora/twake-on-matrix/blob/main/config.sample.json)
+```
+app_grid_dashboard_available=true
+```
+If you want to disable it, please change the value to `false` or remove this from `config.sample.json`
\ No newline at end of file