E1867 allow reviewer to say review can be shown to class as an example

From Expertiza_Wiki
Jump to navigation Jump to search

Problem Statement

The objective of this project is to:

  1. Add a feature for students to make their reviews 'public', that is, allow other students to view them.
  2. Add a feature for TA to select a subset of 'public' reviews, and make those reviews visible as sample reviews of the particular assignment.
  3. Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of his/her assignments in the course.
  4. Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.
  5. Allow the student to toggle the visibility of a review he/she has submitted.

Approach

  1. Consent to make the review public - add a checkbox and an oncheck event handlers (JS) that sets a new field 'visibility' to public of Response object.
  2. Change the schema of Responses table (add the new column) and write db migrations.
  3. Create new table, model, view, controller for similar_assignments and validate CRUD operations that access the table.
  4. Add HTML (checkbox) to uncheck the consent such that the reviews becomes private again.
  5. On the "popup/team_users_popup" page (where instructor/TA can view all reviews), we give a checkbox against every review with public visibility to allow instructors/TAs to select one or more reviews as sample reviews to be available for students.
  6. Once the instructor selects and submits some reviews as sample reviews, we give a popup containing a list of assignments with a checkbox against each of them and a submit button at the end to allow instructors to make sample reviews available for multiple assignments in one go. We perform validation checks also.
  7. On submit of the popup, we update the similar_assignments table.
  8. At the top of student_reviews/list page, we give an option for the student to preview all the available sample reviews.
  9. Create the MVC setup for this new page to list all the sample reviews. Students will be able to click on one particular review and preview it.

Implementation Details

UML - Use Case Diagram



Other details will be updated after the implementation

Test Plan

To be updated

Additional Links and References

  1. Link to the Git Pull Request
  2. Expertiza on GitHub
  3. GitHub Project Repository Fork
  4. The Live Expertiza Website

Team

Amogh Agnihotri Subbanna
Chinmai Kaidabettu Srinivas
Siddu Madhure Jayanna
Suhas Naramballi Gururaja