diff --git a/guides/user-guides/README.md b/guides/user-guides/README.md index aef1b519..5bf4dc3c 100644 --- a/guides/user-guides/README.md +++ b/guides/user-guides/README.md @@ -1,2 +1,2 @@ -# User Guides +# 📔 User Guides diff --git a/guides/user-guides/assign-roles-to-users.md b/guides/user-guides/assign-roles-to-users.md index 78764b6c..86a88b60 100644 --- a/guides/user-guides/assign-roles-to-users.md +++ b/guides/user-guides/assign-roles-to-users.md @@ -2,23 +2,30 @@ ## Description -The guide here provides steps to create a new user and assign a role. This process is typically done by the Administrator. +This document contains the step-by-step instruction to create a new user and assign a role. A person who has admin access can create a new user and assign a role. ## Pre-requisites -The user should have an Administrator role. +A user should have an admin access to create a new user and assign a role. -## Steps +## Procedure -1. Navigate to _Settings_ using the menu bar. +1. In the menu bar, click the icon ![](../../.gitbook/assets/image.png) and select _**Settings**_. +2. The _**Settings**_ screen is displayed -
+

Choose Settings Screen

-2. Click on _Users & Companies_ and then select _Users_ to reach user's list view page. -
-3. Click on the _Create_ button to reach user creation page. +

Settings Screen

+ +2. Click the _**Users & Companies**_ tab and then select _**Users**_. + + + +
+ +2. Click on the _Create_ button to reach user creation page.
diff --git a/guides/user-guides/configure-notification-manager.md b/guides/user-guides/configure-notification-manager.md index b864fb18..243c99ca 100644 --- a/guides/user-guides/configure-notification-manager.md +++ b/guides/user-guides/configure-notification-manager.md @@ -10,11 +10,11 @@ The user must have the Program Manager role. ## Steps -1. Navigate to _Programs_ using the menu bar. +1. Navigate to _Programs_ using the menu bar.
-2. Click on the program name for which configuration to be done. +2. Click on the program name for which configuration to be done.
@@ -22,19 +22,19 @@ The user must have the Program Manager role.
-4. Click on _Add a line_ in the Notification Manager section. +4. Click on _Add a line_ in the Notification Manager section.
-5. Click on the _Create_ button on the Add: Notification Managers pop-up window. +5. Click on the _Create_ button on the Add: Notification Managers pop-up window.
-6. Select the notification manager type. +6. Select the notification manager type.
-7. Once the name is provided to the deduplication manager, _Create and Edit_ buttons will appear. Click on _Create and Edit_ to create a deduplication manager. +7. Once the name is provided to the deduplication manager, _Create and Edit_ buttons will appear. Click on _Create and Edit_ to create a deduplication manager.
diff --git a/guides/user-guides/create-a-program.md b/guides/user-guides/create-a-program.md index 7266805f..3a6e6ccf 100644 --- a/guides/user-guides/create-a-program.md +++ b/guides/user-guides/create-a-program.md @@ -22,20 +22,20 @@ The user must have a Program Manager role. See [Create User and Assign Role](ass

Configure eligibility criteria

-4. Use\_+Add filter\_ to set eligibility criteria using [Domain Filters](broken-reference). You may set multiple eligibility criteria. -5. **Cycle Manager:** Set parameters of [disbursement cycles](broken-reference). +4. Use\_+Add filter\_ to set eligibility criteria using [Domain Filters](../../beneficiary-management/eligibility.md#domain-filters). You may set multiple eligibility criteria. +5. **Cycle Manager:** Set parameters of [disbursement cycles](../../beneficiary-management/disbursement-cycles.md).
* _Auto-approve Entitlements:_ To set entitlements via rules, without any manual approvals. * _Approver Group:_ The group name of the user who has permission to approve cycles. See [Create User and Assign Role](assign-roles-to-users.md). * _Recurrence:_ The time period for the repetition of a cycle. -6. **Entitlement Manager:** Set parameters for [entitlements](broken-reference). +6. **Entitlement Manager:** Set parameters for [entitlements](../../beneficiary-management/entitlement.md).
* _Amount Per Cycle:_ The amount disbursement of a group or individual per cycle. - * _Amount Per Individual In Group:_ Amount of disbursement per individual in a group when the program [target type](broken-reference) is "group". + * _Amount Per Individual In Group:_ Amount of disbursement per individual in a group when the program [target type](../../beneficiary-management/#target-types) is "group". * _Maximum number of individuals in a group:_ Maximum number of individuals who get disbursements per group (optional). * _Transfer Fee(%):_ Fee incurred for disbursement as a percentage of disbursement (optional). * _Transfer Fee Amount:_ Fee incurred for disbursement as an absolute amount (optional). diff --git a/guides/user-guides/create-and-approve-disbursement-cycle.md b/guides/user-guides/create-and-approve-disbursement-cycle.md index 56ebf172..731742cf 100644 --- a/guides/user-guides/create-and-approve-disbursement-cycle.md +++ b/guides/user-guides/create-and-approve-disbursement-cycle.md @@ -1,4 +1,4 @@ -# Create and Approve Program Cycle +# Create and Approve Disbursement Cycle ## Description @@ -24,7 +24,7 @@ The user should have a role which is configured in the _Approver Group_ under _C
-4. Navigate inside the cycle using the arrow icon button beside the cycle name. +4. Navigate inside the cycle using the arrow icon button beside the cycle name. 5. After clicking on _Copy Beneficiaries from Program_ button program beneficiaries will be copied into the cycle.
@@ -40,3 +40,4 @@ The user should have a role which is configured in the _Approver Group_ under _C 8. Once more click on _Approve_ button to approve the cycle and the cycle status will be moved from _To Approve_ to _Approved._
+ diff --git a/guides/user-guides/create-deduplication-manager.md b/guides/user-guides/create-deduplication-manager.md index ef2e0c7c..1ed31aaf 100644 --- a/guides/user-guides/create-deduplication-manager.md +++ b/guides/user-guides/create-deduplication-manager.md @@ -34,7 +34,7 @@ The user must have the Program Manager role.
-7. Once the name is provided to the deduplication manager, Create and Edit buttons will appear to click on Create and Edit button to create a deduplication manager. +7. Once the name is provided to the deduplication manager, Create and Edit buttons will appear to click on Create and Edit button to create a deduplication manager.
diff --git a/guides/user-guides/create-eligibility-manager-1/README.md b/guides/user-guides/create-eligibility-manager-1/README.md index 27e3c1dc..bbb889ca 100644 --- a/guides/user-guides/create-eligibility-manager-1/README.md +++ b/guides/user-guides/create-eligibility-manager-1/README.md @@ -6,4 +6,5 @@ There are 3 types of eligibility managers available that can be created and then 1. [Default Eligibility Manager](create-default-eligibility-manager.md) 2. [ID Document Eligibility Manager](copy-of-create-id-document-eligibility-manager.md) -3. [Phone Number Eligibility Manager](create-phone-number-eligibility-manager.md) +3. [Phone Number Eligibility Manager](../create-eligibility-manager-types/create-phone-number-eligibility-manager.md) + diff --git a/guides/user-guides/create-eligibility-manager-1/copy-of-create-id-document-eligibility-manager.md b/guides/user-guides/create-eligibility-manager-1/copy-of-create-id-document-eligibility-manager.md index 1b06b25b..2fd514c8 100644 --- a/guides/user-guides/create-eligibility-manager-1/copy-of-create-id-document-eligibility-manager.md +++ b/guides/user-guides/create-eligibility-manager-1/copy-of-create-id-document-eligibility-manager.md @@ -14,7 +14,7 @@ user should have a Program Manager role.
-2. Click on _Configuration_ and then on _ID document Eligibility Manager._ +2. Click on _Configuration_ and then on _ID document Eligibility Manager._
@@ -26,6 +26,6 @@ user should have a Program Manager role.
-5. Click the _Save_ button to save the eligibility manager and it will be listed under the eligibility manager list view page. +5. Click the _Save_ button to save the eligibility manager and it will be listed under the eligibility manager list view page.
diff --git a/guides/user-guides/create-eligibility-manager-1/create-default-eligibility-manager.md b/guides/user-guides/create-eligibility-manager-1/create-default-eligibility-manager.md index 55b0c632..06d93947 100644 --- a/guides/user-guides/create-eligibility-manager-1/create-default-eligibility-manager.md +++ b/guides/user-guides/create-eligibility-manager-1/create-default-eligibility-manager.md @@ -14,7 +14,7 @@ user should have a Program Manager role.
-2. Click on _Configuration_ and then on _Default Eligibility Manager._ +2. Click on _Configuration_ and then on _Default Eligibility Manager._
@@ -26,8 +26,9 @@ user should have a Program Manager role.
-4. Use _+Add filter_ to set eligibility criteria using [Domain Filters](broken-reference). You may specify multiple eligibility criteria. +4. Use _+Add filter_ to set eligibility criteria using [Domain Filters](../../../beneficiary-management/eligibility.md#domain-filters). You may specify multiple eligibility criteria.
-5. Click the _Save_ button to save the eligibility manager and it will be listed under the eligibility manager list view page. +5. Click the _Save_ button to save the eligibility manager and it will be listed under the eligibility manager list view page. + diff --git a/guides/user-guides/create-eligibility-manager-1/create-phone-number-eligibility-manager.md b/guides/user-guides/create-eligibility-manager-1/create-phone-number-eligibility-manager.md deleted file mode 100644 index 6bbfde4a..00000000 --- a/guides/user-guides/create-eligibility-manager-1/create-phone-number-eligibility-manager.md +++ /dev/null @@ -1,31 +0,0 @@ -# Create Phone Number Eligibility Manager - -## Description - -This guide provides the steps to create an phone number eligibility manager - -## Pre-requisites - -user should have a Program Manager role. - -## Steps - -1. Navigate to _Programs_ using the menu bar. - -
- -2. Click on _Configuration_ and then on _ID document Eligibility Manager._ - -
- -3. Click _Create_ a button on the phone number eligibility manager list view page. - -
- -4. Provide the name for the eligibility manager and select the program name from the drop-down for which the eligibility manager is created. - -
- -5. Click the _Save_ button to save the eligibility manager and it will be listed under the eligibility manager list view page. - -
diff --git a/guides/user-guides/create-mts-connector/README.md b/guides/user-guides/create-mts-connector/README.md index 8efc181e..dfc9ec10 100644 --- a/guides/user-guides/create-mts-connector/README.md +++ b/guides/user-guides/create-mts-connector/README.md @@ -12,3 +12,4 @@ There are two types of MTS Connectors differentiated based on input types ## Pre-requisites The user must have a Program Manager role. See [Create User and Assign Role](../assign-roles-to-users.md) guide. + diff --git a/guides/user-guides/create-mts-connector/create-odk-mts-connector.md b/guides/user-guides/create-mts-connector/create-odk-mts-connector.md index da4f08c8..725a5acb 100644 --- a/guides/user-guides/create-mts-connector/create-odk-mts-connector.md +++ b/guides/user-guides/create-mts-connector/create-odk-mts-connector.md @@ -2,7 +2,7 @@ ## Description -This Guide will help to create the [ODK MTS Connector](broken-reference). +This Guide will help to create the [ODK MTS Connector](../../../integrations/integration-with-mosip/mts-connector.md). ## Pre-requisites @@ -19,9 +19,9 @@ This Guide will help to create the [ODK MTS Connector](broken-reference).
-3. Set _MTS Input Type_ as _ODK_ and for other fields configuration please go through [ODK MTS Connector Configuration](broken-reference). +3. Set _MTS Input Type_ as _ODK_ and for other fields configuration please go through [ODK MTS Connector Configuration](../../../integrations/integration-with-mosip/mts-connector.md).
-4. Click the _Save_ button and the connector will be listed under the MTS Connectors list view page. +4. Click the _Save_ button and the connector will be listed under the MTS Connectors list view page. 5. Click on _Start_ in the MTS Collectors list view page to start the created connector. diff --git a/guides/user-guides/create-mts-connector/create-openg2p-registry-mts-connector.md b/guides/user-guides/create-mts-connector/create-openg2p-registry-mts-connector.md index 0a718411..46317252 100644 --- a/guides/user-guides/create-mts-connector/create-openg2p-registry-mts-connector.md +++ b/guides/user-guides/create-mts-connector/create-openg2p-registry-mts-connector.md @@ -2,9 +2,9 @@ ## Description -This Guide will help to create the [OpenG2P registry MTS Connector](broken-reference). +This Guide will help to create the [OpenG2P registry MTS Connector](../../../integrations/integration-with-mosip/registry-mts-connector.md). -## Pre-requisites +## Pre-requisites The user must have a Program Manager role. @@ -18,9 +18,9 @@ The user must have a Program Manager role.
-3. Set _MTS Input Type_ as _OpenG2P Registry_ and for other fields configuration please go through [Registry MTS Connector](broken-reference). +3. Set _MTS Input Type_ as _OpenG2P Registry_ and for other fields configuration please go through [Registry MTS Connector](../../../integrations/integration-with-mosip/registry-mts-connector.md).
4. Click on the _Start_ button under the MTS Connectors list view page to start the created connector. -5. Click the _Save_ button and the connector will be listed under the MTS Connectors list view page. +5. Click the _Save_ button and the connector will be listed under the MTS Connectors list view page. diff --git a/guides/user-guides/create-notification-manager-types/README.md b/guides/user-guides/create-notification-manager-types/README.md index 9a6a5628..dcf84253 100644 --- a/guides/user-guides/create-notification-manager-types/README.md +++ b/guides/user-guides/create-notification-manager-types/README.md @@ -7,3 +7,6 @@ There are 3 types of notification managers available that can be created and the 1. SMS Notification Manager 2. Email Notification Manager 3. Fast2SMS Notification Manager + + + diff --git a/guides/user-guides/create-odk-form.md b/guides/user-guides/create-odk-form.md index 27b4f5b8..83d2a678 100644 --- a/guides/user-guides/create-odk-form.md +++ b/guides/user-guides/create-odk-form.md @@ -11,12 +11,12 @@ This guide provides steps to create a new ODK form for a program. ## Steps -1. Login to ODK Central. +1. Login to ODK Central. 2. Click on the +_New_ button to create a new project
-2. Provide the project name same as the program name for which creating the form. +2. Provide the project name same as the program name for which creating the form.
diff --git a/guides/user-guides/create-payment-manager-types/create-default-payment-manager.md b/guides/user-guides/create-payment-manager-types/create-default-payment-manager.md index f850517b..ac7bed3d 100644 --- a/guides/user-guides/create-payment-manager-types/create-default-payment-manager.md +++ b/guides/user-guides/create-payment-manager-types/create-default-payment-manager.md @@ -14,7 +14,7 @@ The user should have a Program Manager role.
-2. Click on Configuration and then on Payment Interoperability Layer Payment Manager. +2. Click on Configuration and then on Payment Interoperability Layer Payment Manager.
@@ -29,3 +29,4 @@ The user should have a Program Manager role. 5. Once the payment manager is saved it will be listed under the payment manager list view page which further can be used under the program configuration for which it was created.
+ diff --git a/guides/user-guides/create-payment-manager-types/create-payment-hub-ee-payment-manager.md b/guides/user-guides/create-payment-manager-types/create-payment-hub-ee-payment-manager.md index 42f81714..205df472 100644 --- a/guides/user-guides/create-payment-manager-types/create-payment-hub-ee-payment-manager.md +++ b/guides/user-guides/create-payment-manager-types/create-payment-hub-ee-payment-manager.md @@ -14,7 +14,7 @@ The user should have a Program Manager role.
-2. Click on Configuration and then on Payment Hub EE Payment Manager. +2. Click on Configuration and then on Payment Hub EE Payment Manager.
diff --git a/guides/user-guides/create-payment-manager.md b/guides/user-guides/create-payment-manager.md index 89e7d601..ad095a1f 100644 --- a/guides/user-guides/create-payment-manager.md +++ b/guides/user-guides/create-payment-manager.md @@ -1,4 +1,4 @@ -# Configure Payment Manager in Program +# Configure Entitlement Manager in Program ## Description diff --git a/guides/user-guides/download-form-on-odk-collect.md b/guides/user-guides/download-form-on-odk-collect.md index 146fffaf..c58027a9 100644 --- a/guides/user-guides/download-form-on-odk-collect.md +++ b/guides/user-guides/download-form-on-odk-collect.md @@ -32,3 +32,4 @@ This guide will help to download the program form on ODK Collect Application run
+ diff --git a/guides/user-guides/install-wireguard-app-and-activate-tunnel.md b/guides/user-guides/install-wireguard-app-and-activate-tunnel.md index b6d79f90..6ca5c28c 100644 --- a/guides/user-guides/install-wireguard-app-and-activate-tunnel.md +++ b/guides/user-guides/install-wireguard-app-and-activate-tunnel.md @@ -2,30 +2,37 @@ ## Description -The guide here provides steps to install WireGuard App and activate the tunnel. This app allows users to create an encrypted VPN for secure communication. +The guide here provides steps to install WireGuard app on Android device and to activate the tunnel. This app allows users to create an encrypted VPN for secure communication. ## Pre-requisites -The user must possess an Android Phone. The user should reach out to the system administrator to generate the Wireguard conf file before proceeding with the installation. +The pre-requisites to install WireGuard on Android device are: -## Steps +1. A user must have an Android Phone. +2. Before proceeding with the installation, obtain the WireGuard conf file from a System Administrator. -1. Search for "wireguard" in the Android Play Store. +## Procedure -
+The steps to install WireGuard in an Android device are: -2. Install the WireGuard app, open it, and click on the + icon to add the tunnel. +1. In the Android play store, search for "wireguard" and then tap **Install**. +2. After the successful installation, tap **Open** -
+

WireGuard application

-3. A list of options will appear from the bottom of the app. Click the _Import from file or archive_ option. +2. Tap the + icon to add the tunnel. + +

WireGuard application - Add tunnel

+ +3. A list of options appear at the bottom of the app. Tap the _Import from file or archive_ option.
-4. Select the WireGuard conf file provided by the system administrator. On successful tunnel creation, the tunnel name will appear at the top of the app. +4. Tap the WireGuard conf file provided by the system administrator. +5. On successful tunnel creation, the tunnel name will appear at the top of the app.
-5. Activate the tunnel in WireGuard. +5. Tap to activate the tunnel in WireGuard.
diff --git a/guides/user-guides/install-wireguard-client-on-desktop-laptop.md b/guides/user-guides/install-wireguard-client-on-desktop-laptop.md index 53ce46b4..0f3a50d4 100644 --- a/guides/user-guides/install-wireguard-client-on-desktop-laptop.md +++ b/guides/user-guides/install-wireguard-client-on-desktop-laptop.md @@ -1,13 +1,18 @@ -# Install WireGuard Client on Desktop/Laptop +# Installation Guide ## Description -The guide here provides steps to install the WireGuard client on your Windows laptop/desktop. +This document provides instructions to install the WireGuard on your Windows laptop/desktop device and android device. WireGuard is a communication protocol for setting up secure VPN. It allows users to create an encrypted VPN for secure communication. All OpenG2P environment are securely accessed via WireGuard. ## Pre-requisites -WireGuard conf file obtained from your System Administrator. +The pre-requisites to install WireGuard are: -## Steps +* Any browser to download and install WireGuard +* WireGuard conf file obtained from your System Administrator -Follow the steps given [here](https://github.com/mosip/documentation/blob/1.2.0/docs/wireguard-client-installation-guide.md). +## Procedure + +[Click here](https://github.com/mosip/documentation/blob/1.2.0/docs/wireguard-client-installation-guide.md) for the instructions to install WireGuard Client on Desktop/Laptop device + +[Click here](install-wireguard-app-and-activate-tunnel.md) for the instructions to install WireGuard Client on Android device diff --git a/guides/user-guides/integrate-mosip-e-signet.md b/guides/user-guides/integrate-mosip-e-signet.md index 7d729380..f48bb99a 100644 --- a/guides/user-guides/integrate-mosip-e-signet.md +++ b/guides/user-guides/integrate-mosip-e-signet.md @@ -2,7 +2,7 @@ ## Description -This guide provides steps to integrate [OpenG2P with e-Signet with MOSIP](broken-reference) as the authentication provider. +This guide provides steps to integrate [OpenG2P with e-Signet with MOSIP](../../integrations/integration-with-mosip/integration-with-e-signet.md) as the authentication provider. ## Pre-requisites diff --git a/guides/user-guides/map-self-service-portal-form.md b/guides/user-guides/map-self-service-portal-form.md index 9528f894..086f1992 100644 --- a/guides/user-guides/map-self-service-portal-form.md +++ b/guides/user-guides/map-self-service-portal-form.md @@ -6,7 +6,7 @@ This guide provides steps to map the portal form for an existing program. This f ## Pre-requisites -The user must have a _Program Manager_ role and the program has been created using the steps from the [Create Program](create-a-program.md) guide. +The user must have a _Program Manager_ role and the program has been created using the steps from the [Create Program](create-a-program.md) guide. ## Steps @@ -22,7 +22,7 @@ The user must have a _Program Manager_ role and the program has been created usi
-4. Select the desired form and check the box _Is Portal Form._ +4. Select the desired form and check the box _Is Portal Form._
@@ -38,7 +38,7 @@ The user must have a _Program Manager_ role and the program has been created usi
-8. In the selected program view, select _Map Portal Form_ tab\_.\_ +8. In the selected program view, select _Map Portal Form_ tab_._
diff --git a/guides/user-guides/multi-stage-approval.md b/guides/user-guides/multi-stage-approval.md index 3dbfb18b..0547f7e6 100644 --- a/guides/user-guides/multi-stage-approval.md +++ b/guides/user-guides/multi-stage-approval.md @@ -6,7 +6,7 @@ This guide provides steps for multiple stages of approving a beneficiary's entit ## Pre-requisites -The user is a Program Administrator and has configured multiple stages of entitlement and assigned an entitlement manager for each stage. Learn more about creating multiple stages of entitlement [here](https://github.com/OpenG2P/openg2p-documentation/blob/1.2/guides/user-guides/broken-reference/README.md). +The user is a Program Administrator and has configured multiple stages of entitlement and assigned an entitlement manager for each stage. Learn more about creating multiple stages of entitlement [here](broken-reference/). ## Steps @@ -66,7 +66,7 @@ Note: Only the entitlement manager for the first stage can verify eligibility, e
-12. All the steps above have to be repeated by each entitlement manager configured in the _Approval Settings_ in the _Entitlement Manager_. To learn more about _Approval Settings_, refer to the [Multi-Stage Configuration](https://github.com/OpenG2P/openg2p-documentation/blob/1.2/guides/user-guides/broken-reference/README.md) guide. +12. All the steps above have to be repeated by each entitlement manager configured in the _Approval Settings_ in the _Entitlement Manager_. To learn more about _Approval Settings_, refer to the [Multi-Stage Configuration](broken-reference/) guide. Note: The status of entitlement is set according to the approval stage. diff --git a/guides/user-guides/register-offline.md b/guides/user-guides/register-offline.md index 683c8f32..901181fa 100644 --- a/guides/user-guides/register-offline.md +++ b/guides/user-guides/register-offline.md @@ -2,7 +2,7 @@ ## Description -This guide will provide the steps to register beneficiaries through an offline process. [offline registration](broken-reference) is done by the Field Agent. +This guide will provide the steps to register beneficiaries through an offline process. [offline registration](../../secure-registry/registration-methods/offline-registration.md) is done by the Field Agent. ## Pre-requisites @@ -35,3 +35,6 @@ This guide will provide the steps to register beneficiaries through an offline p * If the Field Agent is online, the submitted entries will be sent to ODK Central and will be listed under _View Sent Form_ or else they will be saved in the Field Agents device in _Send Finalized Form Section._
+ + +