Exercise

exercises/DOCUMENTATION-workshop.md

@@ -1,42 +1,28 @@
-# documenatation workshop 
+# Documentation Workshop 
 
-### Overview
-this is a trial workshop sesion to assist us in underStanding the guidilines for writting mosip-related document.
+## Overview
+This is a trial workshop session to assist us in understanding the guidelines for writing MOSIP related documents.
 
-## types of documents
+### Types of documents
 
-### Type1
+### Type 1
 
-_the paragraph below in describes admin Portal_
+Admin portal will be used by administrative users for the following purposes:
 
-Using the admin portal, the administrator can now retrieve an INDIVIDUAL's lost rid or misplaced rid. Using the admin portal, the *admin* can now controll the levels of location hierarchy they required while creating the registration centres. The level of the hierarchy can be configured through configuration property value.
-Using the admin portal, the administrator can now map the users to a registration centre and to a zone
-Using the Admin portal, the administrator can now create and update dynamic fields such as Gender, Blood Type, Residence Status, Marital STATUS etc.Using the admin portal, the administrator can now configure the number of kiosks in a particular reg centre during the process of creating the registration centre.
+* Retrieve a resident's lost RID or misplaced rid. 
 
-### Type 2 
-
-Setting up Registration client
+* Map users to an administrative zone and registration centre.
 
-Step1. Download TPM utility and run the to get machine keys
-Please find the instructions to check out, build and run the utility here
+* Create and update dynamic fields such as Gender, Blood Type, Residence Status, Marital Status etc.
 
-Step-2. Whitelist the machine keys in server db
-Machine name and keys output from utility should be updated in server.
+* Configure the number of kiosks in a particular registration centre during the process of creating the registration centre.
 
-use the below api to create / whitelist your machine
-curl -X POST "https://<HOSTNAME>/v1/masterdata/machine
+### Type 2 
 
-NOTE : 
--> Replace appropriate HOSTNAME in the above curl command
--> In case, we are trying to whitelist NON-TPM machine, Please set publicKey and signPublicKey with same value 
+Setting up Registration client
 
-step3: Know your userId and required roles
-  Create the user in the keycloak.
+1. Download TPM utility and run it to get machine keys. Please find the instructions to check out, build and run the utility here
 
-Map the user to same center as that of the machine that is created/whitelisted in Step-2.
+2. Whitelist the machine keys in server db
+Machine name and keys output from utility should be updated in server.
 
-Either one of these roles must be assigned to the user in keycloak - "REGISTRATION_Supervisor, "Reg_OFFICER"
-
-Step-4. Download registration client and start reg-client
-Registration client package can be downloaded from below URL, if env is setup with mosip standard deployment.
-

exercises/rakhi.md

@@ -0,0 +1,27 @@
+# Documentation Workshop 
+
+## Overview
+This is a trial workshop session to assist us in understanding the guidelines for writing MOSIP related documents.
+
+### Types of documents
+
+### Type 1
+
+Admin portal will be used by administrative users for the following purposes:
+
+* Retrieve a resident's lost RID or misplaced rid. 
+
+* Map users to an administrative zone and registration centre.
+
+* Create and update dynamic fields such as Gender, Blood Type, Residence Status, Marital Status etc.
+
+* Configure the number of kiosks in a particular registration centre during the process of creating the registration centre.
+
+### Type 2 
+
+Setting up Registration client
+
+1. Download TPM utility and run it to get machine keys. Please find the instructions to check out, build and run the utility here
+
+2. Whitelist the machine keys in server db
+Machine name and keys output from utility should be updated in server.