From 72bf80b4321ac2ac5a5eae78e641a8920f93e395 Mon Sep 17 00:00:00 2001
From: DrMint <29893320+DrMint@users.noreply.github.com>
Date: Sun, 9 Apr 2023 10:00:12 +0200
Subject: [PATCH] Added some documentation

---
 README.md                       | 17 +++++++++++++++++
 src/core/helpers/formatters.ts  |  1 -
 src/core/helpers/libraryItem.ts |  1 -
 3 files changed, 17 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 902c534..161a447 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,18 @@
 # Import data from Strapi to Meilisearch engine
+
+## Migration guide
+
+All the indexes are deleted and recreated when running the connector. Because of this, migration is not much of a problem. However, one thing needs to be preserved when upgrading: the auth keys (both the master and the ones used by this connector and the actual website).
+
+To do that, here's a guide:
+
+1. Stop the services (both this connector and the docker container)
+2. Create a backup of `meili_data`, let's call it `meili_data.bk`
+3. Use this command to update to the latest version of Meilisearch `docker compose pull`
+4. Start the docker container `docker compose up`
+5. Stop it after it successfully initialized
+6. Delete the following folder `rm -r meili_data/data.ms/auth`
+7. Replace the deleted folder with the one from our backup `cp -r meili_data.bk/data.ms/auth meili_data/data.ms/`
+8. Run the docker container, then the connector
+
+Your instance is now updated, the auth keys are preserved and the search data has been populated by the connector.
\ No newline at end of file
diff --git a/src/core/helpers/formatters.ts b/src/core/helpers/formatters.ts
index 8be6be6..db4e03c 100644
--- a/src/core/helpers/formatters.ts
+++ b/src/core/helpers/formatters.ts
@@ -23,7 +23,6 @@ export const prettyInlineTitle = (
   return result;
 };
 
-/* eslint-disable id-denylist */
 export const prettyItemSubType = (
   metadata:
     | {
diff --git a/src/core/helpers/libraryItem.ts b/src/core/helpers/libraryItem.ts
index fb7e11b..48642a5 100644
--- a/src/core/helpers/libraryItem.ts
+++ b/src/core/helpers/libraryItem.ts
@@ -4,7 +4,6 @@ export const isUntangibleGroupItem = (
   metadata:
     | {
         __typename: string;
-        // eslint-disable-next-line id-denylist
         subtype?: { data?: { attributes?: { slug: string } | null } | null } | null;
       }
     | null