Merge pull request #316 from jembi/CU-86c060qh5_Documentation-Add-use…

…r-guide-for-UI Cu 86c060qh5 documentation add user guide for UI
jembi · Sep 11, 2024 · 478cefc · 478cefc
2 parents 178a3ed + 5f46621
commit 478cefc
Show file tree

Hide file tree

Showing 49 changed files with 600 additions and 22 deletions.
diff --git a/documentation/.gitbook/assets/29.png b/documentation/.gitbook/assets/29.png
diff --git a/documentation/.gitbook/assets/30.png b/documentation/.gitbook/assets/30.png
diff --git a/documentation/.gitbook/assets/31.png b/documentation/.gitbook/assets/31.png
diff --git a/documentation/.gitbook/assets/32.png b/documentation/.gitbook/assets/32.png
diff --git a/documentation/.gitbook/assets/33.png b/documentation/.gitbook/assets/33.png
diff --git a/documentation/.gitbook/assets/34.png b/documentation/.gitbook/assets/34.png
diff --git a/documentation/.gitbook/assets/35.png b/documentation/.gitbook/assets/35.png
diff --git a/documentation/.gitbook/assets/36.png b/documentation/.gitbook/assets/36.png
diff --git a/documentation/.gitbook/assets/37.png b/documentation/.gitbook/assets/37.png
diff --git a/documentation/.gitbook/assets/38.png b/documentation/.gitbook/assets/38.png
diff --git a/documentation/.gitbook/assets/40.png b/documentation/.gitbook/assets/40.png
diff --git a/documentation/.gitbook/assets/41.png b/documentation/.gitbook/assets/41.png
diff --git a/documentation/.gitbook/assets/42.png b/documentation/.gitbook/assets/42.png
diff --git a/documentation/.gitbook/assets/43.png b/documentation/.gitbook/assets/43.png
diff --git a/documentation/.gitbook/assets/44.png b/documentation/.gitbook/assets/44.png
diff --git a/documentation/.gitbook/assets/45.png b/documentation/.gitbook/assets/45.png
diff --git a/documentation/.gitbook/assets/46.png b/documentation/.gitbook/assets/46.png
diff --git a/documentation/.gitbook/assets/47.png b/documentation/.gitbook/assets/47.png
diff --git a/documentation/.gitbook/assets/48.png b/documentation/.gitbook/assets/48.png
diff --git a/documentation/.gitbook/assets/49.png b/documentation/.gitbook/assets/49.png
diff --git a/documentation/.gitbook/assets/50.png b/documentation/.gitbook/assets/50.png
diff --git a/documentation/.gitbook/assets/51.png b/documentation/.gitbook/assets/51.png
diff --git a/documentation/.gitbook/assets/52.png b/documentation/.gitbook/assets/52.png
diff --git a/documentation/.gitbook/assets/53.png b/documentation/.gitbook/assets/53.png
diff --git a/documentation/.gitbook/assets/54.png b/documentation/.gitbook/assets/54.png
diff --git a/documentation/.gitbook/assets/55.png b/documentation/.gitbook/assets/55.png
diff --git a/documentation/.gitbook/assets/56.png b/documentation/.gitbook/assets/56.png
diff --git a/documentation/.gitbook/assets/57.png b/documentation/.gitbook/assets/57.png
diff --git a/documentation/.gitbook/assets/58.png b/documentation/.gitbook/assets/58.png
diff --git a/documentation/.gitbook/assets/59.png b/documentation/.gitbook/assets/59.png
diff --git a/documentation/.gitbook/assets/60.png b/documentation/.gitbook/assets/60.png
diff --git a/documentation/.gitbook/assets/61.png b/documentation/.gitbook/assets/61.png
diff --git a/documentation/.gitbook/assets/62.png b/documentation/.gitbook/assets/62.png
diff --git a/documentation/.gitbook/assets/63.png b/documentation/.gitbook/assets/63.png
diff --git a/documentation/.gitbook/assets/64.png b/documentation/.gitbook/assets/64.png
diff --git a/documentation/.gitbook/assets/65.png b/documentation/.gitbook/assets/65.png
diff --git a/documentation/.gitbook/assets/66.png b/documentation/.gitbook/assets/66.png
diff --git a/documentation/.gitbook/assets/67.png b/documentation/.gitbook/assets/67.png
diff --git a/documentation/.gitbook/assets/68.png b/documentation/.gitbook/assets/68.png
diff --git a/documentation/.gitbook/assets/69.png b/documentation/.gitbook/assets/69.png
diff --git a/documentation/.gitbook/assets/70.png b/documentation/.gitbook/assets/70.png
diff --git a/documentation/.gitbook/assets/71.png b/documentation/.gitbook/assets/71.png
diff --git a/documentation/.gitbook/assets/72.png b/documentation/.gitbook/assets/72.png
diff --git a/documentation/.gitbook/assets/73.png b/documentation/.gitbook/assets/73.png
diff --git a/documentation/SUMMARY.md b/documentation/SUMMARY.md
@@ -8,5 +8,6 @@
 * [API](api.md)
 * [Single Sign-On](sso.md)
 * [Backup and Restore](backup-and-restore.md)
-* [User Interface User Guide](user-interface-user-guide.md)
-* [Road Map](road-map.md)
+* [User Interface Guide](user-interface-guide.md)
+* [Configuration User Guide](configuration-user-guide.md)
+* [Road Map](road-map.md)
diff --git a/documentation/backup-and-restore.md b/documentation/backup-and-restore.md
@@ -59,7 +59,7 @@ JeMPI/devops/linux/docker/backup_restore/postgres-backup.sh
 
 The backup process creates a folder with a timestamp. Inside this folder, backups are created for each Dgraph and Postgres.
 
-![Backup Postgres and Dgraph](../.gitbook/assets/14)
+![Backup Postgres and Dgraph](.gitbook/assets/14)
 
 **Manual Backup Process**
 
@@ -86,4 +86,4 @@ Select Option 6: Restore Postgres & Dgraph
 - **Backup Directory Postgres:** JeMPI/devops/linux/docker/docker_data/data/backups/postgres
 - **Manual Backup Run Script:** ./restore-dgraph-postgres.sh {{ Folder_Name }}
 
-![Restore Postgres and Dgraph](../.gitbook/assets/15)
+![Restore Postgres and Dgraph](.gitbook/assets/15)
diff --git a/documentation/user-interface-user-guide.md → documentation/configuration-user-guide.md b/documentation/user-interface-user-guide.md → documentation/configuration-user-guide.md
@@ -35,19 +35,18 @@ The deterministic tab has three sub tabs :
 
 **Design view**
 this view allows the user to do the following :
-- Select the operator values from a drop down field eg “And” and “Or”
-- Select common field values from a drop down field
-- Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc
-- Add a second row of input fields by selecting the add add icon button
+- Select the operator values from a dropdown field, e.g., "And" and "Or"
+- Select common field values from a dropdown field
+- Select comparator function from a dropdown field, e.g., "Exact", "Low Fuzziness", etc.
+- Add a second row of input fields by selecting the add icon button
 - Save rule by selecting the add rule button
 - Exit edit mode and cancel previous edits.
-- Delete existing row of input fields
+- Delete the existing row of input fields
 ![Determistic Design View](.gitbook/assets/22)
-
 **Blocking**
 The blocking tab  is used to define the blocking rules. 
 
-The blocking tabs has two sub tabs : 
+The blocking tabs have two sub tabs: 
 - Linking 
 - Matching 
 
@@ -61,24 +60,23 @@ This view allows the user to do the following :
 ![Blocking Source View](.gitbook/assets/23)
 
 **Design view**
-This view must allows the user to do the following :
+This view must allow the user to do the following:
 
-- Select the operator values from a drop down field eg “And” and “Or”
-- Select common field values from a drop down field.
-- Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc
-- Add a second row of input fields by selecting the add add icon button
+- Select the operator values from a dropdown field, e.g., "And" and "Or"
+- Select common field values from a dropdown field.
+- Select comparator function from a dropdown field, e.g., "Exact", "Low Fuzziness", etc.
+- Add a second row of input fields by selecting the add icon button
 - Save rule by selecting the add rule button
 - Exit edit mode and cancel previous edits.
-- Delete existing row of input fields
+- Delete the existing row of input fields
 ![Blocking Design View](.gitbook/assets/25)
-
 **Probabilistic**
    In the Probabilistic tab the user can  define the linking threshold ranges and/or values. 
 
 All values must be entered as per the rules defined.
 ![Probabilistic Tab](.gitbook/assets/26)
 
-**Rules on threshold slider**
+## Rules on threshold slider
 - Do not allow the link threshold (green circle):
 To be < the Minimum threshold review value
 To be > the Maximum threshold review value

diff --git a/documentation/sso.md b/documentation/sso.md
@@ -42,13 +42,13 @@ cd devops/linux/docker/deployment
 ./local-deployment.sh
 ```
 
-![Deployment Script Options](../.gitbook/assets/13)
+![Deployment Script Options](.gitbook/assets/13)
 
 4. Select Option 1: Deploy JeMPI (For Fresh Start)
 6. Access : http://localhost:3000/login
 
-![JeMPI Web Keycloak Sign in](../.gitbook/assets/16)
+![JeMPI Web Keycloak Sign in](.gitbook/assets/16)
 
 7. Sign in with Keycloak user credentials
 
-![JeMPI Web Keycloak Sign in](../.gitbook/assets/17)
+![JeMPI Web Keycloak Sign in](.gitbook/assets/17)
diff --git a/documentation/user-interface-guide.md b/documentation/user-interface-guide.md