[#11794] Update help pages (#11829)

src/web/app/pages-help/instructor-help-page/instructor-help-getting-started/instructor-help-getting-started.component.html

@@ -26,22 +26,22 @@ <h2 id="course-setup">1. Set up a course</h2>
  <ol>
  <li>
  <b>Create a course</b><br>
- From the <b>Home</b> page, click <button class="btn btn-primary btn-sm">Add New Course</button>.<br>
+ From the <b>Home</b> page, click <button class="btn btn-success btn-sm"><i class="fas fa-plus"></i> Add New Course</button>.<br>
  Fill out the following form. Hover your mouse over text to reveal tooltips which tell you what the element does.
  <tm-example-box>
  <tm-add-course-form [isEnabled]="false"></tm-add-course-form>
  </tm-example-box>
  </li>
  <li>
  <b><a [tmRouterLink]="instructorHelpPath" [queryParams]="{questionId: CoursesSectionQuestions.COURSE_ADD_STUDENTS, section: Sections.courses}">Enroll students in the course</a></b><br>
- Go to the <b>Courses</b> page and click the <button class="btn btn-secondary btn-sm">Enroll</button> button of the corresponding course.<br>
+ Go to the <b>Courses</b> page and click the <button class="btn btn-light btn-sm">Enroll</button> button of the corresponding course.<br>
  Students can be enrolled into teams (e.g., project groups) and sections (e.g., tutorial classes, lecture groups) to facilitate giving feedback in and among these smaller groups.<br>
  TEAMMATES will <b>not</b> automatically notify students that they have been enrolled, as there is nothing for students to do in TEAMMATES until a session opens for submissions.<br>
  TEAMMATES will send an email with access instructions to students only when there is an action for them to perform e.g., when a session opens for submissions.
  </li>
  <li>
  <b><a [tmRouterLink]="instructorHelpPath" [queryParams]="{questionId: CoursesSectionQuestions.COURSE_ADD_INSTRUCTOR, section: Sections.courses}">Add instructors to the course</a></b><br>
- From the <b>Courses</b> page, click the <button class="btn btn-secondary btn-sm" type="button">Edit</button> button of the course you would like to add instructors to. You will be directed to the <b>Edit Course</b> page where you can add a new instructor to your course.
+ From the <b>Courses</b> page, click the <button class="btn btn-light btn-sm dropdown-toggle">Other Actions</button> button of the course you would like to add instructors to, and select <b>Edit</b> in the drop-down menu. You will be directed to the <b>Edit Course</b> page where you can add a new instructor to your course.
  You can specify the <a [tmRouterLink]="instructorHelpPath" [queryParams]="{questionId: CoursesSectionQuestions.COURSE_INSTRUCTOR_ACCESS, section: Sections.courses}">access level</a> of any instructor you add to a course. For more information about how to add an instructor to your course, click <a [tmRouterLink]="instructorHelpPath" [queryParams]="{questionId: CoursesSectionQuestions.COURSE_ADD_INSTRUCTOR, section: Sections.courses}">here</a>.
  </li>
  </ol>
@@ -125,7 +125,7 @@ <h2 id="session-invites">3. Wait for your session to open</h2>
  </li>
  </ul>
  <p>
- You can manually send reminders to students at any time while a session is open. Click the <button class="btn btn-sm btn-secondary">Remind</button> button of the session from the <b>Home</b> or <b>Sessions</b> page.<br>
+ You can manually send reminders to students at any time while a session is open. Use the <button class="btn btn-light btn-sm dropdown-toggle">Remind</button> button of the session from the <b>Home</b> or <b>Sessions</b> page.<br>
  In addition, you are welcome to (but not required to) use your own email announcements (outside of TEAMMATES) to inform students to look out for these TEAMMATES emails.
  </p>
  <p>
@@ -135,18 +135,18 @@ <h2 id="session-invites">3. Wait for your session to open</h2>
  Click <a [tmRouterLink]="instructorHelpPath" [queryParams]="{questionId: SessionsSectionQuestions.EXTEND_SESSION_DEADLINE, section: Sections.sessions}">here</a> to find how to extend the deadline for all students, or for specific students.
  </p>
  <p>
- While not normally needed, if you would like students to access TEAMMATES sooner (e.g., if you would like them to fill in their profile page in advance), you can get them to ‘join’ the course earlier by following these steps:
+ While not normally needed, if you would like students to access TEAMMATES sooner (e.g., if you would like them to fill in their profile page in advance), you can get them to 'join' the course earlier by following these steps:
  </p>
  <ol>
  <li>
  In the <b>Courses</b> page, click the <button class="btn btn-light btn-sm dropdown-toggle">Other Actions</button> button of the course, and select <b>View</b> in the drop-down menu.
  </li>
  <li>
- Then, click the <button class="btn btn-sm btn-primary"><i class="fa fa-envelope"></i> Remind Students to Join</button> button, which will send them instructions to ‘join’ TEAMMATES immediately.
+ Then, click the <button class="btn btn-sm btn-primary"><i class="fa fa-envelope"></i> Remind Students to Join</button> button, which will send them instructions to 'join' TEAMMATES immediately.
  </li>
  </ol>
  <p>
- Caution: ‘joining’ TEAMMATES requires students to use a Google account to authenticate themselves.
+ Caution: 'joining' TEAMMATES requires students to use a Google account to authenticate themselves.
  Joining a TEAMMATES course is optional for students; they can still submit responses and view session results without joining, by using access links TEAMMATES sends them.
  However, some non-essential features such as creating a profile page are only available to students who have joined.
  </p>
@@ -164,30 +164,31 @@ <h2 id="session-results">4. View and publish session results</h2>
  </p>
  <ul>
  <li>
- <a [tmRouterLink]="instructorHelpPath" [queryParams]="{questionId: SessionsSectionQuestions.SESSION_VIEW_RESULTS, section: Sections.sessions}">View responses</a>: see what respondents have answered, even if the session is still ongoing. Go to the <b>Sessions</b> page and click the corresponding <button class="btn btn-secondary btn-sm">Results</button> button.
+ <a [tmRouterLink]="instructorHelpPath" [queryParams]="{questionId: SessionsSectionQuestions.SESSION_VIEW_RESULTS, section: Sections.sessions}">View responses</a>: see what respondents have answered, even if the session is still ongoing. Go to the <b>Sessions</b> page and click the corresponding <button class="btn btn-light btn-sm dropdown-toggle">Results</button> button.
  </li>
  <li>
- Moderate responses: edit inappropriate responses from respondents before publishing the responses.
+ <a [tmRouterLink]="instructorHelpPath" [queryParams]="{questionId: SessionsSectionQuestions.MODERATE_RESPONSE, section: Sections.sessions}">Moderate responses</a>: edit inappropriate responses from respondents before publishing the responses.
  </li>
  <li>
  <a [tmRouterLink]="instructorHelpPath" [queryParams]="{questionId: SessionsSectionQuestions.SESSION_ADD_COMMENTS, section: Sections.sessions}">Add comments to responses</a>: reply to respondents' answers, or add your own notes on a response. You can make your comment visible to other instructors, the response giver, and/or the response giver's team.
  </li>
  <li>
- Remind students to submit responses: TEAMMATES automatically sends reminders to students; however, you can also manually send reminder emails to students at any time while a session is open. Click the <button class="btn btn-sm btn-secondary">Remind</button> button of the session from the <b>Home</b> or <b>Sessions</b> page.
+ Remind students to submit responses: TEAMMATES automatically sends reminders to students; however, you can also manually send reminder emails to students at any time while a session is open. Use the <button class="btn btn-light btn-sm dropdown-toggle">Remind</button> button of the session from the <b>Home</b> or <b>Sessions</b> page.
  </li>
  <li>
  <a [tmRouterLink]="instructorHelpPath" [queryParams]="{questionId: SessionsSectionQuestions.SUBMIT_FOR_STUDENT, section: Sections.sessions}">Submit responses for students</a>: if a student has missed the closing time of the session, or is unable to submit the evaluation due to technical problems, you can submit the student's responses on his/her behalf.
  </li>
  </ul>
+ <br>
  <p>
  After a session closes, you may:
  </p>
  <ul>
  <li>
- Publish results: make a session's results visible to students. Click the <button class="btn btn-sm btn-secondary dropdown-toggle">Results</button> dropdown on the <b>Sessions</b> page, then select <b>Publish Results</b>. Students will not be able to view the session's results until you publish them.
+ Publish results: make a session's results visible to students. Click the corresponding <button class="btn btn-light btn-sm dropdown-toggle">Results</button> button on the <b>Sessions</b> page, then select <b>Publish Results</b>. Students will not be able to view the session's results until you publish them.
  </li>
  <li>
- Download results of a session in spreadsheet format: first view the results of a session, then click <button class="btn btn-sm btn-primary">Download Results</button> to download the results of a session as a CSV file.
+ Download results of a session in spreadsheet format: first view the course-wide results of a session, then click <button class="btn btn-sm btn-primary"><i class="fas fa-file-download"></i> Download Results</button> to download the results of a session as a CSV file.
  </li>
  </ul>
  </div>

src/web/app/pages-help/instructor-help-page/instructor-help-questions-section/instructor-help-questions-section.component.html

@@ -272,7 +272,7 @@ <h4 *ngIf="displaySubsection(0, 10)">Setting Up Questions</h4>
  </tm-example-box>
  <p>
  Contribution questions in TEAMMATES are unique because they are targeted at measuring team contributions. <br>
- Thus, TEAMMATES purposefully prevents students from influencing their own ‘perceived contribution’ value.
+ Thus, TEAMMATES purposefully prevents students from influencing their own 'perceived contribution' value.
  </p>
  <p>
  Perceived contribution is calculated based on what a student's other team members perceive as his/her contribution.
@@ -397,14 +397,14 @@ <h4 *ngIf="displaySubsection(0, 10)">Setting Up Questions</h4>
  <strong>Denormalize <code>normalizedAveragePerceived</code></strong>
  <div>
  For each student, denormalize <code>normalizedAveragePerceived</code>. We scale back to match the total of original
- input by student. That way, student can compare his input (i.e., his opinion of the team’s work distribution)
- with the team’s opinion. In the example used above, we should use 330/300 as the denormalizing factor for that student.
+ input by student. That way, student can compare his input (i.e., his opinion of the team's work distribution)
+ with the team's opinion. In the example used above, we should use 330/300 as the denormalizing factor for that student.
  The result could be something like this:
  <br>
  <br>
  <div class="bs-example">
- student’s opinion: <code>90</code> [self], <code>110</code>, <code>130</code>, <code>N/A</code> (total = <code>330</code>)
- <br>team’s opinion : <code>95</code>, <code>105</code>, <code>125</code>, <code>115</code> (total = <code>440</code>)
+ student's opinion: <code>90</code> [self], <code>110</code>, <code>130</code>, <code>N/A</code> (total = <code>330</code>)
+ <br>team's opinion : <code>95</code>, <code>105</code>, <code>125</code>, <code>115</code> (total = <code>440</code>)
  </div>
  Value transformation steps: input (i.e. claimed) → <code>normalizedClaimed</code> →
  <code>peerContributionRatio</code> → <code>averagePerceived</code> →
@@ -453,7 +453,7 @@ <h4 *ngIf="displaySubsection(0, 10)">Setting Up Questions</h4>
  </p>
  <ul>
  <li>
- <b>E (Equal share)</b>: a relative measure of work done. e.g. For a 3-person team, an ‘Equal share’ means ‘a third of the total work done’.
+ <b>E (Equal share)</b>: a relative measure of work done. e.g. For a 3-person team, an 'Equal share' means 'a third of the total work done'.
  </li>
  <li>
  <b >CC (Claimed Contribution)</b>: This is what the student claimed he contributed.
@@ -462,22 +462,22 @@ <h4 *ngIf="displaySubsection(0, 10)">Setting Up Questions</h4>
  <b>Ratings Received </b>: These are the peer opinions as to how much the student contributed. These values have been adjusted to neutralize any attempts by students to boost their own standing by rating others low.
  </li>
  <li>
- <b>PC (Perceived Contribution)</b>: This is the average value of the ‘Ratings Received’. This can be considered as the
- <i>team’s perception of how much the student contributed</i>.
+ <b>PC (Perceived Contribution)</b>: This is the average value of the 'Ratings Received'. This can be considered as the
+ <i>team's perception of how much the student contributed</i>.
  </li>
  <li>
  <b>Diff</b>: The difference between the claimed contribution (CC) and the perceived contribution (PC). This value can be used to identify those who have over/under-estimated their own contribution.
  </li>
  </ul>
  <p>
  The ratings in a contribution question can be used to identify relative contribution levels of students in a team.
- If you use these values for grading, also refer the ‘Interpret contribution numbers with care’ caveat in the
+ If you use these values for grading, also refer the 'Interpret contribution numbers with care' caveat in the
  <button class="btn btn-link" (click)="collapsePeerEvalTips.emit()">tips for conducting 'team peer evaluation' sessions</button> section.
  </p>
  <p>
- The actual contribution values entered by the student may appear different from the values shown in the results because the system ‘normalizes’ those values so that there is no artificial inflation of contribution.
- For example, if a student says everyone contributed ‘Equal share + 10%’, the system automatically normalizes it to ‘Equal share’ because in reality that is what the student means.
- ‘Normalize’ here means scale up/down the values so that the <code>(sum of contributions) = ( n x Equal Share)</code> where <code>n</code> is the number of students being reviewed.
+ The actual contribution values entered by the student may appear different from the values shown in the results because the system 'normalizes' those values so that there is no artificial inflation of contribution.
+ For example, if a student says everyone contributed 'Equal share + 10%', the system automatically normalizes it to 'Equal share' because in reality that is what the student means.
+ 'Normalize' here means scale up/down the values so that the <code>(sum of contributions) = ( n x Equal Share)</code> where <code>n</code> is the number of students being reviewed.
  </p>
  <tm-example-box *ngIf="questionsToCollapsed[QuestionsSectionQuestions.CONTRIBUTION]" @collapseAnim>
  <tm-instructor-session-result-question-view