update doc

Author: shawnm0705

src/features/2.metrics.md

@@ -49,6 +49,8 @@ Relationship between a metric and a data source link in an experience
 * `metric_id`
 * `data_source_id` : the related data source id
   * When `data_source` = `question`, this id is the question id
+  * When `data_source` = `assessment`, this id is the assessment id
+  * When `data_source` = `user` or `pulse-check`, this id is the experience id
 * `experience_id`
 * `institution_id`
 * `calculation_frequency` : when to calculate the metrics
@@ -66,18 +68,23 @@ The table to store the metric report records
 
 ## Metric Types
 
+Each combination of data source and data type represents a different metric calculation approach. Below is a comprehensive list of all supported data source and data type combinations:
+
 <table>
 <tr>
 <th>data_source</th>
 <th>data_type</th>
 <th>aggregation</th>
 <th>description</th>
+<th>report type</th>
 </tr>
+
 <tr>
-<td rowspan="3">question</td>
-<td rowspan="3">scalar</td>
+<td rowspan="4">question</td>
+<td rowspan="4">scalar</td>
 <td>average</td>
 <td>The average value of the weight of the question choice</td>
+<td rowspan="9">circle number,<br/>card,<br/>table</td>
 </tr>
 <tr>
 <td>sum</td>
@@ -88,16 +95,51 @@ The table to store the metric report records
 <td>Count how many users have answered this question</td>
 </tr>
 <tr>
-<td>assessment</td>
-<td>submitted</td>
-<td>count</td>
+<td>net-promoter</td>
+<td>Calculate the net promoter of the question. (only available for choice weight 1-5 or 1-10)</td>
+</tr>
+
+<tr>
+<td rowspan="2">assessment</td>
+<td>submitted-user</td>
+<td rowspan="2">count</td>
 <td>Count how many users have submitted this assessment</td>
 </tr>
 <tr>
-<td>pulse_check</td>
+<td>submitted-team</td>
+<td>Count how many teams have submitted this assessment</td>
+</tr>
+
+<tr>
+<td rowspan="5">user</td>
+<td>participant</td>
+<td rowspan="5">count</td>
+<td>The total number of learners</td>
+</tr>
+<tr>
+<td>mentor</td>
+<td>The total number of experts</td>
+</tr>
+<tr>
+<td>team</td>
+<td>The total number of teams</td>
+</tr>
+<tr>
+<td>gender</td>
+<td>The gender distribution of learners</td>
+<td rowspan="2">pie chart</td>
+</tr>
+<tr>
+<td>nationality</td>
+<td>The nationality distribution of learners</td>
+</tr>
+
+<tr>
+<td>pulse-check</td>
 <td>skills</td>
 <td>average</td>
 <td>The average skills growth of the experience</td>
+<td>bar chart</td>
 </tr>
 </table>