CSC/ECE 517 Fall 2019 - E1939. OSS Project Juniper: Bookmark enhancements: Difference between revisions

From Expertiza_Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 12: Line 12:
== Expertiza ==
== Expertiza ==


Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and it’s code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.  
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required


===== Bookmark Functionality  in Expertiza =====


== Project Juniper Bookmark Enhancements ==
Expertiza features the bookmarking functionality which allows users to help the author of the project by suggesting insights. Let’s say there are five topics that I’m interested in and would like to contribute to, but I can only choose one.  Well, for the other topics, I’m allowed to submit hyperlinks to pages that I think would help the author do the work.  On each line of the signup sheet are two icons, one for adding a bookmark to the topic, and another for viewing bookmarks on the topic. The bookmarks are attached to each project topic and user can suggest by filling up a questionnaire. As soon as a user creates a bookmark, the project author is able to view all the bookmarks that are created for his project. The author can give a feedback on the bookmark that he has received which helps even the user know the usefuless of his bookmark.  
The Bookmark functionality in expertiza is in its nascent stage which allows the author to rate the bookmarks that he has received for his project. This project is an attempt to make the bookmarks more user-friendly and credible.This project further tries to improve the functionality where author can descriptively evaluate the bookmark using the set of rubrics.


== Bookmark Functionality ==
Expertiza features the bookmarking functionality which allows users to help the author of the project by suggesting insights. The bookmarks are attached to each project topic and user can suggest by filling up a questionnaire. As soon as a user creates a bookmark, the project author is able to view all the bookmarks that are created for his project. The author can give a feedback on the bookmark that he has received which helps even the user know the usefuless of his bookmark.


'''
==Project Juniper Bookmark Enhancements==
'''
The Bookmark functionality in expertiza is in its nascent stage which allows user to provide feedback on the projects that he is interested in. It also allows the author to rate the bookmarks that he has received for his project. Project Juniper Bookmark Enhancements is an attempt to make the bookmarks more user-friendly and credible. We have improved the functionality for an author to descriptively evaluate the bookmark  that he has received on his project using rubrics as set by the instructor.


Issues in the current version that were resolved
'''
• The “back” button when user visits “Create Bookmarks and viewing bookmarks were not functional which refrained the user from going back to the Signup-sheet.
== Tasks that were identified  ==
Validations on the form for adding bookmarks were missing
'''
• Average Rating calculation was wrong
*Fixing the “Back” button  
::When user visits “Create Bookmarks" and "View Bookmarks", the back button was not functional which refrained the user from going back to the Signup-sheet. Now this issue has been fixed which in future will allow to any contributor to use this back functionality.
*Validations on the form for adding bookmarks were missing
::The form for adding bookmark allowed malformed URLs to be entered into the system. Now, the bookmarks can be added only when user enters legitimate URL while creating the bookmark..
*Allowed the creator of bookmark to rate himself  and the average rating calculation was wrong
:: When multiple users rated the bookmark, the average rating for the bookmark was wrongly calculated. Now, this issue is fixed as well as the creator cannot rate his own bookmark. This would ensure genuine ratings.
 
'''Solutions:
'''
* Fixing the Back button:
::When a logged in user goes to “View Bookmark” or “Create bookmark“ page, he cannot to go back to the Sign-up sheet using “back button”.


Solutions:
1. Fixing the Back button:
When a logged in user goes to “View Bookmark” or “Create bookmark“ page, he cannot to go back to the Sign-up sheet using “back button”.
To view this :
1. Log in as an instructor and impersonate as a student (student6340 or  student6341)
2. Select ‘Exercises’ assignment and go to the Signup sheet
3. We can see a list of projects with 2 columns to add or remove the Bookmark, select any of them
4. You’ll be redirected to the corresponding page where the back button will be visible
[Video]
2. The form for adding bookmarks had no validations  
* The form for adding bookmarks had no validations  
Validations were added as a security measure to prevent misuse.
::Validations were added as a security measure to prevent misuse.


To view this:
To view this:
Line 61: Line 64:
Bugs that are still to be fixed:
Bugs that are still to be fixed:
1. When the instructor doesn’t allow the bookmarks to be created, we can still add the bookmark but cannot rate or review it.
1. When the instructor doesn’t allow the bookmarks to be created, we can still add the bookmark but cannot rate or review it.
Testing From UI:
* Fixing the back Button
#    Log in as an instructor and impersonate as a student (student6340 or  student6341)
# Select ‘Exercises’ assignment and go to the Signup sheet
# We can see a list of projects with 2 columns to add or remove the Bookmark, select any of them
# You’ll be redirected to the corresponding page where the back button will be visible




Github Link: https://github.com/srujana13/expertiza  
Github Link: https://github.com/srujana13/expertiza  
 
Pull Request: https://github.com/expertiza/expertiza/pull/1540/


Reference:  
Reference:  
http://wiki.expertiza.ncsu.edu/index.php/E1830_OSS_Project_Juniper:_Bookmark_enhancements
http://wiki.expertiza.ncsu.edu/index.php/E1830_OSS_Project_Juniper:_Bookmark_enhancements
https://github.com/expertiza/expertiza
https://github.com/expertiza/expertiza

Revision as of 22:24, 4 November 2019

Project Juniper Bookmark enhancements

Peer Review Assessment Credentials

The credentials for Peer review assessment for Bookmark Enhancement project are Instructor Login: username => instructor6 password=>password

Accounts for Impersonation: username => student6340, student6341 Assignment => Exercises, CSC456, Fall2015


Expertiza

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

Bookmark Functionality in Expertiza

Expertiza features the bookmarking functionality which allows users to help the author of the project by suggesting insights. Let’s say there are five topics that I’m interested in and would like to contribute to, but I can only choose one. Well, for the other topics, I’m allowed to submit hyperlinks to pages that I think would help the author do the work. On each line of the signup sheet are two icons, one for adding a bookmark to the topic, and another for viewing bookmarks on the topic. The bookmarks are attached to each project topic and user can suggest by filling up a questionnaire. As soon as a user creates a bookmark, the project author is able to view all the bookmarks that are created for his project. The author can give a feedback on the bookmark that he has received which helps even the user know the usefuless of his bookmark.


Project Juniper Bookmark Enhancements

The Bookmark functionality in expertiza is in its nascent stage which allows user to provide feedback on the projects that he is interested in. It also allows the author to rate the bookmarks that he has received for his project. Project Juniper Bookmark Enhancements is an attempt to make the bookmarks more user-friendly and credible. We have improved the functionality for an author to descriptively evaluate the bookmark that he has received on his project using rubrics as set by the instructor.

Tasks that were identified

  • Fixing the “Back” button
When user visits “Create Bookmarks" and "View Bookmarks", the back button was not functional which refrained the user from going back to the Signup-sheet. Now this issue has been fixed which in future will allow to any contributor to use this back functionality.
  • Validations on the form for adding bookmarks were missing
The form for adding bookmark allowed malformed URLs to be entered into the system. Now, the bookmarks can be added only when user enters legitimate URL while creating the bookmark..
  • Allowed the creator of bookmark to rate himself and the average rating calculation was wrong
When multiple users rated the bookmark, the average rating for the bookmark was wrongly calculated. Now, this issue is fixed as well as the creator cannot rate his own bookmark. This would ensure genuine ratings.

Solutions:

  • Fixing the Back button:
When a logged in user goes to “View Bookmark” or “Create bookmark“ page, he cannot to go back to the Sign-up sheet using “back button”.


  • The form for adding bookmarks had no validations
Validations were added as a security measure to prevent misuse.

To view this: 1. Do steps 1-3 as above and click on add bookmark button 2. The form will not allow malformed expressions as input

3. Average Calculation: When using the Scale method for reviewing the bookmark, the average rating for that bookmark shown was calculated wrongly and showed average rating for the bookmark that wasn’t reviewed.


New Features Added • Functionality for the author to review the bookmarks using descriptive form Now the author can rate the bookmark as well as review it with the rubric as it is set by the instructor.

To view this: 1. Log in as an instructor and in the edit assignment part, ensure that ‘Allow participants to create bookmarks?’ checkbox is checked. 2. Impersonate as user and then add bookmarks 3. The owner of that project should be able to see all the bookmarks created for his project and can rate the bookmark.


Bugs that are still to be fixed: 1. When the instructor doesn’t allow the bookmarks to be created, we can still add the bookmark but cannot rate or review it.

Testing From UI:

  • Fixing the back Button
  1. Log in as an instructor and impersonate as a student (student6340 or student6341)
  2. Select ‘Exercises’ assignment and go to the Signup sheet
  3. We can see a list of projects with 2 columns to add or remove the Bookmark, select any of them
  4. You’ll be redirected to the corresponding page where the back button will be visible


Github Link: https://github.com/srujana13/expertiza Pull Request: https://github.com/expertiza/expertiza/pull/1540/

Reference: http://wiki.expertiza.ncsu.edu/index.php/E1830_OSS_Project_Juniper:_Bookmark_enhancements https://github.com/expertiza/expertiza