Skip to content

Latest commit

 

History

History
190 lines (177 loc) · 9.51 KB

TODO.md

File metadata and controls

190 lines (177 loc) · 9.51 KB
Raw

TO*DOs (spelled like this, so it doesn't show when searching for the word...)

WS 20/21 Before publish

  • License
    • Check license
  • Create "demo course" for screenshots/documentation purposes
    • Constant date on dashboard page, with faked number of students, accesses, etc...
  • Make a nice README
    • Add data privacy information and German data privacy note for Datenschutzerklärung
    • Screenshots of pages
    • More information on data storage/use
  • customfield rename to "course statistics"
  • Heatmap
    • Heatmap with zero hits everywhere looks odd...
  • Contributing
    • Explain versions
  • Privacy Provider
    • Check implementation, we probably don't need one as there is no personal data in there...
  • HTML elements
    • Remove div-soup on top-level and use Moodle div's instead
  • Add uninstall script that removes our tables
    • Removes all creates tables -> this is actually done automatically by Moodle
    • Removes all data -> same
    • Removes customfield
    • Removes user tour
  • Add new reports to upgrade.php script -> table removed instead
    • Remove the la database entries instead?
  • Explain capability "learning_analytics:view_statistics" in README (by default students can view statistics) => it's already in there

WS 20/21 Before Moodle store

  • Wording: "Learning Analytics Angebot" / "Service"
  • Test plugin with more multi-language content and check where to use format_string when printing activity names
  • Administration
    • Option: Start of the week: Sunday/Monday => respect Setting of Calender in Moodle
  • Accessibility: Add alt texts to images/icons, add aria-labels where needed
    • Check if color blindness is respected
    • Give graph meaningful aria labels
    • Add aria-hidden to data that is not needed for screen readers
  • Check Moodle guidelines => we should be fine, expect for some naming conventions, but we ignore them for now...
  • If customfield setting is used, add information to course backup / import (if that is even possible...) => This is done automatically (you can choose what to backup when you make the backup)
  • Fully remove "prevcourse" information
    • allow_dashboard_compare
    • prevcourse
    • showcompare flag
    • previd parameters
    • Language strings
    • Database table

Ideas for reports (SS 2021?)

  • Plot enrolments over time on the participants page
  • Add time filter to activities page (and heatmap?)

For later

  • Fix Postgres problem of learners report
  • Update customfield option in Course settings
  • External database support
  • Tests
  • Provide an option to allow or disable tracking teachers
  • "Consent-API" Not until Moodle supports optional policies...
  • Remove any magic numbers and strings and use constants file
  • Put subplugin settings (like allow_dashboard_compare) in the actual subplugins (check if that really makes sense) -> This would just make it harder for administrators...
  • Check and update CLI scripts of logstore
  • Create a special class directory for pages (classes/pages) so that they don't get mixed up with other classes

For much later: API structure

  • Make reports to show configurable on dashboard
    • Each report should have a "small" stats to be shown on dashboard and a "report" page
  • Users of our plugin still have the lalog_browser_os table installed (RWTH + HRW) -> not anymore

WS 20/21

  • Logstore plugin: Database changes (wait for ITC answer)
    • Change OS/browser column to a single column and just use 100 values for browser and 100 for OS (?)
    • Remove objectid, this would not allow looking "into" modules anymore, but this will probably not happen anyway
    • Remove userid
  • Bug: Loading indicator wird beim resizen sichtbar
  • UX
    • Finish help page
    • Embed help into website (FAQ?)
    • Communication to users: Not possible to show more data due to privacy (and what data is being logged)
    • Don't make icons on dashboard clickable (confusion to users, looks like there are two clickable items per field)
    • Add loading animation to plots
  • Remove browser report
  • For other universities
    • Postgres: Check if database still works
      • TO DO merge from Thorbens branch
    • Log: Improve import script to specify number of weeks to import
  • Change activities report
    • Vertical list? => Not for now
    • Use vertical divider for each section
    • Add search
    • Make plot at the top scrollable (?) => Probably not for now
    • Add "remove filter" link when filter was applied => not needed for now (I guess?)
  • Check out all "TO DO"s in code, especially "TO DO lang" for language strings
    • Fix "TO DO lang"
    • Add a small info text to each report to give an overview
      • Activities: Small text explaining that the user can also filter by clicking on the names
      • Quiz, assign: Short explanation
      • Weekheatmap: Short explanation
      • Learners: Short explanation
    • Check all other TO DOs
    • Check if existing lang-strings should be replaced by Moodle native strings
      • "Registrierte Nutzer"
      • "Lernende"
      • "Quizze" / "Aufgaben"
      • "Punkte" ...
  • Dashboard last changes
    • Change "quiz/assign" "<1" look, more it more to the middle (?)
  • "Weekly heatmap" instead of browsers
  • New report for quiz statistics
    • Add new report IDs (to the logged reports)
  • Fix problems of "Parallel heard / So far heard courses"
  • Custom course settings to give option

Pre SS 2020

  • Add title to page
  • Make sure only people enrolled can see the statistics
    • use capabilities for this -> by default, students and teachers can view statistics
  • Make logstore_lanalytics a dependency of this plugin
  • Give option to disable "Set course to compare" (as this makes no sense without data currently)
  • Make "Activities" box link to activity report even if no recently used activiy exists
  • Report: Browser/mobile usage in course
    • Integrate Moodle-API into desktop/mobile statistics
    • Add language keys
  • Add event view_analytics (or a similar event)
  • Check localization
    • Add English text for all missing strings
    • Add German texts for all missing strings
  • Update README
  • Improve README
    • Add info on installation
      • Enable logstore
      • Setup logstore (go over settings)
    • Add info on settings of main plugin
      • privacy threshold
      • compare_options
  • Add information to tables: "Only data >= X is shown"
    • Mabye add this information on the dashboard (?)
  • Only show dashboard link in selected courses
  • Update README.md in reports folder
  • Don't show empty tables or empty data plots
  • Tracking roles whitelist (in addition to blacklist)
    • Provide better options for which courses are logged:
      • Option "Log"
        • All courses
        • Only the courses specified below (whitelist)
        • Only the courses NOT specified below (blacklist)
  • Local plugin:
    • If logstore is disabled, don't show in the navigation
    • Show analytics: (enables the Analytics page and add the link to the navigation)
      • Show navigation link if logging is enabled for the course
      • Show navigation link if course is specified below via course_ids
      • Show navigation link even if logging is disabled for the course (only enable this, if you already logged data before)
      • Hide navigation link but keep the page enabled (only if you know the link, you can access Analytics)
      • Hide navigation link and also disable the page itself (even if logging happens in the background)
  • Make table with loggable courseids (instead of single setting)
    • After checking, I'll leave it like this for now as it's probably faster this way. The advantage will probably only come when there are a lot of courses added in this way...
  • Update README with new settings
  • Logstore plugin: Make sure it also works on its own (without this plugin)
    • Make sure it only loads lalog plugins if this plugin is installed
  • Page that shows what kind of data is being tracked and whether one is being tracked => only anonymous data is being saved, not implemented

Logstore

  • Implement setting to only track specific courses (as specified in lanalytics/course_ids)
  • Don't track teachers for now
  • Detect Moodle-API use
  • Add LICENSE file to root directory

GDPR

  • Create "Verfahrensverzeichnis"
  • Datenschutzerklärung erstellen
  • Implement Moodle Privacy providers (new item further below)
  • Make sure that groups < X (aks GDPR officer) are not shown
    • Ask (meeting 2020-03-10) what X is, configurable -> 10 by default
    • Is is okay to still track the data (even when groups < X) but don't display results for smaller courses
      • If necessary, change tracking algorithm to check size of course
    • Change accordingly, examples:
      • learners/courseparticipation list
      • learners language/countries list

Release

  • Check coding guidelines => Done, but we might to do this again...
  • Check hurdles for Moodle store
  • Decide the name: rwthanalytics? aixanalytics? => decide later