vlead / feedback-portal

This is the portal, where all kinds of feedback related to a lab or an experiment is filled in.

Feedback Portal

Pre-requisites to build the sources on Ubunut12.04

Install emacs v24.5

sudo apt-get install checkinstall
mkdir -p ~/src
cd ~/src
wget http://ftp.gnu.org/gnu/emacs/emacs-24.5.tar.gz
tar xf emacs-24.5.tar.gz
cd emacs-24.5
./configure
make
sudo checkinstall

• Above commands are well tested on Ubuntu12.04 X64 bit
• For More documentation visit http://wiki.vlead.vlabs.ac.in/index.php/How_to_setup_emacs_and_org_8

Install org v8.3.6

mkdir -p ~/emacs/lisp
cd ~/emacs/lisp
wget http://orgmode.org/org-8.3.6.tar.gz
tar zxvf org-8.3.6.tar.gz
ln -s org-8.3.6 org-8.2.10

Setup developement environment for feedback app to run

• Clone the repository

git clone https://github.com/vlead/feedback-portal.git
cd feedback-portal
make

• Build the sources

cd feedback-portal
make

• Follow the Documentation to setup developement environment.

feedback-portal's Issues

Feedback from integration team

This issue captures all the feedback given by integration team.

1. Position of radio button and numbers is cluttered..some additional spacing may be given.. How do I know what falls into "Not at all" or "To some extent", etc categories.

2. Message box should have "information/warning/stop" indicator to state the objective.. Usability !!

3. Why do we need to go to another page on submitting... why can't it be a message box stating (better usability) "Thank you for the feedback".. If you plan to continue to have a page, have a hyperlink on "close" option

Feedback forms are not accessible with low bandwidth

From the observation at workshop conducted in GMRIT college. All feedback forms are not accessible with the bandwidth (20kbps). Whereas it is working for above this bandwidth.

To debug this we should test all feedback forms with debug mode.

Integration of feedback service with elastic search database

Feedback service has the APIs for kibana to use here is the API link https://github.com/vlead/feedback-portal/blob/master/src/design/index.org

Design of Feedaback service

Feedback service design need to be captured

Dashboard for Feedback just like Kibana dashboard for Open edX analytics

Implementation code has to be modularized

Implementation code has to be modularized. Need to reuse the code wherever the same code is repeated.

Feedback Data Migration from version v1.0.0 to v2.0.0

All the feedback data of v1.0.0 is part of Data Service data. This feedback data needs to be migrated to version v2.0.0 which is running as a separate feedback service.

Feedback portal's mysql server is stopped

Showing following error on browser console when submit a feedback

{readyState: 4, responseText: "{"error":"error: (oursql.InterfaceError) (2002, "…t '/var/run/mysqld/mysqld.sock' (111)", None)"}↵", responseJSON: Object, status: 500, statusText: "Internal Server Error"}

Rating descriptors need to be displayed with options

Rating descriptors (not at all, To some extent, Very well from 0 to 10) need to be displayed on page. check this for clarifications

Implementation of System Operations

System holds all the operations which are invoked by the System interface. System checks all the State, Authorization, Arity and Type checks and then performs the action.

Answers with rating responses need to store relatively

Answers with rating responses need to store relatively.

Example:

1. How did you rate this lab?
   a) 1 b) 2 c)3 d) 4 e) 5 f) 6 g) 7 h)8 i)9 j) 10

If the option is 'g'
Answer need to be stored as 7/10 instead of 7

Feedback form's version to be displayed on the form

Feedback form header links has to be pointed to vlabs.ac.in not open-edx.vlabs.ac.in

Feedback form footer and header to be same as its source's footer and header. Feedback when accessed from vlabs.ac.in to be directed to vlabs.ac.in and not open edX from the header

Meta Data of Answers need to be captured in Feedback Database.

Meta Data of Answers need to be captured in Feedback Database.

Example:

1. What is good in Virtual Labs?
   a) Visibility
   i) 1 ii) 2 iii) 3 iv) 4 v) 5
   b) Content
   i) 1 ii) 2 iii) 3 iv) 4 v) 5
   c) Simulations
   i) 1 ii) 2 iii) 3 iv) 4 v) 5

Upgrade feedback portal from v2.2.0 to v2.3.0

Feedback Portal service to be upgraded on (AWS)

Feedback form version need to be captured in Database.

Feedback form version need to be captured in Feedback Database.
All the questions in the feedback form need to store form version along with question name and its type.

Test cases to be written for elk related APIs

Currently all the APIs related to post processing of college cloud are implemented as part of feedback service these apis are used by both college cloud as well AWS cloud services.

Test cases for both the scenarios need to be implemented

Migrate APIs to ElasticSearch Service

Currently APIs required to push the usage analytics, feedback analytics are implemented part of feedback service. Going forward we need migrate these APIs (3) to dedicated service

Implement REST APIs to post process the college cloud data

REST API Design and implementation ca be found at https://github.com/vlead/feedback-portal/blob/master/src/runtime/rest/api.org#dump-college-details-into-the-elastic-database

REST API documentation can be found at : https://github.com/openedx-vlead/college-cloud/blob/cc-april-delhi/src/design/index.org#dump-college-cloud-data-to-elk

Dump historic feedback forms data into elastic search database

Dump all old feedback forms data (from 2015-10-14 to till date) into elastic search database for kebana to visualize the feedback usage

Ability to Create, Modify, Update and Delete the new Question.

The following CRUD operations are implemented for "Question" Entity.

• GET and POST methods for "/questions"
• GET, PUT and DELETE methods for "/questions/"

Obtaining Feedback from Portable hard drive edition

Portable hard drive has ported with 70 labs in it. All these labs feedback should be stored into local feedback service.

Implementation of Persistent Entitites

The following list of entities to persist:

1. Question
2. Answer
3. Response
4. Feedback

Build the API using delegation for persistence object insted of deep copy

The API that allows "get" works on the state variable that is a dictionary that stores all the attributes of an object. To provide the same API to a persistent object retrieved by sqlalchemy, currently the attributes are copied to the state variable. This is a deep copy. Instead a delegate should be provided for a persistence object that does not do a deep copy but still retrieves the attribute.

Experiment level feedback form is not working on OpenedX platform

I have been working on testing OpenedX labs with all the links including feedback. Today I found that experiment level feedback form is not working. But it was working till yesterday

@Developers : Can you please look into this issue.

Footer page to be updated

Currently ,

feedback portal footer page is not same as current version of vlabs.ac.in page this is to be updated

Code/Model Review

29/08/16

1. File structure need to be followed in github.
2. Questions and Answers sets can be derived sets.
3. In Outreach, gateway_ip to be added in workshop.
4. Following operations to add:

• Add answer
• Add question
• Add response
• Add feedback

5. In configuration file, question should have id, name, type and values.
   {
   "id" : " ",
   "name" : "",
   "type" : "",
   "values" : [1, 2, 3, 4, 5]
   }

Fixing head page

feedback portal header page should be same as vlabs.ac.in latest version

Feedback-Portal base url should redirect to vlabs.ac.in

When people access feedback.vlabs.ac.in link it should redirect to vlabs.ac.in link

Utils packages is update

Utils package is update for more info please refer to https://github.com/vlead/feedback-portal/tree/master/src/runtime/utils

Feedback review by GKSK related

1. Mail trails with Prof GK Suraissh.txt

2. AnalysisofDesignofVirtualLabsFeedbackForms (1).pdf

Response on point of the MoM of the PRSG meeting on 21st October 2016

Prof Suraish Kumar reviewed the feedback forms newly included in the feedback portal, just before the 21st October 2016 meeting. His review comments assess the forms to be ' much better than the existing ones' and OK for use.
He was also keen on the inclusion of 'dynamic' feedback at the experiment level for capturing the 'learning extent of the students'. He suggested a method of feedback capture at the experiment level.

In view of the above, the feedback forms introduced can be considered as approved.
The inclusion of the experiment level 'dynamic'feedback is to be taken up with the consent of the Lab Developers/Institute Integration Coordinators. This question is therefore left to them to take a call.

Detailed analysis of Recommendation:

Context:

The feedback forms proposed and included in feedback.vlabs.ac.in were reviewed by Prof GK Suraish Kumar. A document that analyzes the feedback forms in relation to a standard feedback framework, the objectives of vlabs and other general factors was prepared by VLEAD and shared with him. The document also did a comparative analysis of the earlier forms and the proposed forms.

Recap

To recap, the revised feedback forms introduced into the feedback portal of Virtual labs, were at the 3 levels:
At a Generic Level
At Lab Level
At the Experiment Level

Review Comments

Prof Suraish found these above forms much better than the existing ones. He however suggested that experiment level feed back to assess the "Learning extent of the students " was required to be incorporated.

The question of incorporating experiment level feedback is to do with the experiment technicalities and is a subject that the Lab designers are to address. Prof Suraish felt that the feedback capture must be smooth and periodic. He suggested that this should be captured after every 1 or 2 sections of the experiment done by the student. The questions may also be picked up from the current evaluation quiz at the end of the experiment. His observation was as follows:" ... The only thing I would add is to display the answer irrespective of the student response to the question, and smoothly move on to the next part in the experiment. The emphasis (as you have elaborated) is also on the smoothness of these queries, without making them appear as formal evaluations'. Thus, VLabs would have much better and natural input on the learning. If numbers on student testing' are needed for various administrative needs of the project, they have become available too by this process."

"If the student desires his/her `score' at the end of the experiment, let the student explicitly click a button to know it.
In addition, the same questions that exist now as a separate and optional evaluation at the end of each experiment, if suitable, can be the questions that are placed at various parts of the experiment."

This the gist of the review done by Prof Suraish Kumar. For easy reference, the extracts of the mails exchanged with him on this subject [document 1] and the Analysis document [2 above] are made available.

Implement captcha on all feedback forms

As of now all feedback forms are do not have captcha this resulting flooding of database by writing automation script

Code review comments on 2nd Feb on college cloud post processing

Footer has to be changed as per vlabs.ac.in page

Footer page of the feedback portal to be changed same as http://vlabs.ac.in page

Feedback questionnaire to be updated

Final approved questionnaire needs to be updated on feedback form.

MoM of Feedback Portal

Attendees : vlead staff
Date: 16/09/2016

• Response is not a good word need to have a better word may be qa_pair
• User credentials need to be captured. eg: user_id
• Requirements need to be sited to meeting minutes. eg: issues 1014, item 10.
• how many labs does not have feedback. ( this number need to be captured)
• how many labs have feedback. (out of 114)
• radio buttons should be displayed down (take care in mobile version)
• In feedback form, rating descriptors need to be displayed.
• =lab_id= also need to be captured and displayed on the form.
• Requirement satisfied links need
• user city and town need to be added in user registration so that it can be
  used in feedback. (used for analytics)
• scenarios need to be defined along with requirements or use cases need to be defined)
• edge cases and corner cases need to be taken care
• =feedback_usage_by_workshop= need to be changed to feedback_usage.
• =workshop_set= need to be removed. name something else. usage by ip and date
• Assumptions section need to captured in the model.
• =date= need to be captured from the machine itself. (take from the server).
• total number of test cases need to be defined.
• Systems team will give api by EOD.
• no need of re-direction because vlabs can also use this feedback form.
• form need to have version number displayed
• old feedback data need to be migrated or not

makefile and init.sh file to be added

In next release of feedback portal makefile and init.sh files to be modified as per https://github.com/vlead/lab-data-service repository

Add labels to the generic feedback question

Added followings labels to the question (Please rate your experience)
labels : Not good , to some extent, very well

Requirements for Feedback Service

All the Requirements need to be captured for Feedback Service.

Calculate Gateway IP of Feedback Portal User

As a Lab User, when feedback is submitted, feedback portal should capture the client User IP (or) Gateway IP from where the feedback is submitted. This IP will be used for further feedback analysis.

Feedback Form Design & Implementation

Dynamic Feedback Form need to be designed and implemented.

Fix 'list indices must be intiger' issue with dump analytics data to ELK API

REST API : https://github.com/vlead/feedback-portal/blob/master/src/runtime/rest/api.org#dump-usage-to-elk is throwing following error while running through a script.

"List indices must be be integer"

Data Model for Feedback Service

A data model for Feedback Service is to be defined.

QA_QA_Feedback_Footer

Defect Description:
The feedback page footer is different from the landing page footer instead in both the pages the footer should be same.
Actual Result:
The feedback page footer is different from the landing page footer

Environment :
OS: Windows 7, Ubuntu-16.04,Centos-6
Browsers: Firefox-42.0,Chrome-47.0,chromium-45.0
Bandwidth : 100Mbps
Hardware Configuration:8GBRAM ,
Processor:i5

QA_Feedback_Search

Defect Description:
In the feedback page the search option is present at the top instead the search functionality should be removed

Actual Result:
In the feedback page the search option is present at the top

Environment :
OS: Windows 7, Ubuntu-16.04,Centos-6
Browsers: Firefox-42.0,Chrome-47.0,chromium-45.0
Bandwidth : 100Mbps
Hardware Configuration:8GBRAM ,
Processor:i5

Experiment level feedback form is storing lab_name as exp_name

This issue was figured out by @raghupathi while checking feedback forms on protable hard drive.
We have quick fixed this issue on production as well as all testing machines.

Migrate historic feedback form data into elastic search database

• Available feedback forms from 2015-10-14 to 2017-03-14 are 1592
• All 1592 records are migrated to elastic search database under /vlabs/feedback api

Generic Lab and Experiment level Feedback forms are implemented

The users of virtual labs will able to give the feedback for non Open-edX Labs.
Hence, Generic Lab and Experiment level Feedback forms need to be implemented where Lab name
and Experiment name need to be given as inputs by the user.

header of the feedback portal is to be changed

Header page of the feedback-portal to be changed same as vlabs.ac.in latest release. (http://vlabs.ac.in)

Implementation of Object Entities

The following are the list of object entities:

1. Question
2. Answer
3. Response
4. Feedback