Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cu 86c060qh5 documentation add user guide for UI #316

Merged
merged 19 commits into from
Sep 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added documentation/.gitbook/assets/29.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/.gitbook/assets/30.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/.gitbook/assets/31.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/.gitbook/assets/32.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/.gitbook/assets/33.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/.gitbook/assets/34.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/.gitbook/assets/35.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/.gitbook/assets/36.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/.gitbook/assets/37.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/.gitbook/assets/38.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/.gitbook/assets/40.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/.gitbook/assets/41.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/.gitbook/assets/42.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/.gitbook/assets/43.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/.gitbook/assets/44.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/.gitbook/assets/45.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/.gitbook/assets/46.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/.gitbook/assets/47.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/.gitbook/assets/48.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/.gitbook/assets/49.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/.gitbook/assets/50.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/.gitbook/assets/51.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/.gitbook/assets/52.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/.gitbook/assets/53.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/.gitbook/assets/54.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/.gitbook/assets/55.png
Binary file added documentation/.gitbook/assets/56.png
Binary file added documentation/.gitbook/assets/57.png
Binary file added documentation/.gitbook/assets/58.png
Binary file added documentation/.gitbook/assets/59.png
Binary file added documentation/.gitbook/assets/60.png
Binary file added documentation/.gitbook/assets/61.png
Binary file added documentation/.gitbook/assets/62.png
Binary file added documentation/.gitbook/assets/63.png
Binary file added documentation/.gitbook/assets/64.png
Binary file added documentation/.gitbook/assets/65.png
Binary file added documentation/.gitbook/assets/66.png
Binary file added documentation/.gitbook/assets/67.png
Binary file added documentation/.gitbook/assets/68.png
Binary file added documentation/.gitbook/assets/69.png
Binary file added documentation/.gitbook/assets/70.png
Binary file added documentation/.gitbook/assets/71.png
Binary file added documentation/.gitbook/assets/72.png
Binary file added documentation/.gitbook/assets/73.png
5 changes: 3 additions & 2 deletions documentation/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 2 additions & 2 deletions documentation/backup-and-restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**

Expand All @@ -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)
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions documentation/sso.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
579 changes: 579 additions & 0 deletions documentation/user-interface-guide.md

Large diffs are not rendered by default.

Loading