instruction
stringclasses 1
value | input
stringlengths 61
6.42k
| solvability
stringclasses 2
values | output
stringlengths 60
70.4k
| text
stringlengths 715
71.3k
|
|---|---|---|---|---|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle Community Sites
summary: Moodle community sites 3.7.1/3.6.5 upgrade
description: Moodle 3.7.1 is scheduled for release on Monday 8 July 2019.
| Unsolvable | 1.summary: Upgrade moodle.net to 3.6.5
description:
2.summary: Upgrade dev.moodle.org to 3.6.5
description:
3.summary: Upgrade moodle.org to 3.7.1
description:
4.summary: Upgrade learn.moodle.net to 3.7.1
description:
5.summary: Upgrade school.demo.moodle.net to 3.7.1
description:
6.summary: Upgrade demo.moodle.net to 3.7.1
description:
7.summary: Upgrade lang.moodle.org to 3.6.5
description:
8.summary: Upgrade download.moodle.org to latest 3.5.x
description:
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle Community Sites
summary: Moodle community sites 3.7.1/3.6.5 upgrade
description: Moodle 3.7.1 is scheduled for release on Monday 8 July 2019.
### Response:
1.summary: Upgrade moodle.net to 3.6.5
description:
2.summary: Upgrade dev.moodle.org to 3.6.5
description:
3.summary: Upgrade moodle.org to 3.7.1
description:
4.summary: Upgrade learn.moodle.net to 3.7.1
description:
5.summary: Upgrade school.demo.moodle.net to 3.7.1
description:
6.summary: Upgrade demo.moodle.net to 3.7.1
description:
7.summary: Upgrade lang.moodle.org to 3.6.5
description:
8.summary: Upgrade download.moodle.org to latest 3.5.x
description:
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle app
summary: Forum improvements for 3.8
description: Forum improvements for 3.8
| Unsolvable | 1.summary: Allow user to edit forum posts
description: allow user to edit forum posts from moodle mobile.
2.summary: Forum - posts without replies sometimes the time elapsed is shown
description: Using the App (Android mobile device as well as iPhone as well as Moodle Desktop (Mac)), posts without replies (0 replies) of forums sometimes the time elapsed is shown and others isnt. See screenshoots
3.summary: Delete forum posts
description: Add option to delete forum posts
4.summary: UI improvements on forum
description: Change locked, pinned, starred, subscribed status on the discussion list. Right now, only when entering a discussions can be done (except subscribed, cannot be done right now). Show complete dates (with time) on discussion posts. Show image attached as inline, currently theres shown as an attachment file. (Check the same for audio and video) Match nested mobile UI to modern forum UI. (I think theres no need to have both). restriction on size
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle app
summary: Forum improvements for 3.8
description: Forum improvements for 3.8
### Response:
1.summary: Allow user to edit forum posts
description: allow user to edit forum posts from moodle mobile.
2.summary: Forum - posts without replies sometimes the time elapsed is shown
description: Using the App (Android mobile device as well as iPhone as well as Moodle Desktop (Mac)), posts without replies (0 replies) of forums sometimes the time elapsed is shown and others isnt. See screenshoots
3.summary: Delete forum posts
description: Add option to delete forum posts
4.summary: UI improvements on forum
description: Change locked, pinned, starred, subscribed status on the discussion list. Right now, only when entering a discussions can be done (except subscribed, cannot be done right now). Show complete dates (with time) on discussion posts. Show image attached as inline, currently theres shown as an attachment file. (Check the same for audio and video) Match nested mobile UI to modern forum UI. (I think theres no need to have both). restriction on size
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: MoodleNet
summary: MoodleNet 3.0.0
description: MoodleNet 3.0 advances version 2.x.x to include an Extensibility Environment for Developer Contributions and Add-Ons. This provides a structured and documented way to allow internal and external developers to develop non-core features for MoodleNet. This will allow developers to work on features and functionality that allow MoodleNet to fit into processes (e.g. SSO, Allow/Deny Domains, Social interaction improvements, gamification and achievement badges) that are not on the current roadmap.
| Unsolvable | 1.summary: Profile Page improvements
description: bru.mas finalize current impl as static page in storybook ettore.bevilacqua then implement Ctrl and apply to webapp route
2.summary: Admin page
description: An Admin page needs to be set up.
3.summary: deploy a staging server
description: Would be great to have kind of a staging live system, where we can showcase the state-of-the-art of the system and feature-packages development with "live" upgrade functionalities
4.summary: MoodleNet Developer Webinar
description: Prepare for a webinar on v3.0 on 30th November 2022 on Moodle Academy
5.summary: Moodle Academy Course on MoodleNet Development
description: This course is designed for developers who want to start developing MoodleNet packages and contribute to the MoodleNet community.
6.summary: save and use custom primary color on
description: In settings/appearance page the user can choose a `primary color` for the webapp create backend service for saving when webapp loads it fetches appearance settings and applies them in the webapp
7.summary: Profile Page edit
description: bru.mas add editing features to static profile page ettore.bevilacqua amend Ctrl implementation no auth checks needed for the moment
8.summary: Repository - documentation and community guidelines
description: Lets clearly define the processes we want to see from community developers about contributing to source (eg the use of tracker issues, pull requests etc) and document those clearly in our docs and on the gitlab page
9.summary: ArangoDB package
description: manages the main Moodlenet databases, exposes services for packages to use arangodb: on request, creates a new private database for each package (and deletes it package uninstallation) provides services for collection maintainance and querying
10.summary: simple-email-auth package (email - password auth)
description: Finalize basic features of simple-email-auth Complete signup workflow with confirmation email (using crypto package for token) Use Auth-manager for email-user association use ArangoDB package for storage
11.summary: review packages lifecycle/naming and framework apis
description: the package is the extension. extension name is the package name Id suggest to use the term package for users too.. I think extension would be kind of misleading review pkg Lifecycle with install setup / uninstall cleanup Simplified framework internals and APIs, to let the architecture be clearer for developers
12.summary: key-value-store package
description: a handful simple key-value store for any package needing to easily persist data typically used for configs, but not only. works on top of arangodb pkg
13.summary: cryptographic services package
description: a (growing) centralized set of crypto services. stores key-pairs in KVStore currently provides - encrypt - decrypt - signJWT - verifyJWT
14.summary: email services package
description: services for emails. stores email configs (nodemailer transport config) currently just provides a send service
15.summary: proper and complete cli install workflow
description: standard procedure installs a number of fundamental packages, cli accepts option arguments for all necessary configs needed for first bootstrapping cli implements user friendly prompts for any mandatory config not provided as argument
16.summary: improve authentication-manager pkg
description: leverage newly implemented packages arangodb for user storage crypto for session token enc/dec
17.summary: react-app backend : Appearance/customization config & storage
description: implement backend services for react-app configs/settings storage (key-value-store)
18.summary: organization/instance package backend
description: create the package implement services to store and retrieve instance data (key-value-store)
19.summary: content-graph : backend
description: over arangodb Manages Content graph nodes(entities) and edges(relations) Creates new node-collections and edges-collections for packages on install and removes on uninstall Let packages maintain own custom metadata to any collection-entities
20.summary: profile package : backend
description: Adds Profile node to Content graph Adds a DB in ArangoDB for (Auth-manager)account-profile association
21.summary: email-auth : hook to profile
description: on signup completed and user created, create a web-user-profile associated to it
22.summary: Authorisation System
description: Implement an authorisation system based on API scopes (similar to OAuth) and user-type/user-role (permissions/roles/user-types) packages can add scopes to system packages must configure their APIs assigning them scopes (theirs or others) packages can add user-types to system
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: MoodleNet
summary: MoodleNet 3.0.0
description: MoodleNet 3.0 advances version 2.x.x to include an Extensibility Environment for Developer Contributions and Add-Ons. This provides a structured and documented way to allow internal and external developers to develop non-core features for MoodleNet. This will allow developers to work on features and functionality that allow MoodleNet to fit into processes (e.g. SSO, Allow/Deny Domains, Social interaction improvements, gamification and achievement badges) that are not on the current roadmap.
### Response:
1.summary: Profile Page improvements
description: bru.mas finalize current impl as static page in storybook ettore.bevilacqua then implement Ctrl and apply to webapp route
2.summary: Admin page
description: An Admin page needs to be set up.
3.summary: deploy a staging server
description: Would be great to have kind of a staging live system, where we can showcase the state-of-the-art of the system and feature-packages development with "live" upgrade functionalities
4.summary: MoodleNet Developer Webinar
description: Prepare for a webinar on v3.0 on 30th November 2022 on Moodle Academy
5.summary: Moodle Academy Course on MoodleNet Development
description: This course is designed for developers who want to start developing MoodleNet packages and contribute to the MoodleNet community.
6.summary: save and use custom primary color on
description: In settings/appearance page the user can choose a `primary color` for the webapp create backend service for saving when webapp loads it fetches appearance settings and applies them in the webapp
7.summary: Profile Page edit
description: bru.mas add editing features to static profile page ettore.bevilacqua amend Ctrl implementation no auth checks needed for the moment
8.summary: Repository - documentation and community guidelines
description: Lets clearly define the processes we want to see from community developers about contributing to source (eg the use of tracker issues, pull requests etc) and document those clearly in our docs and on the gitlab page
9.summary: ArangoDB package
description: manages the main Moodlenet databases, exposes services for packages to use arangodb: on request, creates a new private database for each package (and deletes it package uninstallation) provides services for collection maintainance and querying
10.summary: simple-email-auth package (email - password auth)
description: Finalize basic features of simple-email-auth Complete signup workflow with confirmation email (using crypto package for token) Use Auth-manager for email-user association use ArangoDB package for storage
11.summary: review packages lifecycle/naming and framework apis
description: the package is the extension. extension name is the package name Id suggest to use the term package for users too.. I think extension would be kind of misleading review pkg Lifecycle with install setup / uninstall cleanup Simplified framework internals and APIs, to let the architecture be clearer for developers
12.summary: key-value-store package
description: a handful simple key-value store for any package needing to easily persist data typically used for configs, but not only. works on top of arangodb pkg
13.summary: cryptographic services package
description: a (growing) centralized set of crypto services. stores key-pairs in KVStore currently provides - encrypt - decrypt - signJWT - verifyJWT
14.summary: email services package
description: services for emails. stores email configs (nodemailer transport config) currently just provides a send service
15.summary: proper and complete cli install workflow
description: standard procedure installs a number of fundamental packages, cli accepts option arguments for all necessary configs needed for first bootstrapping cli implements user friendly prompts for any mandatory config not provided as argument
16.summary: improve authentication-manager pkg
description: leverage newly implemented packages arangodb for user storage crypto for session token enc/dec
17.summary: react-app backend : Appearance/customization config & storage
description: implement backend services for react-app configs/settings storage (key-value-store)
18.summary: organization/instance package backend
description: create the package implement services to store and retrieve instance data (key-value-store)
19.summary: content-graph : backend
description: over arangodb Manages Content graph nodes(entities) and edges(relations) Creates new node-collections and edges-collections for packages on install and removes on uninstall Let packages maintain own custom metadata to any collection-entities
20.summary: profile package : backend
description: Adds Profile node to Content graph Adds a DB in ArangoDB for (Auth-manager)account-profile association
21.summary: email-auth : hook to profile
description: on signup completed and user created, create a web-user-profile associated to it
22.summary: Authorisation System
description: Implement an authorisation system based on API scopes (similar to OAuth) and user-type/user-role (permissions/roles/user-types) packages can add scopes to system packages must configure their APIs assigning them scopes (theirs or others) packages can add user-types to system
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle Community Sites
summary: MUA new model setup (Discovery)
description: Goal: propose a new setup for MUA /HQ/ community interaction MUA ideas - board of trustees / steering group including volunteers elected and recognised (how) top universities and contributors - Regular Community Teams/ MUA liaison meetings - Able to fund the costs of its organisation and projects Remodelling MUA and stakeholder representation into a stronger Moodle.org community. By the end of this epic, Aurelie will offer options of models of work with MUA and partners in Moodle.org.
| Unsolvable | 1.summary: Initial draft with MUA
description: Aurelie to review work so far in MUA Improvement Planning document by MUA. and organise next meeting to review inputs.
2.summary: MUA committee / Aurelie interviews to build proposal
description: Aurelie will book time with all who can on the committee during November, and write up notes, to feed into the model options.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle Community Sites
summary: MUA new model setup (Discovery)
description: Goal: propose a new setup for MUA /HQ/ community interaction MUA ideas - board of trustees / steering group including volunteers elected and recognised (how) top universities and contributors - Regular Community Teams/ MUA liaison meetings - Able to fund the costs of its organisation and projects Remodelling MUA and stakeholder representation into a stronger Moodle.org community. By the end of this epic, Aurelie will offer options of models of work with MUA and partners in Moodle.org.
### Response:
1.summary: Initial draft with MUA
description: Aurelie to review work so far in MUA Improvement Planning document by MUA. and organise next meeting to review inputs.
2.summary: MUA committee / Aurelie interviews to build proposal
description: Aurelie will book time with all who can on the committee during November, and write up notes, to feed into the model options.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Moodle 4.1 theme epic
description: Collection of issues raised during 4.0 dev that have been deferred till 4.1+
| Unsolvable | 1.summary: Move form submit buttons to the left
description: The form submit buttons should be aligned left to match the UX designs in figma
2.summary: Allow users to resize and crop images
description: To give users more control over images like the profile picture and images used in content users should be able to resize and crop images in Moodle. Large images should be resized automatically to prevent slow page loads. This will help improve the usability of the user profile editing page and give users more control over how the images will be displayed.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Moodle 4.1 theme epic
description: Collection of issues raised during 4.0 dev that have been deferred till 4.1+
### Response:
1.summary: Move form submit buttons to the left
description: The form submit buttons should be aligned left to match the UX designs in figma
2.summary: Allow users to resize and crop images
description: To give users more control over images like the profile picture and images used in content users should be able to resize and crop images in Moodle. Large images should be resized automatically to prevent slow page loads. This will help improve the usability of the user profile editing page and give users more control over how the images will be displayed.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Improve accessibility of the filepicker
description: A new LMS accessibility study from University of Illinois was published recently, unfortunately they had Moodle 2.3 only, but has some useful things to say: The main issue they had was unfortunately with our filepicker, which is complex. Ive created this issue to address that. The FRONTEND team needs to develop a list of the exact problems (as subtasks here) and then tackle them together. Note that its likely that accessibility improvements will also make the experience better for everyone on touch screens.
| Unsolvable | 1.summary: Explore ideas for reducing the size of the file picker.
description: The filepicker takes up alot of vertical space. When it is used in a form in pushed elements below it off the bottom of the page. Because it is large, it also implies (visually) that it is important which may not be the case (e.g. coursefiles). Maybe it should have a smaller view by default and have a expand/collapse toggle (and get bigger when a drag/drop is in progress). This issue was raised because of a request to add a filepicker to the assignment settings page - but I am reluctant to do that because it will push important settings off the page.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Improve accessibility of the filepicker
description: A new LMS accessibility study from University of Illinois was published recently, unfortunately they had Moodle 2.3 only, but has some useful things to say: The main issue they had was unfortunately with our filepicker, which is complex. Ive created this issue to address that. The FRONTEND team needs to develop a list of the exact problems (as subtasks here) and then tackle them together. Note that its likely that accessibility improvements will also make the experience better for everyone on touch screens.
### Response:
1.summary: Explore ideas for reducing the size of the file picker.
description: The filepicker takes up alot of vertical space. When it is used in a form in pushed elements below it off the bottom of the page. Because it is large, it also implies (visually) that it is important which may not be the case (e.g. coursefiles). Maybe it should have a smaller view by default and have a expand/collapse toggle (and get bigger when a drag/drop is in progress). This issue was raised because of a request to add a filepicker to the assignment settings page - but I am reluctant to do that because it will push important settings off the page.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Epic: Collect together deprecated and planned code changes for Moodle 3.6
description: In 3.6 we can remove functionality that was deprecated in 3.2 or earlier (see ) There are a number of parts of the Moodle codebase that have been marked as deprecated as a warning to developers not to use these functions as they will be removed in future. Many have a deadline of 3.6. Each of these deprecated functions, especially those in Moodle core code, should have an MDL issue associated with it. In order to time the removal of these deprecated functions issues and not lose sight of them, this issue will be used to collect them together.
| Unsolvable | 1.summary: Properly deprecate print_textarea()
description: This issue remains here so we can eventually deprecate this function when all usages are removed. Until then keep moving it to the next deprecation epic Deprecated function print_textarea() does not display debugging message. Also there are still usages in core: code $ git grep print_textarea lib/adminlib.php: $return = .print_textarea(true, 15, 60, 0, 0, $this->get_full_name(), $data, 0, true, summar lib/form/htmleditor.php: print_textarea(true, mod/feedback/show_nonrespondents.php: print_textarea(true, 15, 25, 30, 10, "message", $message); mod/wiki/editors/html.php: echo $OUTPUT->container(print_textarea(true, 20, 100, 0, 0, "newcontent", $content, 0, true, , form-textarea-advan mod/wiki/editors/wiki_editor.php: echo $OUTPUT->container(print_textarea(false, 20, 60, 0, 0, "newcontent", $content, 0, true), false, wiki_edi user/message.html: code Also see
2.summary: Remove callback delete_course deprecated in 3.2
description: Remove callback delete_course deprecated in 3.1 in
3.summary: Phase 2 of deprecation of functions in lib/deprecatedlib.php initially deprecated in 3.2
description: As per all functions in lib/deprecatedlib.php that were deprecated in 3.2 should be replaced with exceptions in 3.6 This includes all functions in lib/deprecatedlib.php that say since 3.2 _If any functions from this file do not have this comment but also need to be finally deprecated in 3.6- please list them in this issue description_
4.summary: Remove strings deprecated in 3.2
description: Remove strings from language files under the heading "Deprecated since Moodle 3.2" and the respective lines in deprecated.txt files See also
5.summary: Final deprecation of useredit_update_picture
description: Remove useredit_update_picture from user/editlib.php
6.summary: Final deprecation of get_records_csv and put_records_csv.
description: Remove get_records_csv() and put_records_csv from deprecatedlib.php See for the proper process.
7.summary: Remove password_compat skeleton
description: See for further information. A skeleton was included to inform developers that manual skeleton inclusion was no longer necessary. This can now be removed.
8.summary: Remove deprecated apis in behat_config_mananger.php in 3.2
description: While working on ---- lot of static apis were deprecated in behat_config_mananger.php as they are not needed. - get_features_with_tags() - get_components_steps_definitions() - get_config_file_contents() - merge_behat_config() - get_behat_profile() - profile_guided_allocate() - merge_config() - clean_path() - get_behat_tests_path()
9.summary: Remove i_set_the_field_to_multiline deprecated in 3.2
description: Remove i_set_the_field_to_multiline deprecated in 3.2
10.summary: Remove support for message objects as stdClass
description: Remove the debugging message in lib/classes/message/manager.php send_message when event data is passed as a stdClass. Throw a coding exception instead (the logic for the coding exception is there already, so it just needs to be removed from the allowed types. Tip: Look for "" in codebase and youll find a number of places (both and TODO) pointing to places and changes expected.
11.summary: Remove functions from calendar/lib that were deprecated in 3.2
description: In the function calendar_preferences_button(stdClass $course) was deprecated. This issue is to perform final deprecation.
12.summary: Final deprecation of css optimiser and related functions
description: Following
13.summary: Remove behat_transformations::prefixed_tablenode_transformations in 3.6
description: behat_transformations::prefixed_tablenode_transformations() was deprecated in Moodle 3.2 and no longer in use. Please remove in Moodle 3.6
14.summary: Phase 2 (or remove) media stuff deprecated in 3.2 when new media plugin type was introduced
description: Specifically: - remove lib/medialib.php and add it to "standard removed files" - remove class core_media_renderer - core_media_player::is_enabled and core_media_player_link::is_enabled - core_media_player::compare_by_rank
15.summary: Remove old class renames
description: core_component looks for COMPONENT/db/renamedclasses.php files, it allows us to avoid traumatic transitions and BC breakages by listing classes that have been removed. We need to clean the list at some point.
16.summary: Remove behat steps deprecated in 3.2
description: go through lib/tests/behat/behat_deprecated.php and remove steps that were deprecated in Moodle 3.2 please add to the description if you know of any other deprecated behat functionality outside of this file that needs to be removed
17.summary: Remove Assignment upgrade helper from core
description: Its been 5 years now - time to remove this old code.
18.summary: Final deprecation of core_renderer::update_module_button
description: Remove core_renderer::update_module_button which was deprecated in 3.2.
19.summary: Deprecate the htmleditor form element
description: The htmleditor form element (lib/form/htmleditor.php) is not used anywhere in core (instead we use the editor element).
20.summary: Final deprecation of core_course_renderer::add_modchoosertoggle(), deprecated in 3.2
description: core_course_renderer::add_modchoosertoggle() was deprecated for Moodle 3.2 by This is about to remove it for 3.6 completely.
21.summary: Final deprecation of the form element submitlink
description: This was deprecated in 3.2 in .
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Epic: Collect together deprecated and planned code changes for Moodle 3.6
description: In 3.6 we can remove functionality that was deprecated in 3.2 or earlier (see ) There are a number of parts of the Moodle codebase that have been marked as deprecated as a warning to developers not to use these functions as they will be removed in future. Many have a deadline of 3.6. Each of these deprecated functions, especially those in Moodle core code, should have an MDL issue associated with it. In order to time the removal of these deprecated functions issues and not lose sight of them, this issue will be used to collect them together.
### Response:
1.summary: Properly deprecate print_textarea()
description: This issue remains here so we can eventually deprecate this function when all usages are removed. Until then keep moving it to the next deprecation epic Deprecated function print_textarea() does not display debugging message. Also there are still usages in core: code $ git grep print_textarea lib/adminlib.php: $return = .print_textarea(true, 15, 60, 0, 0, $this->get_full_name(), $data, 0, true, summar lib/form/htmleditor.php: print_textarea(true, mod/feedback/show_nonrespondents.php: print_textarea(true, 15, 25, 30, 10, "message", $message); mod/wiki/editors/html.php: echo $OUTPUT->container(print_textarea(true, 20, 100, 0, 0, "newcontent", $content, 0, true, , form-textarea-advan mod/wiki/editors/wiki_editor.php: echo $OUTPUT->container(print_textarea(false, 20, 60, 0, 0, "newcontent", $content, 0, true), false, wiki_edi user/message.html: code Also see
2.summary: Remove callback delete_course deprecated in 3.2
description: Remove callback delete_course deprecated in 3.1 in
3.summary: Phase 2 of deprecation of functions in lib/deprecatedlib.php initially deprecated in 3.2
description: As per all functions in lib/deprecatedlib.php that were deprecated in 3.2 should be replaced with exceptions in 3.6 This includes all functions in lib/deprecatedlib.php that say since 3.2 _If any functions from this file do not have this comment but also need to be finally deprecated in 3.6- please list them in this issue description_
4.summary: Remove strings deprecated in 3.2
description: Remove strings from language files under the heading "Deprecated since Moodle 3.2" and the respective lines in deprecated.txt files See also
5.summary: Final deprecation of useredit_update_picture
description: Remove useredit_update_picture from user/editlib.php
6.summary: Final deprecation of get_records_csv and put_records_csv.
description: Remove get_records_csv() and put_records_csv from deprecatedlib.php See for the proper process.
7.summary: Remove password_compat skeleton
description: See for further information. A skeleton was included to inform developers that manual skeleton inclusion was no longer necessary. This can now be removed.
8.summary: Remove deprecated apis in behat_config_mananger.php in 3.2
description: While working on ---- lot of static apis were deprecated in behat_config_mananger.php as they are not needed. - get_features_with_tags() - get_components_steps_definitions() - get_config_file_contents() - merge_behat_config() - get_behat_profile() - profile_guided_allocate() - merge_config() - clean_path() - get_behat_tests_path()
9.summary: Remove i_set_the_field_to_multiline deprecated in 3.2
description: Remove i_set_the_field_to_multiline deprecated in 3.2
10.summary: Remove support for message objects as stdClass
description: Remove the debugging message in lib/classes/message/manager.php send_message when event data is passed as a stdClass. Throw a coding exception instead (the logic for the coding exception is there already, so it just needs to be removed from the allowed types. Tip: Look for "" in codebase and youll find a number of places (both and TODO) pointing to places and changes expected.
11.summary: Remove functions from calendar/lib that were deprecated in 3.2
description: In the function calendar_preferences_button(stdClass $course) was deprecated. This issue is to perform final deprecation.
12.summary: Final deprecation of css optimiser and related functions
description: Following
13.summary: Remove behat_transformations::prefixed_tablenode_transformations in 3.6
description: behat_transformations::prefixed_tablenode_transformations() was deprecated in Moodle 3.2 and no longer in use. Please remove in Moodle 3.6
14.summary: Phase 2 (or remove) media stuff deprecated in 3.2 when new media plugin type was introduced
description: Specifically: - remove lib/medialib.php and add it to "standard removed files" - remove class core_media_renderer - core_media_player::is_enabled and core_media_player_link::is_enabled - core_media_player::compare_by_rank
15.summary: Remove old class renames
description: core_component looks for COMPONENT/db/renamedclasses.php files, it allows us to avoid traumatic transitions and BC breakages by listing classes that have been removed. We need to clean the list at some point.
16.summary: Remove behat steps deprecated in 3.2
description: go through lib/tests/behat/behat_deprecated.php and remove steps that were deprecated in Moodle 3.2 please add to the description if you know of any other deprecated behat functionality outside of this file that needs to be removed
17.summary: Remove Assignment upgrade helper from core
description: Its been 5 years now - time to remove this old code.
18.summary: Final deprecation of core_renderer::update_module_button
description: Remove core_renderer::update_module_button which was deprecated in 3.2.
19.summary: Deprecate the htmleditor form element
description: The htmleditor form element (lib/form/htmleditor.php) is not used anywhere in core (instead we use the editor element).
20.summary: Final deprecation of core_course_renderer::add_modchoosertoggle(), deprecated in 3.2
description: core_course_renderer::add_modchoosertoggle() was deprecated for Moodle 3.2 by This is about to remove it for 3.6 completely.
21.summary: Final deprecation of the form element submitlink
description: This was deprecated in 3.2 in .
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Epic: Collect together deprecated and planned code changes for Moodle 4.0
description: In 4.0 we can remove functionality that was deprecated in 3.8 or earlier (see ) There are a number of parts of the Moodle codebase that have been marked as deprecated as a warning to developers not to use these functions as they will be removed in future. Each of these deprecated functions, especially those in Moodle core code, should have an MDL issue associated with it. In order to time the removal of these deprecated functions issues and not lose sight of them, this issue will be used to collect them together.
| Unsolvable | 1.summary: Phase 2 of deprecation of functions in lib/deprecatedlib.php initially deprecated in 3.8
description: As per all functions in lib/deprecatedlib.php that were deprecated in 3.8 should be replaced with exceptions in 4.0 This includes all functions in lib/deprecatedlib.php that say since 3.8 If any functions from this file do not have this comment but also need to be finally deprecated in 4.0 - please list them in this issue description
2.summary: Final deprecation of get_grades() in lib/classes/grades_external.php
description: In get_grades in lib/classes/grades_external.php was deprecated (it landed in 3.2). The final deprecation can be done to completely remove this method.
3.summary: Check pcre.jit php.ini setting state
description: We disabled pcre.git in because of a php bug ( We need to see if there is any progress ( and revert fix + set any alternative they provide.
4.summary: deprecate grade_grade::insert method that just calls its parent
description: Looks like this should of be done ages ago. This method grade_grade.php 1030| just calls grade_object.php 339| So the method grade_object:insert override was done in March 2008 (commit Fixing unit tests for gradebook. Mainly a change in set_locked() arguments. Merging from MOODLE_19_STABLE). And then the only line that made that function different was commented few days later (commit message feedback itself is a type of grading - date graded is now affected by feedback too; merged from MOODLE_19_STABLE). So by the look of things this extra method could be removed ... in March 2008
5.summary: Remove behat steps deprecated in 3.8
description: go through lib/tests/behat/behat_deprecated.php and remove steps that were deprecated in Moodle 3.8 (or earlier) please add to the description if you know of any other deprecated behat functionality outside of this file that needs to be removed
6.summary: Remove deprecated functions in lib/setuplib.php
description: In 3.8 the following methods were deprecated - generate_uuid()
7.summary: Remove strings deprecated in 3.8
description: Remove strings from language files under the heading "Deprecated in Moodle 3.8" and the respective lines in deprecated.txt files See also
8.summary: Remove deprecated subplugins.php files
description: These were deprecated in and can now be safely removed.
9.summary: Final deprecations of forum_count_replies and get_forum_discussion_posts
description: Remove forum_count_replies and get_forum_discussion_posts functions.
10.summary: Remove deprecated functions in messages/classes/api.php
description: In 3.8 the following methods were deprecated - can_post_message() get_individual_conversations_between_users()
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Epic: Collect together deprecated and planned code changes for Moodle 4.0
description: In 4.0 we can remove functionality that was deprecated in 3.8 or earlier (see ) There are a number of parts of the Moodle codebase that have been marked as deprecated as a warning to developers not to use these functions as they will be removed in future. Each of these deprecated functions, especially those in Moodle core code, should have an MDL issue associated with it. In order to time the removal of these deprecated functions issues and not lose sight of them, this issue will be used to collect them together.
### Response:
1.summary: Phase 2 of deprecation of functions in lib/deprecatedlib.php initially deprecated in 3.8
description: As per all functions in lib/deprecatedlib.php that were deprecated in 3.8 should be replaced with exceptions in 4.0 This includes all functions in lib/deprecatedlib.php that say since 3.8 If any functions from this file do not have this comment but also need to be finally deprecated in 4.0 - please list them in this issue description
2.summary: Final deprecation of get_grades() in lib/classes/grades_external.php
description: In get_grades in lib/classes/grades_external.php was deprecated (it landed in 3.2). The final deprecation can be done to completely remove this method.
3.summary: Check pcre.jit php.ini setting state
description: We disabled pcre.git in because of a php bug ( We need to see if there is any progress ( and revert fix + set any alternative they provide.
4.summary: deprecate grade_grade::insert method that just calls its parent
description: Looks like this should of be done ages ago. This method grade_grade.php 1030| just calls grade_object.php 339| So the method grade_object:insert override was done in March 2008 (commit Fixing unit tests for gradebook. Mainly a change in set_locked() arguments. Merging from MOODLE_19_STABLE). And then the only line that made that function different was commented few days later (commit message feedback itself is a type of grading - date graded is now affected by feedback too; merged from MOODLE_19_STABLE). So by the look of things this extra method could be removed ... in March 2008
5.summary: Remove behat steps deprecated in 3.8
description: go through lib/tests/behat/behat_deprecated.php and remove steps that were deprecated in Moodle 3.8 (or earlier) please add to the description if you know of any other deprecated behat functionality outside of this file that needs to be removed
6.summary: Remove deprecated functions in lib/setuplib.php
description: In 3.8 the following methods were deprecated - generate_uuid()
7.summary: Remove strings deprecated in 3.8
description: Remove strings from language files under the heading "Deprecated in Moodle 3.8" and the respective lines in deprecated.txt files See also
8.summary: Remove deprecated subplugins.php files
description: These were deprecated in and can now be safely removed.
9.summary: Final deprecations of forum_count_replies and get_forum_discussion_posts
description: Remove forum_count_replies and get_forum_discussion_posts functions.
10.summary: Remove deprecated functions in messages/classes/api.php
description: In 3.8 the following methods were deprecated - can_post_message() get_individual_conversations_between_users()
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Web service API Roadmap
description: .How to add a web service function into core if you want to suggest or implement a web service function, read the Moodledocs| .Integration priority the ones required for the official Mobile app (generally very few) the ones for which a git patch has been submitted. the most voted ones| the other ones
| Unsolvable | 1.summary: mod_resource_get_resources_by_courses
description: Retrieve a list of resources from several courses
2.summary: New Web Service mod_page_view_page
description: Trigger the module view event and update completion status. This function will be used by the Mobile app in order to allow logging and trigger events when the user navigate the site and courses via the mobile app.
3.summary: New Web Service mod_resource_view_resource
description: Trigger the module view event and update completion status
4.summary: New webservice: mod_url_view_url
description: Trigger the module view event and update completion status
5.summary: New Web Service core_course_search_courses
description: Search courses search by (name, blocklist, modulelist, tagid) params: criterianame criteriavalue page perpage Returns: totalcourses courses(name, shortname, description+attachment, categoryname,categoryid, courseid, teachers, guestaccessenabled ) warnings
6.summary: New Web Service mod_folder_view_folder
description: Trigger the module view event and update completion status. This functions will be used by the Mobile app in order to allow logging and trigger events when the user navigate the site and courses via the mobile app.
7.summary: New Web Service mod_book_view_book
description: Trigger the module view event.
8.summary: New Web Service mod_imscp_view_imscp
description: Trigger the module view event and update completion status
9.summary: New Web Service mod_choice_get_choices_by_courses
description: Retrieve all choices available in a course
10.summary: New Web Service mod_scorm_get_scorms_by_courses
description: Retrieve a list of SCORMs from several courses
11.summary: New Web Service mod_scorm_get_scorm_attempts
description: Parameters: scormid and userid Returns: A list containing information of all the attempts done by the specified user id This will be used to know the current attempt status for the user (last attempt, etc..)
12.summary: New Web Service mod_scorm_get_scorm_scoes
description: Parameters: scormid Returns a list of scoes inside the specified scorm
13.summary: New Web Service mod_scorm_get_scorm_user_data
description: Parameters: scorm, attempt Returns all the user tracks for all the scorm scoes (including objectives and interactions) This will be used for preparing the API runtime data
14.summary: New Web Service mod_scorm_insert_scorm_tracks
description: Parameters:scoid, userid, attempt, array of element, value Inserts track information about a SCO Returns: track id values and warnings
15.summary: core_course_get_course_modules
description: This new external function will return the basic and common module information/settings: - id - course - modname - instance - name - description - groups settings - completion settings - availability settings It will also have an optional "settings" parameter to make the external function return information for just one module, just the modules in a section, return also optional data like the current grade or completion status
16.summary: New Web Service mod_scorm_view_scorm
description: Trigger the module view event (this WS is just for simulating the scorm/view.php page)
17.summary: New Web Service mod_scorm_launch_sco
description: Trigger the \mod_scorm\event\sco_launched event (this WS is just for simulating the scorm/loadSCO.php page so the user interactions are logged in Moodle)
18.summary: New Web Service mod_book_get_books_by_courses
description: Retrieve a list of books from several courses
19.summary: New Web Service mod_chat_get_chats_by_courses
description: Retrieve a list of chats from several courses
20.summary: mod_folder_get_folders_by_courses
description: Retrieve a list of folders from several courses
21.summary: mod_glossary_get_glossaries_by_courses
description: Retrieve a list of glossaries from several courses
22.summary: New Web Service mod_imscp_get_imscps_by_courses
description: Retrieve a list of imscps from several courses
23.summary: mod_label_get_labels_by_courses
description: Retrieve a list of labels from several courses
24.summary: New Web Service mod_lti_get_ltis_by_courses
description: Retrieve a list of ltis from several courses
25.summary: mod_lesson_get_lessons_by_courses
description: Retrieve a list of lessons from several courses
26.summary: mod_page_get_pages_by_courses
description: Retrieve a list of pages from several courses
27.summary: New Web Service mod_quiz_get_quizzes_by_courses
description: Retrieve a list of quizzes from several courses
28.summary: mod_survey_get_surveys_by_courses
description: Retrieve a list of surveys from several courses
29.summary: mod_url_get_urls_by_courses
description: Retrieve a list of urls from several courses
30.summary: mod_wiki_get_wikis_by_courses
description: Retrieve a list of wikis from several courses
31.summary: New Web Service mod_scorm_get_scorm_sco_tracks
description: Wrapper function for: scorm_get_tracks($scoid, $userid, $attempt=) Parameters: $scoid, $userid, $attempt (default 0) Returns, sco track elements for the given user
32.summary: New Web Services for mod_chat
description: mod_chat_login_user Log a user into a chat room in the given chat and return the unique chatsid. This function will be a wrapper for core function chat_login_user and it will be used to log a user in a chat root and get the chatsid for starting sending and receiving messages. mod_chat_get_chat_users Get the list of users in the given chat session. This is a wrapper for the chat_get_users function. mod_chat_send_chat_message Send a message to a chat Wrapper function for chat_send_chatmessage mod_chat_get_chat_latest_messages Retrieve the latest messages starting the given time
33.summary: New Web Service: mod_chat_get_chat_users
description: Get the list of users in the given chat session. This is a wrapper for the chat_get_users function.
34.summary: New Web Service core_completion_mark_course_self_completed
description: This WS will be used for mark a course as self completed by a student
35.summary: Web Services for mod_choice
description: Implement a set of Web Services for the mod_choice: mod_choice_get_choice_options mod_choice_submit_choice_response mod_choice_get_choice_results mod_choice_view_choice This will fix issues: and
36.summary: New Web Service core_group_get_activity_groupmode
description: Implement a wrapper external function for core function: groups_get_activity_groupmode
37.summary: New Web Service core_group_get_activity_allowed_groups
description: New Web Service for retrieving a list of groups that the user is allowed to access within the specified activity. It will be just a wrapper for the group_get_activity_allowed_groups core function
38.summary: New Web Service core_block_get_course_blocks
description: This function will be used to return the course blocks information and optionally the block content rendered
39.summary: New Web Service mod_forum_add_discussion
description: This function will be used for creating new discussions into an existing forum. Parameters: forumid, subject, message, options Response: Same response that get_forum_discussions but only including the discussion created Initially, we wont support attachments or advanced features like "Post to all groups", we wont support "Post to all users" either. (The teacher will have to choose which group to post in case groups are used) We will used a generic parameter "options" for parameters like groups or future functionalities like the ones mentioned above. This will make very easy to maintain the function without further API changes
40.summary: New Web Service mod_forum_add_discussion_post
description: This function will be used for creating new posts into an existing discussion. Parameters: postid (post to reply, the initial discussion or any post within the discussion), subject, message, options Response: Same response that get_forum_posts but only including the post created Initially, we wont support attachments or another advanced features. We will used a generic parameter "options" for parameters like groups or future functionality like the ones mentioned above. This will make very easy to maintain the function without further API changes
41.summary: New Web Service mod_scorm_get_scorm_attempt_count
description: Parameters: scormid userid ignoremissingcompletion (ignores attempts that havent reported a grade/completion) Returns: The number of attempts done by a user in the given SCORM, optionally it can ignore the attempts not completed This will be used to know the current attempt status for the user (last attempt, etc..)
42.summary: New Web Service core_course_get_course_module
description: core_course_get_course_module Returns information about a course module (the user needs to have permission to view the module) parameters: cmid - Course module id returns: Module information (the information returned by get_coursemodule_from_id) including the section number Note: Some private/sensitive information wont be returned if the user does not have the manageactivities capability at module level
43.summary: New Web Service mod_choice_delete_choice_responses
description: Web Service for deleting the responses of a give choice
44.summary: New Web Service enrol_self_enrol_user
description: New Web Service for auto-enrolling users (passing as parameter the course id and optionally a password)
45.summary: New Web Service get_course_module_by_instance
description: Return module information passing the module name and instance id
46.summary: New Web Service mod_lti_view_lti
description: This function will trigger the module view event and call completion API
47.summary: New Web Services for mod_survey
description: New Web Services: mod_survey_get_surveys_by_courses mod_survey_view_survey (events) mod_survey_get_questions mod_survey_submit_answers
48.summary: New Web Services mod_wiki_view_wiki and mod_wiki_view_page
description: This function will trigger the module view event and call completion API.
49.summary: New Web Service mod_wiki_get_subwiki_pages
description: This function will return the list of pages of a certain subwiki.
50.summary: New Web Service core_group_can_access_all_groups
description: Check if the current user can access all groups of a given context level (course or module) and instance id (course id, or cmid). The function will return true if: The course or activity does not use groups The groupmode is VISIBLEGROUPS The user has the moodle/site:accessallgroups capability In some cases, it will good to now if the user can access all groups due to the capability. For example in some modules, like the forum, having that capability make the user able to create discussions for any group. This means that the return parameters would be something like: status - True or False if the user can or cannot access all groups haveaccessallgroupscap - If the user has the capability warnings
51.summary: New Web Service mod_wiki_get_page_contents
description: This WS will return the contents of a wiki page.
52.summary: New Web Service enrol_guest_get_instance_info
description: Return public information about the guest enrolment method settings.
53.summary: New Web Service core_message_delete_message
description: Since 3.0 messages can be deleted in the web interface, wed need a WS to be able to delete messages in the Mobile app too.
54.summary: New Web Service mod_forum_can_add_discussion
description: Check if the user can add discussions in the given forum (and optionally group).
55.summary: New Web Service mod_quiz_view_quiz
description: Trigger the module view event and update completion status. This Web Service is required by external system to be able to log interactions and update the completion status of the module, see for a list of modules currently implementing this Web Service (forum, lti, scorm, imscp, glossary, wiki, etc..) and (policy issue) for the rationale of this approach.
56.summary: New Web Service mod_quiz_get_user_attempts
description: Return quiz attempts information for the given user: Parameteres: quizid userid (default, current user) status (default finished) includepreviews (default false)
57.summary: New web Services for checking access requirements to quizzes and attempts
description: -This function returns general access information, is basically a wrapper of the access manager class that returns some capabilities information too.- Information returned will be: canmanage canattempt canreviewmine canpreview canviewreports canreviewmyattempts endtime isfinished ispreflightcheckrequired accessrules preventaccessreasons preventnewattemptreasons -This web service also returns the question types used in the quiz, including the potential ones (in case random questions are used).- -This is necessary because well need to check the question types before starting a new attempt to determine if the quiz can be open in the app (initially the app wont support all question types or contrib add-ons)- Please, note that we finally decided to split in 3 functions: mod_quiz_get_quiz_access_information mod_quiz_get_attempt_access_information mod_quiz_get_quiz_required_qtypes
58.summary: New Web Service mod_quiz_get_user_best_grade
description: Get the best current grade for the given user in a quiz.
59.summary: New Web Service mod_quiz_get_combined_review_options
description: Combines the review options from a number of different quiz attempts.
60.summary: New Web Service mod_quiz_start_attempt
description: Starts a new attempt at a quiz. Parameters: quizid forcenew - to force a new attempt in review mode Returns: attempt id attempt unique id attempt number page (in cases like last attempt page)
61.summary: New Web Service mod_wiki_get_subwikis
description: This WebService will return the list of subwikis a user can view in a certain wiki. It will return all the possible subwikis, not only the ones created in database. This WS is similar to the creation of the dropdown in Moodle web to pick which subwiki you want to edit.
62.summary: New Web Service mod_quiz_get_attempt_data
description: Returns information for the given attempt page for a quiz attempt in progress Parameters: - attemptid - pageid - preflightdata (optional) We need this because we don have a session object persistent between Web Service requests Returns: - Attempt object (with the attempt information) - Next page number - A list of access messages - A list of questions rendered
63.summary: New Web Service mod_quiz_get_attempt_summary
description: Returns a summary of a quiz attempt before it is submitted. parameters attemptid : The attempt id preflightdata: Like the quiz password returns: list of questions with: question number (the sequencial number) state (integer, the state id) status (string associated with the state) flagged (whether the question is flagged or not) mark (optional, this depends on the quiz mode-behaviour)
64.summary: New Web Service mod_quiz_save_attempt
description: Processes save requests during the quiz. This function is intended for the quiz auto-save feature. Parameters: attemptid data (the post data to be saved) Returns: status: true on success
65.summary: New Web Service mod_quiz_process_attempt
description: Process responses during an attempt at a quiz Parameters: attemptid - The attempt id finishattempt - Whether to finish or not the attempt timeup - Whether the WS was called by a timer data - the data to be processed, post format Returns: state - the quiz attempt state after the processing: quiz_attempt::IN_PROGRESS, quiz_attempt::OVERDUE, quiz_attempt::FINISHED, quiz_attempt::ABANDONED
66.summary: New Web Service mod_quiz_get_attempt_review
description: Returns review information for the given attempt, can be used by users or teaches parameters attemptid - the attempt id page - return information only for questions in this page (optional, leave empty for all the questions in all the pages) returns attempt - the complete attempt data additionaldata - additional data from the behaviour and the feedback questions list of: slot - slot number html - question rendered
67.summary: New web services for triggering events in mod_quiz
description: mod_quiz_view_attempt (attemptid, page) To trigger the attempt viewed event and to set the current page in the attempt. mod_quiz_view_attempt_summary (attempt) To trigger the attempt summary viewed event. mod_quiz_view_attempt_review (attempt) To trigger the attempt reviewed event. All returning a status field
68.summary: New Web Service mod_assign_get_submission_status
description: Given an attemptid and userid this web service returns the following information: - Grading summary (if the user has permissions) - Submission status - Feedback received - Previous attempts information This function return all the information that is displayed in the submission view page in Moodle for a user.
69.summary: New Web Service mod_assign_view_submission_status
description: Web Service to trigger the submission viewed event
70.summary: New Web Service mod_quiz_get_quiz_feedback_for_grade
description: Get the feedback text that should be show to a student who got the given grade in the given quiz. Parameters: quizid - Int, the quiz instance id grade - Float, the grade
71.summary: New Web Service core_badges_get_user_badges
description: This Web Service will be used for returning the list of badges awarded to a given user
72.summary: New Web Service mod_wiki_get_subwiki_files
description: This function will return the list of files in a subwiki, similar to what the option "Files" in Moodle web does.
73.summary: New Web Service gradereport_overview_get_course_grades
description: Retrieve the courses final grades for the given user. It will match the current "Grades" option in the user profile menu. Please, note that this WS does not cover all the functionalities from the user/overview/report, this WS is designed to return the course final grades in all the courses where he is enrolled, it can be used by admin/managers to retrieve other users final grades though. Information like numusers is not returned because is always 0 in the site context (this is not a bug, is how is designed the overview report)
74.summary: New Web Service tool_mobile_get_site_public_settings
description: New Web Service not requiring a session and published via AJAX that must return this information: siteurl sitename guestloginbutton rememberusername authloginviaemail registerauth wwwroot forgottenpasswordurl authinstructions isenabledauthnone enablewebservices enablemobilewebservice maintenance_enabled This will help us to: Obtain information (like the site name) just knowing the URL Check if the site has self-registration enabled Obtain the valid siteurl and for authentication (right now we have to guess it testing and then error prone) Check if mobile services are enabled (without having to check it doing a request to login/token.php)
75.summary: New Web Service tool_mobile_get_config
description: we need a new Web Service for retrieving site settings required by the app, for example, the frontpage settings to be able to display a Site Home similar to Moodle one (or for fixing issues like ). The idea is to not overload the existing core_get_site_info web service with tons of new settings and use this new WS specific for mobile instead. This WS must include some filtering, like filtering for "setting sections" in that way you can retrieve only the settings you need at any moment. For Moodle Mobile 3.2 well be using this WS for retrieving the frontpage settings, so we can build a front page in the app that is similar to the web version one.
76.summary: New Web Service core_course_get_activities_overview
description: Retrieve the modules overview (my courses page)
77.summary: New Web Service core_course_get_courses_by_field
description: This new WS is intended to be a replacement of the current core_course_get_courses, reasons are: core_course_get_courses only works for courses where the user have the course:view capability on Users should be able to view the basic course information (id, fullname,...) even if they are not enrolled in a course (but only if the course is visible). Returned data is missing some key information, like the enrolment methods enabled in the course, the "public visible teachers", filters enabled, etc.. It doesnt handle nicely exception/warnings (the whole WS fails if you requested a course where you dont have permissions)
78.summary: New Web Service mod_assign_view_assign
description: This Web Service is just for launching $completion->set_module_viewed
79.summary: New Web Service core_user_get_user_preferences
description: It will return the user Moodle preferences Parameters: name - Preference name, optional, default to retrieve all preferences userid - The user to retrieve the preferences from, optional, default to current user
80.summary: New Web Service core_user_set_users_preferences
description: Given an array of: preference name preference value user (optional) This WS will set the preferences
81.summary: New Web Service core_message_get_user_notification_preferences
description: To be developed once is finished This is the Web Service for retrieving the current user messaging preferences
82.summary: New Web Services for retrieving navigation and administration options available
description: After discussing it much (with Dani and Eloy) we think that the new WS names should be: core_course_get_user_administration_options($courseids) core_course_get_user_navigation_options($courseids) The new APIs at course/lib.php will be: course_get_user_administration_options($context) course_get_user_navigation_options($context) Why we need this new WS? Because in the Mobile app we dont have currently a way to know wich options in a course (administration or navigation level) are available for a user. The only way to know if something is available for a user is doing a pre-fetch call to the WS and check if is returning errors or not (for example, retrieve the list of participants, the user grade book, the user notes) etc.. This is causing serious performance and data consumption issues in the app when the user is enrolled in several courses, for 12 courses we are doing like 70 WS calls that we will be able to save with this new web services Required core changes Well be refactoring the navigationlib to use this new functions to avoid code duplication (it will be basically moving $CFG and capabilities check to those functions)
83.summary: New Web Service mod_glossary_add_entry
description: Web Services for adding new entries in a glossary. Parameters: glossaryid, concept, definition, options (for all the optional settings and possible attachments) Ill be following the same patterns applied when mod_forum_add_post was implemented, so this type of functions are consistent
84.summary: New Web Service core_rating_add_rating
description: New Web Service for adding rates to a Moodle item (like a forum post) The code should be very close to the current AJAX interface for rating (we should move it to a locallib or something like that)
85.summary: New Web Service gradereport_user_get_grade_items
description: This new Web Service will be a good replacement for core_grades_get_grades, basically, it will allow a user or manager (teacher/admin) to retrieve all the grate items from the course gradebook: - Grades - Outcomes - Manual - Categories among with feedback, rank, range etc.. Including the final course grade and aggregations. We have to base the new WS on the user report code because is the only one taking care of advanced gradebook features like hiding affected grades, adjust bounds, etc.. A first view of the user grader report reflects its complexity, the more sensible approach (under my opinion) would be not to touch any single line of code and just add a new data structure (rawgradeitemdata) that will be filled in the recursive process of building the grades table. (Basically, in the fill_table_recursive function). At the end, the report class will generate two data structures: tabledata ready for printing the table and the rawgradeitemdata, with a representation of the gradebook ready to be used by external functions. The ideal thing would be to split the code into one function generating a templatable/renderable and then another one for build the table, but looking at the actual code this will be very complex, will require a lot of code duplication and Im afraid of possible regressions.
86.summary: New Web Service core_search_get_search_areas_list
description: Returns the list of existing search areas
87.summary: New Web Service message_airnotifier_get_user_devices
description: Return the list of mobile devices that are registered in Moodle for the given user.
88.summary: New Web Service message_airnotifier_enable_device
description: Enable or disable a mobile device registered in Moodle for the user
89.summary: New Web Service core_user_update_picture
description: Updates or deletes the user picture
90.summary: New Web Service core_course_check_updates
description: Check if a module has been updated since the given timestamp. Parameters: - array of cmid and timestamp Returns: - array of the type of elements that were updated: configuration, files, posts (for forum), pages (for wiki), entries (for glossary), etc.. This wont return the element ids of additional information, just a boolean indicating if something was updated since the given time. Why do we need this information: The mobile app allows to download both resources and activities for offline access/usage. Right now, for calculating if a resource or activity needs update (so we can show a button to allow the user to update the downloaded module) we must perform several "heavy" web services requests. This is because we need to retrieve the module information and associated files and data to compare with the local information stored and see if something was updated. For example: For a quiz we must retrieve the quiz attempts to see if there is a new attempt. For forums, we must download discussions/posts. For assignment, we need to download the recent submissions to check if there is any change. For a normal course we could end up doing lots of requests to display the modules needing update. This is the reason wed need a simple Web Service able to return some basic information about the modules status since a given date. This Web Service will receive a list of cmids and timestamps and well ask every module type to calculate if there has been any update affecting the user since the given time. Please, note that we must specify a different timestamp for each module, because maybe the user updated manually some modules of the course but not all of them. These changes can help us also to "mark/display" in the app the modules with updates since the last visit of the user. So basically with these changes we will be able to: Check if the already downloaded modules (if any) needs to be updated. Every time the user open a course, check for updates to display using badges (red filled circles with a number inside) Implementation This WS will do multiple request for retrieve all the required information for all the modules, but this will have a lower performance impact that the current requests we are doing (right now to calculate the status we perform multiple request) so this will be a performance improvement for both sites using 3.2 and the app. Another implementation approach could have been implement an event observer in a plugin and store the update information in a new database table. Or not an event observer and using direct calls (a new subsystem) or whatever available in lib/ so any component or plugin could report updates. I think that this is the simplest way, and right now it will reduce the amount of request that the app needs to do.
91.summary: New Web Service mod_chat_get_past_sessions
description: Web Service for retrieve the chat past sessions where the user participated
92.summary: New Web Service core_message_get_user_message_preferences
description: In 3.2 the messaging preferences have been split in: Notification preferences Message preferences We already implemented a WS to retrieve notification preferences in but we didnt notice that we were missing the "Message" ones because of the split. Wed need this new WS in order to enabling changing these preferences from the mobile app (it make totally sense to be able to configure what type of notifications you want to receive in Mobile)
93.summary: New Web Services for retrieving chat sessions
description: To retrieve chat past sessions wed need two web services: - mod_chat_get_sessions: To list all the chat sessions for the given chat - mod_chat_get_session_messages: To get the chat messages from one chat session
94.summary: New Web Service core_course_get_updates_since
description: In order to re-use the current check_updates API at module level, we could create a new function for retrieving all the course updates since a given date. Right now, there is a core_course_check_updates function but checks module by module (not the whole course) Parameters would be: courseid since - Check updates since this time stamp filter- Check only for updates in the given areas
95.summary: New Web Service core_user_get_private_files_info
description: We need a WS that will return the remaining user quota in the private files are for the current user.
96.summary: New Web Service core_auth_request_password_reset
description: Public Web Service (via XHR) to allow users to request a password reset using the mobile app.
97.summary: New Web Service core_blog_get_entries
description: New Web Service for retrieving blog entries
98.summary: New Web Service core_blog_view_entries
description: We need a new WS for triggering the blog_entries_viewed event
99.summary: New Web Service mod_glossary_update_entry
description: Ws for updating entries
100.summary: New WebService mod_scorm_get_scorm_access_information
description: We need this WebService to return the capabilities affecting the current user in order to calculate if the user is able to see some information controlled by capabilities (a particular case is the score information). See for more information.
101.summary: New Web Services for updating a forum post (or a discussion topic post)
description: Create a new set of functions for being able to update discussion posts. It will require some additional helper WS function to set/prepare the draft attachment and editors. Web services to be created are: mod_forum_get_discussion_post - To obtain particular information about a post and specifically if the user is able to update ir or not mod_forum_prepare_draft_area_for_post - To prepare the draft areas for a post that it is going to be updated including the files to be kept in the draft area when editing a post mod_forum_update_discussion_post - To update a post
102.summary: New web services for adding and deleting comments
description: New Web Service for adding and deleting comments in any commenting area.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Web service API Roadmap
description: .How to add a web service function into core if you want to suggest or implement a web service function, read the Moodledocs| .Integration priority the ones required for the official Mobile app (generally very few) the ones for which a git patch has been submitted. the most voted ones| the other ones
### Response:
1.summary: mod_resource_get_resources_by_courses
description: Retrieve a list of resources from several courses
2.summary: New Web Service mod_page_view_page
description: Trigger the module view event and update completion status. This function will be used by the Mobile app in order to allow logging and trigger events when the user navigate the site and courses via the mobile app.
3.summary: New Web Service mod_resource_view_resource
description: Trigger the module view event and update completion status
4.summary: New webservice: mod_url_view_url
description: Trigger the module view event and update completion status
5.summary: New Web Service core_course_search_courses
description: Search courses search by (name, blocklist, modulelist, tagid) params: criterianame criteriavalue page perpage Returns: totalcourses courses(name, shortname, description+attachment, categoryname,categoryid, courseid, teachers, guestaccessenabled ) warnings
6.summary: New Web Service mod_folder_view_folder
description: Trigger the module view event and update completion status. This functions will be used by the Mobile app in order to allow logging and trigger events when the user navigate the site and courses via the mobile app.
7.summary: New Web Service mod_book_view_book
description: Trigger the module view event.
8.summary: New Web Service mod_imscp_view_imscp
description: Trigger the module view event and update completion status
9.summary: New Web Service mod_choice_get_choices_by_courses
description: Retrieve all choices available in a course
10.summary: New Web Service mod_scorm_get_scorms_by_courses
description: Retrieve a list of SCORMs from several courses
11.summary: New Web Service mod_scorm_get_scorm_attempts
description: Parameters: scormid and userid Returns: A list containing information of all the attempts done by the specified user id This will be used to know the current attempt status for the user (last attempt, etc..)
12.summary: New Web Service mod_scorm_get_scorm_scoes
description: Parameters: scormid Returns a list of scoes inside the specified scorm
13.summary: New Web Service mod_scorm_get_scorm_user_data
description: Parameters: scorm, attempt Returns all the user tracks for all the scorm scoes (including objectives and interactions) This will be used for preparing the API runtime data
14.summary: New Web Service mod_scorm_insert_scorm_tracks
description: Parameters:scoid, userid, attempt, array of element, value Inserts track information about a SCO Returns: track id values and warnings
15.summary: core_course_get_course_modules
description: This new external function will return the basic and common module information/settings: - id - course - modname - instance - name - description - groups settings - completion settings - availability settings It will also have an optional "settings" parameter to make the external function return information for just one module, just the modules in a section, return also optional data like the current grade or completion status
16.summary: New Web Service mod_scorm_view_scorm
description: Trigger the module view event (this WS is just for simulating the scorm/view.php page)
17.summary: New Web Service mod_scorm_launch_sco
description: Trigger the \mod_scorm\event\sco_launched event (this WS is just for simulating the scorm/loadSCO.php page so the user interactions are logged in Moodle)
18.summary: New Web Service mod_book_get_books_by_courses
description: Retrieve a list of books from several courses
19.summary: New Web Service mod_chat_get_chats_by_courses
description: Retrieve a list of chats from several courses
20.summary: mod_folder_get_folders_by_courses
description: Retrieve a list of folders from several courses
21.summary: mod_glossary_get_glossaries_by_courses
description: Retrieve a list of glossaries from several courses
22.summary: New Web Service mod_imscp_get_imscps_by_courses
description: Retrieve a list of imscps from several courses
23.summary: mod_label_get_labels_by_courses
description: Retrieve a list of labels from several courses
24.summary: New Web Service mod_lti_get_ltis_by_courses
description: Retrieve a list of ltis from several courses
25.summary: mod_lesson_get_lessons_by_courses
description: Retrieve a list of lessons from several courses
26.summary: mod_page_get_pages_by_courses
description: Retrieve a list of pages from several courses
27.summary: New Web Service mod_quiz_get_quizzes_by_courses
description: Retrieve a list of quizzes from several courses
28.summary: mod_survey_get_surveys_by_courses
description: Retrieve a list of surveys from several courses
29.summary: mod_url_get_urls_by_courses
description: Retrieve a list of urls from several courses
30.summary: mod_wiki_get_wikis_by_courses
description: Retrieve a list of wikis from several courses
31.summary: New Web Service mod_scorm_get_scorm_sco_tracks
description: Wrapper function for: scorm_get_tracks($scoid, $userid, $attempt=) Parameters: $scoid, $userid, $attempt (default 0) Returns, sco track elements for the given user
32.summary: New Web Services for mod_chat
description: mod_chat_login_user Log a user into a chat room in the given chat and return the unique chatsid. This function will be a wrapper for core function chat_login_user and it will be used to log a user in a chat root and get the chatsid for starting sending and receiving messages. mod_chat_get_chat_users Get the list of users in the given chat session. This is a wrapper for the chat_get_users function. mod_chat_send_chat_message Send a message to a chat Wrapper function for chat_send_chatmessage mod_chat_get_chat_latest_messages Retrieve the latest messages starting the given time
33.summary: New Web Service: mod_chat_get_chat_users
description: Get the list of users in the given chat session. This is a wrapper for the chat_get_users function.
34.summary: New Web Service core_completion_mark_course_self_completed
description: This WS will be used for mark a course as self completed by a student
35.summary: Web Services for mod_choice
description: Implement a set of Web Services for the mod_choice: mod_choice_get_choice_options mod_choice_submit_choice_response mod_choice_get_choice_results mod_choice_view_choice This will fix issues: and
36.summary: New Web Service core_group_get_activity_groupmode
description: Implement a wrapper external function for core function: groups_get_activity_groupmode
37.summary: New Web Service core_group_get_activity_allowed_groups
description: New Web Service for retrieving a list of groups that the user is allowed to access within the specified activity. It will be just a wrapper for the group_get_activity_allowed_groups core function
38.summary: New Web Service core_block_get_course_blocks
description: This function will be used to return the course blocks information and optionally the block content rendered
39.summary: New Web Service mod_forum_add_discussion
description: This function will be used for creating new discussions into an existing forum. Parameters: forumid, subject, message, options Response: Same response that get_forum_discussions but only including the discussion created Initially, we wont support attachments or advanced features like "Post to all groups", we wont support "Post to all users" either. (The teacher will have to choose which group to post in case groups are used) We will used a generic parameter "options" for parameters like groups or future functionalities like the ones mentioned above. This will make very easy to maintain the function without further API changes
40.summary: New Web Service mod_forum_add_discussion_post
description: This function will be used for creating new posts into an existing discussion. Parameters: postid (post to reply, the initial discussion or any post within the discussion), subject, message, options Response: Same response that get_forum_posts but only including the post created Initially, we wont support attachments or another advanced features. We will used a generic parameter "options" for parameters like groups or future functionality like the ones mentioned above. This will make very easy to maintain the function without further API changes
41.summary: New Web Service mod_scorm_get_scorm_attempt_count
description: Parameters: scormid userid ignoremissingcompletion (ignores attempts that havent reported a grade/completion) Returns: The number of attempts done by a user in the given SCORM, optionally it can ignore the attempts not completed This will be used to know the current attempt status for the user (last attempt, etc..)
42.summary: New Web Service core_course_get_course_module
description: core_course_get_course_module Returns information about a course module (the user needs to have permission to view the module) parameters: cmid - Course module id returns: Module information (the information returned by get_coursemodule_from_id) including the section number Note: Some private/sensitive information wont be returned if the user does not have the manageactivities capability at module level
43.summary: New Web Service mod_choice_delete_choice_responses
description: Web Service for deleting the responses of a give choice
44.summary: New Web Service enrol_self_enrol_user
description: New Web Service for auto-enrolling users (passing as parameter the course id and optionally a password)
45.summary: New Web Service get_course_module_by_instance
description: Return module information passing the module name and instance id
46.summary: New Web Service mod_lti_view_lti
description: This function will trigger the module view event and call completion API
47.summary: New Web Services for mod_survey
description: New Web Services: mod_survey_get_surveys_by_courses mod_survey_view_survey (events) mod_survey_get_questions mod_survey_submit_answers
48.summary: New Web Services mod_wiki_view_wiki and mod_wiki_view_page
description: This function will trigger the module view event and call completion API.
49.summary: New Web Service mod_wiki_get_subwiki_pages
description: This function will return the list of pages of a certain subwiki.
50.summary: New Web Service core_group_can_access_all_groups
description: Check if the current user can access all groups of a given context level (course or module) and instance id (course id, or cmid). The function will return true if: The course or activity does not use groups The groupmode is VISIBLEGROUPS The user has the moodle/site:accessallgroups capability In some cases, it will good to now if the user can access all groups due to the capability. For example in some modules, like the forum, having that capability make the user able to create discussions for any group. This means that the return parameters would be something like: status - True or False if the user can or cannot access all groups haveaccessallgroupscap - If the user has the capability warnings
51.summary: New Web Service mod_wiki_get_page_contents
description: This WS will return the contents of a wiki page.
52.summary: New Web Service enrol_guest_get_instance_info
description: Return public information about the guest enrolment method settings.
53.summary: New Web Service core_message_delete_message
description: Since 3.0 messages can be deleted in the web interface, wed need a WS to be able to delete messages in the Mobile app too.
54.summary: New Web Service mod_forum_can_add_discussion
description: Check if the user can add discussions in the given forum (and optionally group).
55.summary: New Web Service mod_quiz_view_quiz
description: Trigger the module view event and update completion status. This Web Service is required by external system to be able to log interactions and update the completion status of the module, see for a list of modules currently implementing this Web Service (forum, lti, scorm, imscp, glossary, wiki, etc..) and (policy issue) for the rationale of this approach.
56.summary: New Web Service mod_quiz_get_user_attempts
description: Return quiz attempts information for the given user: Parameteres: quizid userid (default, current user) status (default finished) includepreviews (default false)
57.summary: New web Services for checking access requirements to quizzes and attempts
description: -This function returns general access information, is basically a wrapper of the access manager class that returns some capabilities information too.- Information returned will be: canmanage canattempt canreviewmine canpreview canviewreports canreviewmyattempts endtime isfinished ispreflightcheckrequired accessrules preventaccessreasons preventnewattemptreasons -This web service also returns the question types used in the quiz, including the potential ones (in case random questions are used).- -This is necessary because well need to check the question types before starting a new attempt to determine if the quiz can be open in the app (initially the app wont support all question types or contrib add-ons)- Please, note that we finally decided to split in 3 functions: mod_quiz_get_quiz_access_information mod_quiz_get_attempt_access_information mod_quiz_get_quiz_required_qtypes
58.summary: New Web Service mod_quiz_get_user_best_grade
description: Get the best current grade for the given user in a quiz.
59.summary: New Web Service mod_quiz_get_combined_review_options
description: Combines the review options from a number of different quiz attempts.
60.summary: New Web Service mod_quiz_start_attempt
description: Starts a new attempt at a quiz. Parameters: quizid forcenew - to force a new attempt in review mode Returns: attempt id attempt unique id attempt number page (in cases like last attempt page)
61.summary: New Web Service mod_wiki_get_subwikis
description: This WebService will return the list of subwikis a user can view in a certain wiki. It will return all the possible subwikis, not only the ones created in database. This WS is similar to the creation of the dropdown in Moodle web to pick which subwiki you want to edit.
62.summary: New Web Service mod_quiz_get_attempt_data
description: Returns information for the given attempt page for a quiz attempt in progress Parameters: - attemptid - pageid - preflightdata (optional) We need this because we don have a session object persistent between Web Service requests Returns: - Attempt object (with the attempt information) - Next page number - A list of access messages - A list of questions rendered
63.summary: New Web Service mod_quiz_get_attempt_summary
description: Returns a summary of a quiz attempt before it is submitted. parameters attemptid : The attempt id preflightdata: Like the quiz password returns: list of questions with: question number (the sequencial number) state (integer, the state id) status (string associated with the state) flagged (whether the question is flagged or not) mark (optional, this depends on the quiz mode-behaviour)
64.summary: New Web Service mod_quiz_save_attempt
description: Processes save requests during the quiz. This function is intended for the quiz auto-save feature. Parameters: attemptid data (the post data to be saved) Returns: status: true on success
65.summary: New Web Service mod_quiz_process_attempt
description: Process responses during an attempt at a quiz Parameters: attemptid - The attempt id finishattempt - Whether to finish or not the attempt timeup - Whether the WS was called by a timer data - the data to be processed, post format Returns: state - the quiz attempt state after the processing: quiz_attempt::IN_PROGRESS, quiz_attempt::OVERDUE, quiz_attempt::FINISHED, quiz_attempt::ABANDONED
66.summary: New Web Service mod_quiz_get_attempt_review
description: Returns review information for the given attempt, can be used by users or teaches parameters attemptid - the attempt id page - return information only for questions in this page (optional, leave empty for all the questions in all the pages) returns attempt - the complete attempt data additionaldata - additional data from the behaviour and the feedback questions list of: slot - slot number html - question rendered
67.summary: New web services for triggering events in mod_quiz
description: mod_quiz_view_attempt (attemptid, page) To trigger the attempt viewed event and to set the current page in the attempt. mod_quiz_view_attempt_summary (attempt) To trigger the attempt summary viewed event. mod_quiz_view_attempt_review (attempt) To trigger the attempt reviewed event. All returning a status field
68.summary: New Web Service mod_assign_get_submission_status
description: Given an attemptid and userid this web service returns the following information: - Grading summary (if the user has permissions) - Submission status - Feedback received - Previous attempts information This function return all the information that is displayed in the submission view page in Moodle for a user.
69.summary: New Web Service mod_assign_view_submission_status
description: Web Service to trigger the submission viewed event
70.summary: New Web Service mod_quiz_get_quiz_feedback_for_grade
description: Get the feedback text that should be show to a student who got the given grade in the given quiz. Parameters: quizid - Int, the quiz instance id grade - Float, the grade
71.summary: New Web Service core_badges_get_user_badges
description: This Web Service will be used for returning the list of badges awarded to a given user
72.summary: New Web Service mod_wiki_get_subwiki_files
description: This function will return the list of files in a subwiki, similar to what the option "Files" in Moodle web does.
73.summary: New Web Service gradereport_overview_get_course_grades
description: Retrieve the courses final grades for the given user. It will match the current "Grades" option in the user profile menu. Please, note that this WS does not cover all the functionalities from the user/overview/report, this WS is designed to return the course final grades in all the courses where he is enrolled, it can be used by admin/managers to retrieve other users final grades though. Information like numusers is not returned because is always 0 in the site context (this is not a bug, is how is designed the overview report)
74.summary: New Web Service tool_mobile_get_site_public_settings
description: New Web Service not requiring a session and published via AJAX that must return this information: siteurl sitename guestloginbutton rememberusername authloginviaemail registerauth wwwroot forgottenpasswordurl authinstructions isenabledauthnone enablewebservices enablemobilewebservice maintenance_enabled This will help us to: Obtain information (like the site name) just knowing the URL Check if the site has self-registration enabled Obtain the valid siteurl and for authentication (right now we have to guess it testing and then error prone) Check if mobile services are enabled (without having to check it doing a request to login/token.php)
75.summary: New Web Service tool_mobile_get_config
description: we need a new Web Service for retrieving site settings required by the app, for example, the frontpage settings to be able to display a Site Home similar to Moodle one (or for fixing issues like ). The idea is to not overload the existing core_get_site_info web service with tons of new settings and use this new WS specific for mobile instead. This WS must include some filtering, like filtering for "setting sections" in that way you can retrieve only the settings you need at any moment. For Moodle Mobile 3.2 well be using this WS for retrieving the frontpage settings, so we can build a front page in the app that is similar to the web version one.
76.summary: New Web Service core_course_get_activities_overview
description: Retrieve the modules overview (my courses page)
77.summary: New Web Service core_course_get_courses_by_field
description: This new WS is intended to be a replacement of the current core_course_get_courses, reasons are: core_course_get_courses only works for courses where the user have the course:view capability on Users should be able to view the basic course information (id, fullname,...) even if they are not enrolled in a course (but only if the course is visible). Returned data is missing some key information, like the enrolment methods enabled in the course, the "public visible teachers", filters enabled, etc.. It doesnt handle nicely exception/warnings (the whole WS fails if you requested a course where you dont have permissions)
78.summary: New Web Service mod_assign_view_assign
description: This Web Service is just for launching $completion->set_module_viewed
79.summary: New Web Service core_user_get_user_preferences
description: It will return the user Moodle preferences Parameters: name - Preference name, optional, default to retrieve all preferences userid - The user to retrieve the preferences from, optional, default to current user
80.summary: New Web Service core_user_set_users_preferences
description: Given an array of: preference name preference value user (optional) This WS will set the preferences
81.summary: New Web Service core_message_get_user_notification_preferences
description: To be developed once is finished This is the Web Service for retrieving the current user messaging preferences
82.summary: New Web Services for retrieving navigation and administration options available
description: After discussing it much (with Dani and Eloy) we think that the new WS names should be: core_course_get_user_administration_options($courseids) core_course_get_user_navigation_options($courseids) The new APIs at course/lib.php will be: course_get_user_administration_options($context) course_get_user_navigation_options($context) Why we need this new WS? Because in the Mobile app we dont have currently a way to know wich options in a course (administration or navigation level) are available for a user. The only way to know if something is available for a user is doing a pre-fetch call to the WS and check if is returning errors or not (for example, retrieve the list of participants, the user grade book, the user notes) etc.. This is causing serious performance and data consumption issues in the app when the user is enrolled in several courses, for 12 courses we are doing like 70 WS calls that we will be able to save with this new web services Required core changes Well be refactoring the navigationlib to use this new functions to avoid code duplication (it will be basically moving $CFG and capabilities check to those functions)
83.summary: New Web Service mod_glossary_add_entry
description: Web Services for adding new entries in a glossary. Parameters: glossaryid, concept, definition, options (for all the optional settings and possible attachments) Ill be following the same patterns applied when mod_forum_add_post was implemented, so this type of functions are consistent
84.summary: New Web Service core_rating_add_rating
description: New Web Service for adding rates to a Moodle item (like a forum post) The code should be very close to the current AJAX interface for rating (we should move it to a locallib or something like that)
85.summary: New Web Service gradereport_user_get_grade_items
description: This new Web Service will be a good replacement for core_grades_get_grades, basically, it will allow a user or manager (teacher/admin) to retrieve all the grate items from the course gradebook: - Grades - Outcomes - Manual - Categories among with feedback, rank, range etc.. Including the final course grade and aggregations. We have to base the new WS on the user report code because is the only one taking care of advanced gradebook features like hiding affected grades, adjust bounds, etc.. A first view of the user grader report reflects its complexity, the more sensible approach (under my opinion) would be not to touch any single line of code and just add a new data structure (rawgradeitemdata) that will be filled in the recursive process of building the grades table. (Basically, in the fill_table_recursive function). At the end, the report class will generate two data structures: tabledata ready for printing the table and the rawgradeitemdata, with a representation of the gradebook ready to be used by external functions. The ideal thing would be to split the code into one function generating a templatable/renderable and then another one for build the table, but looking at the actual code this will be very complex, will require a lot of code duplication and Im afraid of possible regressions.
86.summary: New Web Service core_search_get_search_areas_list
description: Returns the list of existing search areas
87.summary: New Web Service message_airnotifier_get_user_devices
description: Return the list of mobile devices that are registered in Moodle for the given user.
88.summary: New Web Service message_airnotifier_enable_device
description: Enable or disable a mobile device registered in Moodle for the user
89.summary: New Web Service core_user_update_picture
description: Updates or deletes the user picture
90.summary: New Web Service core_course_check_updates
description: Check if a module has been updated since the given timestamp. Parameters: - array of cmid and timestamp Returns: - array of the type of elements that were updated: configuration, files, posts (for forum), pages (for wiki), entries (for glossary), etc.. This wont return the element ids of additional information, just a boolean indicating if something was updated since the given time. Why do we need this information: The mobile app allows to download both resources and activities for offline access/usage. Right now, for calculating if a resource or activity needs update (so we can show a button to allow the user to update the downloaded module) we must perform several "heavy" web services requests. This is because we need to retrieve the module information and associated files and data to compare with the local information stored and see if something was updated. For example: For a quiz we must retrieve the quiz attempts to see if there is a new attempt. For forums, we must download discussions/posts. For assignment, we need to download the recent submissions to check if there is any change. For a normal course we could end up doing lots of requests to display the modules needing update. This is the reason wed need a simple Web Service able to return some basic information about the modules status since a given date. This Web Service will receive a list of cmids and timestamps and well ask every module type to calculate if there has been any update affecting the user since the given time. Please, note that we must specify a different timestamp for each module, because maybe the user updated manually some modules of the course but not all of them. These changes can help us also to "mark/display" in the app the modules with updates since the last visit of the user. So basically with these changes we will be able to: Check if the already downloaded modules (if any) needs to be updated. Every time the user open a course, check for updates to display using badges (red filled circles with a number inside) Implementation This WS will do multiple request for retrieve all the required information for all the modules, but this will have a lower performance impact that the current requests we are doing (right now to calculate the status we perform multiple request) so this will be a performance improvement for both sites using 3.2 and the app. Another implementation approach could have been implement an event observer in a plugin and store the update information in a new database table. Or not an event observer and using direct calls (a new subsystem) or whatever available in lib/ so any component or plugin could report updates. I think that this is the simplest way, and right now it will reduce the amount of request that the app needs to do.
91.summary: New Web Service mod_chat_get_past_sessions
description: Web Service for retrieve the chat past sessions where the user participated
92.summary: New Web Service core_message_get_user_message_preferences
description: In 3.2 the messaging preferences have been split in: Notification preferences Message preferences We already implemented a WS to retrieve notification preferences in but we didnt notice that we were missing the "Message" ones because of the split. Wed need this new WS in order to enabling changing these preferences from the mobile app (it make totally sense to be able to configure what type of notifications you want to receive in Mobile)
93.summary: New Web Services for retrieving chat sessions
description: To retrieve chat past sessions wed need two web services: - mod_chat_get_sessions: To list all the chat sessions for the given chat - mod_chat_get_session_messages: To get the chat messages from one chat session
94.summary: New Web Service core_course_get_updates_since
description: In order to re-use the current check_updates API at module level, we could create a new function for retrieving all the course updates since a given date. Right now, there is a core_course_check_updates function but checks module by module (not the whole course) Parameters would be: courseid since - Check updates since this time stamp filter- Check only for updates in the given areas
95.summary: New Web Service core_user_get_private_files_info
description: We need a WS that will return the remaining user quota in the private files are for the current user.
96.summary: New Web Service core_auth_request_password_reset
description: Public Web Service (via XHR) to allow users to request a password reset using the mobile app.
97.summary: New Web Service core_blog_get_entries
description: New Web Service for retrieving blog entries
98.summary: New Web Service core_blog_view_entries
description: We need a new WS for triggering the blog_entries_viewed event
99.summary: New Web Service mod_glossary_update_entry
description: Ws for updating entries
100.summary: New WebService mod_scorm_get_scorm_access_information
description: We need this WebService to return the capabilities affecting the current user in order to calculate if the user is able to see some information controlled by capabilities (a particular case is the score information). See for more information.
101.summary: New Web Services for updating a forum post (or a discussion topic post)
description: Create a new set of functions for being able to update discussion posts. It will require some additional helper WS function to set/prepare the draft attachment and editors. Web services to be created are: mod_forum_get_discussion_post - To obtain particular information about a post and specifically if the user is able to update ir or not mod_forum_prepare_draft_area_for_post - To prepare the draft areas for a post that it is going to be updated including the files to be kept in the draft area when editing a post mod_forum_update_discussion_post - To update a post
102.summary: New web services for adding and deleting comments
description: New Web Service for adding and deleting comments in any commenting area.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Epic Create an Event Monitor tool
description: Create a report that lets users subscribe to various events happening in Moodle.
| Unsolvable | 1.summary: Event monitor: Finalise the basic file and database structure
description: Commit the basic file structure with the following:- Directory structure xmldb files permissions (db/access.php)
2.summary: Event monitor: Create a rule manager class with unit tests
description: Create a class report_monitor\rule_manager that lets you Create rules Edit rules Delete rules get rules Get rule With unit tests
3.summary: Event monitor: Create a subscription manager class
description: Create a class report_monitor\subscription_manager that lets you Create subscriptions Delete subscriptions Get subscription Get subscriptions for course Get subscriptions for an event With unit tests
4.summary: Event monitor: Create a class to generate eventlist
description: Create a class to find and list all events with caching
5.summary: Event monitor: Sort out navigation
description: We basically are going to provide three main entry points Subscription management page Rules management page Sort out where these nodes needs to be present in the navigation
6.summary: Event monitor: Create rule class
description: We need a class that represents a rule in the database. It might have the following methods get_module_select delete_rule copy_rule get_plugin_name get_description get_name get_filters_description get_event_name unsubscribe_user subscribe_user If it seems some of these methods can be reused by the subscription class, consider abstraction of those.
7.summary: Event monitor: Create a form to edit/add a new rule
description: We need a form to add/edit a new rule. This issue includes:- The mform with proper validations and such Edit.php to handel forum submissions A yui module to update the select drop downs dynamically (consider creating a mform dependent select element instead? )
8.summary: Event monitor: Create renderables/renderers to display the rule managment page
description: Write a renderer to display rule management interface.
9.summary: Event monitor: Create renderables/renderers to display the subscription managment page
description: Write a renderer to display subscription management interface.
10.summary: Event monitor: Handle creating/deleting subscriptions
description: Write a renderer to display subscription management interface.
11.summary: Event monitor: Handle rule managment
description: Write yui modules to handle the managment of rules Deleting a rule copying a rule
12.summary: Event monitor: Implement the event observer
description: Implement an event observer that populates tool_monitor_events, as needed
13.summary: Event monitor: Implement cron task to send notifications
description: Implement a cron task to check if rule has happened or not and send notifications as required. This will also include creating a new message type.
14.summary: Event monitor: Create a subscription instance class
description: Create a class that represents a subscription instance
15.summary: Event monitor: Write behat tests for the tool
description: Write behat tests for the tool
16.summary: Event monitor: Delete rules when course is deleted
description: We need an observer to delete rules and subscriptions when a course is deleted
17.summary: Event monitor: Add help icon on subscriptions manage page
description: On subscriptions manage page, there should be a help icon which provide further details on each rule. This should be present in both the tables. This can possibly include information such as event name, module name, description, etc. Up to the assignee to decide the best amount of info. Since our help icon infrastructure only supports static content at this point, this might involve writing some yui code to generate custom panels for displaying the help content.
18.summary: Event monitor: Write QA tests for the tool
description: Write QA tests for the tool
19.summary: Event monitor: Remove dependency on
description: Either remove dependency on , or get integrated
20.summary: Event monitor: Handle module and user deletion
description: When a user is deleted all related subscriptions should be deleted. When a module is deleted all related subscriptions should be deleted. (also consider priority of the observers while creating this)
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Epic Create an Event Monitor tool
description: Create a report that lets users subscribe to various events happening in Moodle.
### Response:
1.summary: Event monitor: Finalise the basic file and database structure
description: Commit the basic file structure with the following:- Directory structure xmldb files permissions (db/access.php)
2.summary: Event monitor: Create a rule manager class with unit tests
description: Create a class report_monitor\rule_manager that lets you Create rules Edit rules Delete rules get rules Get rule With unit tests
3.summary: Event monitor: Create a subscription manager class
description: Create a class report_monitor\subscription_manager that lets you Create subscriptions Delete subscriptions Get subscription Get subscriptions for course Get subscriptions for an event With unit tests
4.summary: Event monitor: Create a class to generate eventlist
description: Create a class to find and list all events with caching
5.summary: Event monitor: Sort out navigation
description: We basically are going to provide three main entry points Subscription management page Rules management page Sort out where these nodes needs to be present in the navigation
6.summary: Event monitor: Create rule class
description: We need a class that represents a rule in the database. It might have the following methods get_module_select delete_rule copy_rule get_plugin_name get_description get_name get_filters_description get_event_name unsubscribe_user subscribe_user If it seems some of these methods can be reused by the subscription class, consider abstraction of those.
7.summary: Event monitor: Create a form to edit/add a new rule
description: We need a form to add/edit a new rule. This issue includes:- The mform with proper validations and such Edit.php to handel forum submissions A yui module to update the select drop downs dynamically (consider creating a mform dependent select element instead? )
8.summary: Event monitor: Create renderables/renderers to display the rule managment page
description: Write a renderer to display rule management interface.
9.summary: Event monitor: Create renderables/renderers to display the subscription managment page
description: Write a renderer to display subscription management interface.
10.summary: Event monitor: Handle creating/deleting subscriptions
description: Write a renderer to display subscription management interface.
11.summary: Event monitor: Handle rule managment
description: Write yui modules to handle the managment of rules Deleting a rule copying a rule
12.summary: Event monitor: Implement the event observer
description: Implement an event observer that populates tool_monitor_events, as needed
13.summary: Event monitor: Implement cron task to send notifications
description: Implement a cron task to check if rule has happened or not and send notifications as required. This will also include creating a new message type.
14.summary: Event monitor: Create a subscription instance class
description: Create a class that represents a subscription instance
15.summary: Event monitor: Write behat tests for the tool
description: Write behat tests for the tool
16.summary: Event monitor: Delete rules when course is deleted
description: We need an observer to delete rules and subscriptions when a course is deleted
17.summary: Event monitor: Add help icon on subscriptions manage page
description: On subscriptions manage page, there should be a help icon which provide further details on each rule. This should be present in both the tables. This can possibly include information such as event name, module name, description, etc. Up to the assignee to decide the best amount of info. Since our help icon infrastructure only supports static content at this point, this might involve writing some yui code to generate custom panels for displaying the help content.
18.summary: Event monitor: Write QA tests for the tool
description: Write QA tests for the tool
19.summary: Event monitor: Remove dependency on
description: Either remove dependency on , or get integrated
20.summary: Event monitor: Handle module and user deletion
description: When a user is deleted all related subscriptions should be deleted. When a module is deleted all related subscriptions should be deleted. (also consider priority of the observers while creating this)
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: MoodleNet
summary: Initial release of user-specific page
description: Initial release of user-specific page
| Unsolvable | 1.summary: Give user control of whats shown in My feed
description: As reported on Changemap| a user has suggested more control of the My feed timeline on the home page. At the moment, this is just a feed of everything on the instance, but eventually it should be a feed of updates around: Communities the user is part of Collections theyre following People theyre following As weve discussed before, this is separate from the _notifications_ around these. To discuss in more detail!
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: MoodleNet
summary: Initial release of user-specific page
description: Initial release of user-specific page
### Response:
1.summary: Give user control of whats shown in My feed
description: As reported on Changemap| a user has suggested more control of the My feed timeline on the home page. At the moment, this is just a feed of everything on the instance, but eventually it should be a feed of updates around: Communities the user is part of Collections theyre following People theyre following As weve discussed before, this is separate from the _notifications_ around these. To discuss in more detail!
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle Community Sites
summary: Moodle community sites 3.6.3 upgrade
description: Moodle 3.6.3 was released on Monday 11 March 2019.
| Unsolvable | 1.summary: Upgrade moodle.org to 3.6.3
description:
2.summary: Upgrade learn.moodle.net to 3.6.3
description:
3.summary: Upgrade lang.moodle.org to 3.6.3
description:
4.summary: Upgrade school.demo.moodle.net to 3.6.3
description:
5.summary: Upgrade demo.moodle.net to 3.6.3
description:
6.summary: Upgrade moodle.net to 3.6.3
description:
7.summary: Upgrade download.moodle.org to 3.5.5
description:
8.summary: Upgrade dev.moodle.org to 3.6.3
description:
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle Community Sites
summary: Moodle community sites 3.6.3 upgrade
description: Moodle 3.6.3 was released on Monday 11 March 2019.
### Response:
1.summary: Upgrade moodle.org to 3.6.3
description:
2.summary: Upgrade learn.moodle.net to 3.6.3
description:
3.summary: Upgrade lang.moodle.org to 3.6.3
description:
4.summary: Upgrade school.demo.moodle.net to 3.6.3
description:
5.summary: Upgrade demo.moodle.net to 3.6.3
description:
6.summary: Upgrade moodle.net to 3.6.3
description:
7.summary: Upgrade download.moodle.org to 3.5.5
description:
8.summary: Upgrade dev.moodle.org to 3.6.3
description:
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Gradebook push from HQ in 2014
description: These are a list of some of the important Grade issues that we are looking at in 2.8.
| Unsolvable | 1.summary: Grade Scales - Currently, only integers can be specified as letter grade boundaries when creating a grade scale. Provide the ability to specify a real number.
description: When creating a grading scale, the letter grade boundary is chosen from a drop-down list box and only an integer can be chosen. For example. I chose 89 as the letter grade boundary for an A-. As a result, any grade over 89, example 89.1 displays as an A-. I want only an 89.5 or higher to display as an A-. I am requesting a way to specify any number as a letter grade boundary in addtion to the integer choices currently in the drop-down list box, example 89.49 as the letter grade boundary for A-. Perhaps a "combo-box" instead of a "drop-down list box" in the interface would work.
2.summary: Grade - Add an option to export the total in letters
description: In gradebook, when we try to export the grades, we want to add an option that will add an new column at the end that is the total in letter (based on the grades-letters setting of the course.
3.summary: Add events for when a grade has been created/updated
description: It would be nice to be able to register for course final grade updates.
4.summary: Shift controls to category/item settings page and consolidate "Simple" and "Full" grade setup pages
description: This came about during a review of the prototype for the Natural Weighting aggregation method, but it will effect the grade settings page and all aggregation methods generally. Currently there a number of controls on the grade setup pages (formerly the "Categories and items pages") for categories and grade items which could be shifted to the settings page for each. This would simplify the grade settings interface and focus attention on commonly used controls (hiding the potentially confusing ones). Also, we currently present two pages "Simple view" and "Full view". These can be consolidated into a single "Setup" page, with the difference between the pages being accommodated in the settings page for each item. Currently there are columns for: Name (as text) Aggregation (categories) Extra credit (grade items) Exclude empty grades (categories) Aggregate including subcategories (possibly to be removed altogether) Include outcomes in aggregation (categories) Drop the lowest (categories) Multiplicator (grade items) Offset (grade items) Actions... Edit Move (grade items) Hide Lock Select (for moving between categories) It was felt that the minimum set required on the setup page was: Move (to the left of grade item name) Name Aggregation (as text, to the right of category name) Weight (with a + next to it to indicate extra credit items) Max grade Contributed value Actions (converted to an action menu for easier control on touch devices) Edit Hide Lock (is this really needed) Select (but only when categories are used) The remaining controls should be moved to the category/item settings page. This will also help us control these settings more easily, when there are dependencies involved. This work may need to be broken into sub-tasks. Mock-ups and/or a prototype of the new interface needs to be created
5.summary: Nest weightings within categories
description: At the moment, on the Gradebook setup pages (Simple and Full), where weights are used, the weights are all lined up in one column. It is difficult to determine what weights belong to grade items, categories and nested grade items. The weights should be nested to indicate they are within a category.
6.summary: Gradebook terminology improvements
description: As defined by the Gradebook working group: "en" pack: "Aggregate Only Non-Empty Grades" "Exclude empty grades" "Categories & Items" "Setup" "Marks/Marking" "Grades/Grading" (whenever referring to gradebook stuff) "en_us" pack: "Marks Points" (for quiz) Swap string: "Update" on grader report "Save changes" New terms: "Natural weighting"
7.summary: Add option to conditionally aggregate hidden grades
description: The hidden grades are now always aggregated together with all other grades. The problem is that users might calculate the value of hidden grades from the totals. There is a workaround in 1.9, it should be fixed properly in 2.0 (needs db changes) 1/ add field aggregatehidden into grade_items 2/ add field unhideafter into grade_items and grade_grades 3/ add hiding switching logic into regrading 4/ tweak forms and patch the hiding logic
8.summary: User report and Grader report are inconsistent for the grade that is hidden. Allow teacher to toggle to/from "user view"
description: If I am a grader and I decided to hide the grade for one student for an assignment, I can still see it in the Grader report (but the font is gray). If I (again as a grader) go to the user report for this user I: - CAN see the assignment - CAN NOT see any grade, not even gray, in the columns Grade, Percentage, Rank - CAN see the grade in the column Letter grade (I enabled it in settings) As a student I dont see this assignment in the user report at all. There should be a clear policy, what User report shows if it is viewed by a grader: 1) it shows the same as Grader report but for a particular user or 2) it shows the same as what this user would see in his User report Depending on this policy the hidden grades should be shown or the whole line with module should not be shown at all. ---- Regarding Rank: there should be also a policy whether to include the hidden grades in rank or not. At the moment they are included, so for other students the rank is calculated as if hidden grades were normal grades. But for student whose grade is hidden, rank is not displayed (although exists) The column Average displays the average only for grades that are not hidden. So for other users it looks strange: "Rank 2/4, Average 30.00 (3)" So I would suggest that Rank should not include hidden grades
9.summary: Add grade item and student grades quick edit feature to the grader report
description: Add grade item and student grades quick edit feature to the grader report to enable editing for each grade item and for each student: Grades and feedback Grade overrides Excluded grades Thanks to developers at the LSU for this feature - see for more details.
10.summary: Define the desirements for the grade history report
description: The primary goal of integrating the Grade History report is covered in and its sub-tasks. Stage 2 of this will be the potential enhancement of the report. This issue is a placeholder that will act as a collecting point for extensions to the existing report after it has been introduced. Ideas should be well described and documented in order for mockups, specs, and code development to happen. The following ideas have already been suggested. - Diffs (showing differences between two points in time) - Finding editing periods (what does this mean?) - Include grade history in backups - Restore grade history from backups - more ideas from you... Once ideas have been defined and speced, improvement issues will need to be created.
11.summary: Allow categories to be collapsed in the Gradebook setup page
description: The setup page(s) for the gradebook can get long and complicated when there are numerous grade items and categories. One way of potentially reducing the complexity is by allowing the categories to be collapsed on this page, much like settings pages allow sections of settings to be collapsed.
12.summary: Allow the page size in the Single view report to be configurable or remove pagination
description: As an enhancement to the current pagination in the Single view report, the number of items/users shown per-page should be configurable, similar to the method used in the Assignment grading page.
13.summary: Need to decide menu/tab items for Setup items
description: We decided to reduce the categories and items screen down to one page called Setup, but never really sorted out how the new "Setup" page was going to be implemented in navigation. We need to sort out a neat way to organise "Grade settings" and "Setup" in the menus and tabs. Decision: Set up grades layout
14.summary: Consolidate design of recently altered Gradebook pages
description: A number of changes have been made to the interface of certain Gradebook changes. The CSS used to present these interfaces should be reviewed and consolidated. The setup page () The single view report () The user report () Advise on how to best show nesting within the Gradebook setup page is also needed ().
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Gradebook push from HQ in 2014
description: These are a list of some of the important Grade issues that we are looking at in 2.8.
### Response:
1.summary: Grade Scales - Currently, only integers can be specified as letter grade boundaries when creating a grade scale. Provide the ability to specify a real number.
description: When creating a grading scale, the letter grade boundary is chosen from a drop-down list box and only an integer can be chosen. For example. I chose 89 as the letter grade boundary for an A-. As a result, any grade over 89, example 89.1 displays as an A-. I want only an 89.5 or higher to display as an A-. I am requesting a way to specify any number as a letter grade boundary in addtion to the integer choices currently in the drop-down list box, example 89.49 as the letter grade boundary for A-. Perhaps a "combo-box" instead of a "drop-down list box" in the interface would work.
2.summary: Grade - Add an option to export the total in letters
description: In gradebook, when we try to export the grades, we want to add an option that will add an new column at the end that is the total in letter (based on the grades-letters setting of the course.
3.summary: Add events for when a grade has been created/updated
description: It would be nice to be able to register for course final grade updates.
4.summary: Shift controls to category/item settings page and consolidate "Simple" and "Full" grade setup pages
description: This came about during a review of the prototype for the Natural Weighting aggregation method, but it will effect the grade settings page and all aggregation methods generally. Currently there a number of controls on the grade setup pages (formerly the "Categories and items pages") for categories and grade items which could be shifted to the settings page for each. This would simplify the grade settings interface and focus attention on commonly used controls (hiding the potentially confusing ones). Also, we currently present two pages "Simple view" and "Full view". These can be consolidated into a single "Setup" page, with the difference between the pages being accommodated in the settings page for each item. Currently there are columns for: Name (as text) Aggregation (categories) Extra credit (grade items) Exclude empty grades (categories) Aggregate including subcategories (possibly to be removed altogether) Include outcomes in aggregation (categories) Drop the lowest (categories) Multiplicator (grade items) Offset (grade items) Actions... Edit Move (grade items) Hide Lock Select (for moving between categories) It was felt that the minimum set required on the setup page was: Move (to the left of grade item name) Name Aggregation (as text, to the right of category name) Weight (with a + next to it to indicate extra credit items) Max grade Contributed value Actions (converted to an action menu for easier control on touch devices) Edit Hide Lock (is this really needed) Select (but only when categories are used) The remaining controls should be moved to the category/item settings page. This will also help us control these settings more easily, when there are dependencies involved. This work may need to be broken into sub-tasks. Mock-ups and/or a prototype of the new interface needs to be created
5.summary: Nest weightings within categories
description: At the moment, on the Gradebook setup pages (Simple and Full), where weights are used, the weights are all lined up in one column. It is difficult to determine what weights belong to grade items, categories and nested grade items. The weights should be nested to indicate they are within a category.
6.summary: Gradebook terminology improvements
description: As defined by the Gradebook working group: "en" pack: "Aggregate Only Non-Empty Grades" "Exclude empty grades" "Categories & Items" "Setup" "Marks/Marking" "Grades/Grading" (whenever referring to gradebook stuff) "en_us" pack: "Marks Points" (for quiz) Swap string: "Update" on grader report "Save changes" New terms: "Natural weighting"
7.summary: Add option to conditionally aggregate hidden grades
description: The hidden grades are now always aggregated together with all other grades. The problem is that users might calculate the value of hidden grades from the totals. There is a workaround in 1.9, it should be fixed properly in 2.0 (needs db changes) 1/ add field aggregatehidden into grade_items 2/ add field unhideafter into grade_items and grade_grades 3/ add hiding switching logic into regrading 4/ tweak forms and patch the hiding logic
8.summary: User report and Grader report are inconsistent for the grade that is hidden. Allow teacher to toggle to/from "user view"
description: If I am a grader and I decided to hide the grade for one student for an assignment, I can still see it in the Grader report (but the font is gray). If I (again as a grader) go to the user report for this user I: - CAN see the assignment - CAN NOT see any grade, not even gray, in the columns Grade, Percentage, Rank - CAN see the grade in the column Letter grade (I enabled it in settings) As a student I dont see this assignment in the user report at all. There should be a clear policy, what User report shows if it is viewed by a grader: 1) it shows the same as Grader report but for a particular user or 2) it shows the same as what this user would see in his User report Depending on this policy the hidden grades should be shown or the whole line with module should not be shown at all. ---- Regarding Rank: there should be also a policy whether to include the hidden grades in rank or not. At the moment they are included, so for other students the rank is calculated as if hidden grades were normal grades. But for student whose grade is hidden, rank is not displayed (although exists) The column Average displays the average only for grades that are not hidden. So for other users it looks strange: "Rank 2/4, Average 30.00 (3)" So I would suggest that Rank should not include hidden grades
9.summary: Add grade item and student grades quick edit feature to the grader report
description: Add grade item and student grades quick edit feature to the grader report to enable editing for each grade item and for each student: Grades and feedback Grade overrides Excluded grades Thanks to developers at the LSU for this feature - see for more details.
10.summary: Define the desirements for the grade history report
description: The primary goal of integrating the Grade History report is covered in and its sub-tasks. Stage 2 of this will be the potential enhancement of the report. This issue is a placeholder that will act as a collecting point for extensions to the existing report after it has been introduced. Ideas should be well described and documented in order for mockups, specs, and code development to happen. The following ideas have already been suggested. - Diffs (showing differences between two points in time) - Finding editing periods (what does this mean?) - Include grade history in backups - Restore grade history from backups - more ideas from you... Once ideas have been defined and speced, improvement issues will need to be created.
11.summary: Allow categories to be collapsed in the Gradebook setup page
description: The setup page(s) for the gradebook can get long and complicated when there are numerous grade items and categories. One way of potentially reducing the complexity is by allowing the categories to be collapsed on this page, much like settings pages allow sections of settings to be collapsed.
12.summary: Allow the page size in the Single view report to be configurable or remove pagination
description: As an enhancement to the current pagination in the Single view report, the number of items/users shown per-page should be configurable, similar to the method used in the Assignment grading page.
13.summary: Need to decide menu/tab items for Setup items
description: We decided to reduce the categories and items screen down to one page called Setup, but never really sorted out how the new "Setup" page was going to be implemented in navigation. We need to sort out a neat way to organise "Grade settings" and "Setup" in the menus and tabs. Decision: Set up grades layout
14.summary: Consolidate design of recently altered Gradebook pages
description: A number of changes have been made to the interface of certain Gradebook changes. The CSS used to present these interfaces should be reviewed and consolidated. The setup page () The single view report () The user report () Advise on how to best show nesting within the Gradebook setup page is also needed ().
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: MoodleNet
summary: Users on MoodleNet servers should be able to interact across instances
description: Users on MoodleNet servers should be able to interact across instances
| Unsolvable | 1.summary: UX for following remote community/collection via search
description: .
2.summary: Set up another MoodleNet instance for initial testing
description: Mayel to ask DevOps to set up.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: MoodleNet
summary: Users on MoodleNet servers should be able to interact across instances
description: Users on MoodleNet servers should be able to interact across instances
### Response:
1.summary: UX for following remote community/collection via search
description: .
2.summary: Set up another MoodleNet instance for initial testing
description: Mayel to ask DevOps to set up.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Performance tool for finding performance regressions
description: We already have moodle-performance-comparison| for finding performance regression, then why a new tool? With current tool, we have hit some bottleneck issues and they were discussed in iTeam meeting| As per proposal| this tool will try to achieve following: Following metrics should be comparable Request/sec Throughput Memory usage Session size (Allow tolerance) Fails (For tuning) Content size db read/write/(querytime) filesincluded (This has direct impact on memory consumption etc.) timeused serverload (Will include this param and evaluate the need. If useful then keep it else discard) Comparison should be possible for big data. Multiple test plans support (including easy to add/remove) Able to compare different runs Specialised expectations/tolerances for every case. This will be done by following 4 tools: Data generator (This will use existing behat data generators and help create site with required data set for testing) Behat feature to JMX (We will have some basic templates as admin/teacher/student, navigating the site,, but dev can create there own scenarios and convert them to jmx using this tool) JMeter + logging (Logging will be enhanced to push data to multiple backend for comparison and analysis) Analysis tool (This will help analyse moodle performance over time and show how and when things got fixed or decisions about performance variation took place.)
| Unsolvable | 1.summary: Data generator for performance tool
description: Data generator is a very important aspect of performance tool, as it create a target site against which the performance metrics will be generated. Target site should not be changed, if data needs to be compared over the period. Current data generator for performance tool doesn t provide much information on actual state of moodle site. Tools should be able to do following: User select/see what activities/resources/users will be created for test site. There will be 6 default generators (XS, S, M, L, XL, XXL) which will be bundled with tool and moodle code (Adding this to moodle code will help dev s initialize there dev env.) Use behat steps, so it gives better visibility. noformat Given I have x courses And each course having x students And each course having x | activity name noformat Target site should be able to identify itself with user/courses/activities etc. so they can be passed to run and logged properly. Tool implementation:
2.summary: Behat feature to JMX
description: This is 2nd tool needed for performance tool. This will facilitate devs and users to write/read test plan by using existing gherkin language (behat), which is much easy to understand and moodle devs use it for acceptance testing. This tools will work with BrowserMobProxy| and should be able to: Create a new proxy port Capture required get/post request from the proxy in HAR format Convert HAR to JMX
3.summary: jMeter Logging
description: Current moodle-performance-comparison tool record runs and push it in php as array. It is later used by comparison tool. This tool will use monolog with interfaces to push data to different stores for analysis.
4.summary: Comparison and analysis tool
description: Current performance comparison tool will be improved to give following results: Compare weekly runs on basis of tolerance Comparison of results overtime Record modified tolerances overtime, with details of decision.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Performance tool for finding performance regressions
description: We already have moodle-performance-comparison| for finding performance regression, then why a new tool? With current tool, we have hit some bottleneck issues and they were discussed in iTeam meeting| As per proposal| this tool will try to achieve following: Following metrics should be comparable Request/sec Throughput Memory usage Session size (Allow tolerance) Fails (For tuning) Content size db read/write/(querytime) filesincluded (This has direct impact on memory consumption etc.) timeused serverload (Will include this param and evaluate the need. If useful then keep it else discard) Comparison should be possible for big data. Multiple test plans support (including easy to add/remove) Able to compare different runs Specialised expectations/tolerances for every case. This will be done by following 4 tools: Data generator (This will use existing behat data generators and help create site with required data set for testing) Behat feature to JMX (We will have some basic templates as admin/teacher/student, navigating the site,, but dev can create there own scenarios and convert them to jmx using this tool) JMeter + logging (Logging will be enhanced to push data to multiple backend for comparison and analysis) Analysis tool (This will help analyse moodle performance over time and show how and when things got fixed or decisions about performance variation took place.)
### Response:
1.summary: Data generator for performance tool
description: Data generator is a very important aspect of performance tool, as it create a target site against which the performance metrics will be generated. Target site should not be changed, if data needs to be compared over the period. Current data generator for performance tool doesn t provide much information on actual state of moodle site. Tools should be able to do following: User select/see what activities/resources/users will be created for test site. There will be 6 default generators (XS, S, M, L, XL, XXL) which will be bundled with tool and moodle code (Adding this to moodle code will help dev s initialize there dev env.) Use behat steps, so it gives better visibility. noformat Given I have x courses And each course having x students And each course having x | activity name noformat Target site should be able to identify itself with user/courses/activities etc. so they can be passed to run and logged properly. Tool implementation:
2.summary: Behat feature to JMX
description: This is 2nd tool needed for performance tool. This will facilitate devs and users to write/read test plan by using existing gherkin language (behat), which is much easy to understand and moodle devs use it for acceptance testing. This tools will work with BrowserMobProxy| and should be able to: Create a new proxy port Capture required get/post request from the proxy in HAR format Convert HAR to JMX
3.summary: jMeter Logging
description: Current moodle-performance-comparison tool record runs and push it in php as array. It is later used by comparison tool. This tool will use monolog with interfaces to push data to different stores for analysis.
4.summary: Comparison and analysis tool
description: Current performance comparison tool will be improved to give following results: Compare weekly runs on basis of tolerance Comparison of results overtime Record modified tolerances overtime, with details of decision.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle Community Sites
summary: Learn Moodle MOOC Jan 2017
description:
| Unsolvable | 1.summary: Create a sign-up enrolment plugin for Learn Moodle
description: Needs to cater for user-friendly enrolment to the upcoming MOOC for both new and returning users including mobile app users. In the Sept 2013 MOOC we used the standard self-enrolment plugin, however it proved a problem for people to click a link to enrol in the course and then on the next page have to click an Enrol me in this course button. Thus we searched for a one-step enrolment solution and came up with the enrol_autoenrol plugin (). This has been fine for subsequent MOOCs apart from not being able to sign up via the mobile app. Note: Up to now weve also had guest access enabled; from Jan 2017 we wont.
2.summary: Create badges for the 2017 Learn Moodle MOOC
description: Husveen we need our 3 Learn Moodle MOOC badges updating for 2017 with the date changed from 2016 to 2017 (no other changes required) Are you able to do these on January 3rd at all, please, so we can award the Participants badge as soon as possible once the course begins? I am linking to the original tracker issue where barbararamiro made the original badges - we use the orange versions. Many thanks!
3.summary: Enable the Learn Moodle front page text to be editable
description: Since upgrading the site to 3.2 with the Boost theme, the text Welcome to the official Moodle MOOC site. Our next course will start on 2 January 2017. is no longer editable.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle Community Sites
summary: Learn Moodle MOOC Jan 2017
description:
### Response:
1.summary: Create a sign-up enrolment plugin for Learn Moodle
description: Needs to cater for user-friendly enrolment to the upcoming MOOC for both new and returning users including mobile app users. In the Sept 2013 MOOC we used the standard self-enrolment plugin, however it proved a problem for people to click a link to enrol in the course and then on the next page have to click an Enrol me in this course button. Thus we searched for a one-step enrolment solution and came up with the enrol_autoenrol plugin (). This has been fine for subsequent MOOCs apart from not being able to sign up via the mobile app. Note: Up to now weve also had guest access enabled; from Jan 2017 we wont.
2.summary: Create badges for the 2017 Learn Moodle MOOC
description: Husveen we need our 3 Learn Moodle MOOC badges updating for 2017 with the date changed from 2016 to 2017 (no other changes required) Are you able to do these on January 3rd at all, please, so we can award the Participants badge as soon as possible once the course begins? I am linking to the original tracker issue where barbararamiro made the original badges - we use the orange versions. Many thanks!
3.summary: Enable the Learn Moodle front page text to be editable
description: Since upgrading the site to 3.2 with the Boost theme, the text Welcome to the official Moodle MOOC site. Our next course will start on 2 January 2017. is no longer editable.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Analytics 3.8 improvements
description: List of improvements / relevant bug fixes for Moodle 3.8
| Unsolvable | 1.summary: Analytics models may be restricted to category or course contexts
description: is scheduled for 3.7, it will allow people to create as many prediction models as they want, reusing the same target. A new "Restrict model to the following contexts" option would allow people to set up separate predictive models for different course categories or courses. A model restricted to a set of contexts (just CONTEXT_COURSE and CONTEXT_COURSECAT) would limit the analysable elements used by the model to analysable elements whose context is equal to, or a child of, any of the contexts specified in "Restrict to the following contexts". The required changes to core could be summarized here: A new field to models db table (e.g. contexts) A new field in the edit model form (e.g. an autocomplete field with a list of courses and course categories) A new \core_analytics\local\analyser\base::supports_context_filtering() method to show/hide the new field (the point right above this one) Modifications to the analytics API to pre-fill optionsfilter with the list of contexts Modifications to cores get_analysables_iterator() implementations (core_analytics\local\analyser\by_course and core\analytics\analyser\users) to receive $this->optionsfilter as a parameter and take it into account A new helper method somewhere in core_analytics to return an SQL that joins with the context table and uses the ctx.path value of the provided context to filter out analysables that do not fit into the restricted list of contexts for the model. This method will be called by get_analysables() implementations where supports_context_filtering == true A modification to the current evaluation process, which supports a filter by course option. I would vote to just replace this filter by course for the filter by contextid/s A review of the analytics caching system to ensure we dont break anything Unit tests should be added to test everything. Specially helpful to detect possible issues in the point right above this one I may be missing extra stuff, but those are the most critical points we need to cover.
2.summary: Report on the actions executed by users on predictions
description: We have been storing which of the suggested actions are executed by users. We should report on it. Some filtering capabilities should be added. Context filtering is a requirement. Other filters like start and end dates can also be included as part of this issue or as a separate issue. The generation of charts in time-series can also be included if it does not require significant resources.
3.summary: Insights about students who have not logged in recently
description: I propose two new insights for teachers: Students who have not accessed the course recently Periodic insights (e.g. weekly, monthly...) Students who have not started the course since its start date Just 1 insight generated after X days (e.g. 15 days, 1 month...) The model can extend from the course_enrolment base and reuse an existing read_actions indicator as any course view generates a read event. The suggested actions would include the usual Send message + View details + Acknowledge + Not useful. I would not include the "Outline report" here though. These models have great value for the resources we have to dedicate to them.
4.summary: Allow targets to limit the analysis interval to a specific interface or parent class.
description: The list of time-splitting methods you can select for a model includes all the time-splitting methods in the system. Some time-splitting methods do not make sense for some targets and our UI still allow these combinations. This is confusing and leads to wrong uses of the system A possible solution for this is to allow targets to specify a set of time-splitting method interfaces or parent classes so the choices in the time-splitting select menu are limited to the ones that match the specified interfaces. The important point to discuss is the upgrade path. i.e. what should we do with models in the database whose time-splitting method will be invalid according to these new limitations imposed by the model targets? My best proposal is to disable them and remove the existing time-splitting method value as their state will be incorrect according to the new limitations. This proposal is based on the assumption that most models will not work anyway using incorrect time-splitting methods. Most (if not all) the time-splitting methods in core already extend different base classes so this issue should be quite simple. A review and classification of the existing time-splitting methods and also potential new time-splitting methods should be part of this issue as one of the riskswe have is that we could limit too much what people can do. For example, if we limit students at risk to time-splitting methods that split the course in parts we wont allow someone to write a new time-splitting method that generates predictions for students at risk targets 34 days after the course start.
5.summary: Rename Time-splitting to Analysis interval + other wording improvements
description: This issue involves 3 different aspects. Time-splitting method in the UI Time-splitting method is not a nice name, it is not even nice to type. It sounds like something very complex and weird and it does not even reflect what it really is as not all time-splitting methods split the duration of an analysable element in parts. To update all the internal references to time-splitting method would be hell, but we can change the references in the UI by something more user-friendly. After asking for suggestions emdalton1 proposed "Prediction interval" or "Analysis interval". I personally like "analysis interval" because those same intervals are also used to generate training data. The name of the time-splitting methods in core Naming specific time-splitting methods has also been challenging because: We talk about "the start" or about "the end" without mentioning the start or the end of what. The name of the target helps here, but still, it is not 100 clear. This is the price for having reusable elements in this API... We need to inform users of too many things in just 1 line How many predictions (i.e. intervals for analysis) will be generated? When will the system generate predictions? What interval will be used during each of the analysis? Therefore, as part of this change we should also review the names we have been using to describe the time-splitting methods we have in core as these options would not directly make sense when put next to a field named "Analysis interval". I propose to use the help link to clearly explain 1, 2.1, 2.2 and 2.3. I am writing a proposal for this that will be also useful for . This is the draft image. !Types of time-splitting methods (2).png|thumbnail! The "Get predictions" action is not a get predictions on-demand I can imagine someone that does not know much about this system expecting a model to generate predictions every time a user clicks on "Get predictions". This is not how time-splitting methods work and it is related with the point 2.2 in The name of the time-splitting methods in core. A model that uses a time-splitting method that only generates 1 prediction for each sample will calculate the indicators and generate the prediction the first time the "Get prediction" action is executed. The second time it is executed we will detect that this model already generated a prediction for that sample and will return a No new predictions yet message. The same happens with time-splitting methods that generate predictions after each quarter of the course. After the first quarter of the course a prediction will be generated when "Get predictions" is executed or when the cron executes it automatically. If a site manager manually executes "Get predictions" the following day, the No new predictions yet message will be displayed again and no new predictions will be generated until the next quarter of the course is over. We either need to rename the Get predictions action or to reword the No new predictions yet message.
6.summary: Extra garbage collection for analytics
description: Further testing for revealed that a chunk of data was not removed by PHPs garbage collector. After several days investigating the issue I ended up identifying a late initialisation of the CLI renderer as the root cause for the memory leak. $PAGE is not initialised until the grades API (required by one of the indicators used in the model) is called, moodle_page::_wherethemewasinitialised is then set to debug_backtrace() which contains the indicator instance so the instance is not garbage collected until the end of the script, when moodle_page is destroyed, blocking that chunk of data allocated in PHPs memory until the end of the script. PHP instances are not removed from memory when there are references to them, even when calling unset($instance) and this is what was happening in this case. The provided patch includes a couple of performance improvements to free memory back to the OS as soon as possible,
7.summary: Require enrolments to be active for most of the analysis interval
description: In we attempted to discard enrolments whose start date is after the course start so that the new enrolments added halfway through the course would not get incorrect predictions. The analytics API will identify a new sample and will analyse it the first time the cron runs. They may get false negatives (incorrect at-risk predictions) because the indicators will be calculated since the start of the course (for example) and they would not have much activity logged up to that point in time. I suggest to require user enrolments to span through most of the analysis interval (e.g. a 70 of the interval). Example of what would happen with this issues patch in in the following scenario: Course starts on the 1st June, we analyse the course on the 10th June with an analysis interval from the 1st June to the 10th June. New enrolments 5 mins after the course start -> All the enrolments will be analysed New enrolment on the 2nd June -> It will be analysed New enrolment on the 7th June -> It will not be analysed For analysis intervals with fixed start and end dates like "Past quarter", where the start and end dates are fixed and depend on the course start and end date, the student in case 3 will not get a prediction until the predictions for the next quarter of the course are generated. For analysis intervals with variable start and end dates like the ones added in , where the end date is now, the student in case 3 will get a prediction on the 24th June, that is 17 days after the enrolment (17/24 = 0.7083, which is higher than the 70 in the example above)
8.summary: Add behat tests for the new students at risk models in 3.8
description: Two new models have been added to core in . They help teachers easily identify students who have not logged in for large periods. We need to cover these models with behat tests.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Analytics 3.8 improvements
description: List of improvements / relevant bug fixes for Moodle 3.8
### Response:
1.summary: Analytics models may be restricted to category or course contexts
description: is scheduled for 3.7, it will allow people to create as many prediction models as they want, reusing the same target. A new "Restrict model to the following contexts" option would allow people to set up separate predictive models for different course categories or courses. A model restricted to a set of contexts (just CONTEXT_COURSE and CONTEXT_COURSECAT) would limit the analysable elements used by the model to analysable elements whose context is equal to, or a child of, any of the contexts specified in "Restrict to the following contexts". The required changes to core could be summarized here: A new field to models db table (e.g. contexts) A new field in the edit model form (e.g. an autocomplete field with a list of courses and course categories) A new \core_analytics\local\analyser\base::supports_context_filtering() method to show/hide the new field (the point right above this one) Modifications to the analytics API to pre-fill optionsfilter with the list of contexts Modifications to cores get_analysables_iterator() implementations (core_analytics\local\analyser\by_course and core\analytics\analyser\users) to receive $this->optionsfilter as a parameter and take it into account A new helper method somewhere in core_analytics to return an SQL that joins with the context table and uses the ctx.path value of the provided context to filter out analysables that do not fit into the restricted list of contexts for the model. This method will be called by get_analysables() implementations where supports_context_filtering == true A modification to the current evaluation process, which supports a filter by course option. I would vote to just replace this filter by course for the filter by contextid/s A review of the analytics caching system to ensure we dont break anything Unit tests should be added to test everything. Specially helpful to detect possible issues in the point right above this one I may be missing extra stuff, but those are the most critical points we need to cover.
2.summary: Report on the actions executed by users on predictions
description: We have been storing which of the suggested actions are executed by users. We should report on it. Some filtering capabilities should be added. Context filtering is a requirement. Other filters like start and end dates can also be included as part of this issue or as a separate issue. The generation of charts in time-series can also be included if it does not require significant resources.
3.summary: Insights about students who have not logged in recently
description: I propose two new insights for teachers: Students who have not accessed the course recently Periodic insights (e.g. weekly, monthly...) Students who have not started the course since its start date Just 1 insight generated after X days (e.g. 15 days, 1 month...) The model can extend from the course_enrolment base and reuse an existing read_actions indicator as any course view generates a read event. The suggested actions would include the usual Send message + View details + Acknowledge + Not useful. I would not include the "Outline report" here though. These models have great value for the resources we have to dedicate to them.
4.summary: Allow targets to limit the analysis interval to a specific interface or parent class.
description: The list of time-splitting methods you can select for a model includes all the time-splitting methods in the system. Some time-splitting methods do not make sense for some targets and our UI still allow these combinations. This is confusing and leads to wrong uses of the system A possible solution for this is to allow targets to specify a set of time-splitting method interfaces or parent classes so the choices in the time-splitting select menu are limited to the ones that match the specified interfaces. The important point to discuss is the upgrade path. i.e. what should we do with models in the database whose time-splitting method will be invalid according to these new limitations imposed by the model targets? My best proposal is to disable them and remove the existing time-splitting method value as their state will be incorrect according to the new limitations. This proposal is based on the assumption that most models will not work anyway using incorrect time-splitting methods. Most (if not all) the time-splitting methods in core already extend different base classes so this issue should be quite simple. A review and classification of the existing time-splitting methods and also potential new time-splitting methods should be part of this issue as one of the riskswe have is that we could limit too much what people can do. For example, if we limit students at risk to time-splitting methods that split the course in parts we wont allow someone to write a new time-splitting method that generates predictions for students at risk targets 34 days after the course start.
5.summary: Rename Time-splitting to Analysis interval + other wording improvements
description: This issue involves 3 different aspects. Time-splitting method in the UI Time-splitting method is not a nice name, it is not even nice to type. It sounds like something very complex and weird and it does not even reflect what it really is as not all time-splitting methods split the duration of an analysable element in parts. To update all the internal references to time-splitting method would be hell, but we can change the references in the UI by something more user-friendly. After asking for suggestions emdalton1 proposed "Prediction interval" or "Analysis interval". I personally like "analysis interval" because those same intervals are also used to generate training data. The name of the time-splitting methods in core Naming specific time-splitting methods has also been challenging because: We talk about "the start" or about "the end" without mentioning the start or the end of what. The name of the target helps here, but still, it is not 100 clear. This is the price for having reusable elements in this API... We need to inform users of too many things in just 1 line How many predictions (i.e. intervals for analysis) will be generated? When will the system generate predictions? What interval will be used during each of the analysis? Therefore, as part of this change we should also review the names we have been using to describe the time-splitting methods we have in core as these options would not directly make sense when put next to a field named "Analysis interval". I propose to use the help link to clearly explain 1, 2.1, 2.2 and 2.3. I am writing a proposal for this that will be also useful for . This is the draft image. !Types of time-splitting methods (2).png|thumbnail! The "Get predictions" action is not a get predictions on-demand I can imagine someone that does not know much about this system expecting a model to generate predictions every time a user clicks on "Get predictions". This is not how time-splitting methods work and it is related with the point 2.2 in The name of the time-splitting methods in core. A model that uses a time-splitting method that only generates 1 prediction for each sample will calculate the indicators and generate the prediction the first time the "Get prediction" action is executed. The second time it is executed we will detect that this model already generated a prediction for that sample and will return a No new predictions yet message. The same happens with time-splitting methods that generate predictions after each quarter of the course. After the first quarter of the course a prediction will be generated when "Get predictions" is executed or when the cron executes it automatically. If a site manager manually executes "Get predictions" the following day, the No new predictions yet message will be displayed again and no new predictions will be generated until the next quarter of the course is over. We either need to rename the Get predictions action or to reword the No new predictions yet message.
6.summary: Extra garbage collection for analytics
description: Further testing for revealed that a chunk of data was not removed by PHPs garbage collector. After several days investigating the issue I ended up identifying a late initialisation of the CLI renderer as the root cause for the memory leak. $PAGE is not initialised until the grades API (required by one of the indicators used in the model) is called, moodle_page::_wherethemewasinitialised is then set to debug_backtrace() which contains the indicator instance so the instance is not garbage collected until the end of the script, when moodle_page is destroyed, blocking that chunk of data allocated in PHPs memory until the end of the script. PHP instances are not removed from memory when there are references to them, even when calling unset($instance) and this is what was happening in this case. The provided patch includes a couple of performance improvements to free memory back to the OS as soon as possible,
7.summary: Require enrolments to be active for most of the analysis interval
description: In we attempted to discard enrolments whose start date is after the course start so that the new enrolments added halfway through the course would not get incorrect predictions. The analytics API will identify a new sample and will analyse it the first time the cron runs. They may get false negatives (incorrect at-risk predictions) because the indicators will be calculated since the start of the course (for example) and they would not have much activity logged up to that point in time. I suggest to require user enrolments to span through most of the analysis interval (e.g. a 70 of the interval). Example of what would happen with this issues patch in in the following scenario: Course starts on the 1st June, we analyse the course on the 10th June with an analysis interval from the 1st June to the 10th June. New enrolments 5 mins after the course start -> All the enrolments will be analysed New enrolment on the 2nd June -> It will be analysed New enrolment on the 7th June -> It will not be analysed For analysis intervals with fixed start and end dates like "Past quarter", where the start and end dates are fixed and depend on the course start and end date, the student in case 3 will not get a prediction until the predictions for the next quarter of the course are generated. For analysis intervals with variable start and end dates like the ones added in , where the end date is now, the student in case 3 will get a prediction on the 24th June, that is 17 days after the enrolment (17/24 = 0.7083, which is higher than the 70 in the example above)
8.summary: Add behat tests for the new students at risk models in 3.8
description: Two new models have been added to core in . They help teachers easily identify students who have not logged in for large periods. We need to cover these models with behat tests.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Remove Assignment 2.2
description: Remove mod_assignment (NOT mod_assign) from the platform. This activity has been disabled by default since version 2.2 (2012) and has been long replaced by mod_assign. It It s important to remove things like this to reduce technical debt and the ongoing support burden, so we can focus on future initiatives. mod_assignment will still be available as a backup from the Moodle HQ github repo, but it wont be updated further by Moodle. From 4.2 onwards someone wishing to restore a backup containing instances of mod_assignment will need to install the plugin. Otherwise the course will restore without mod_assignment instances.
| Unsolvable | 1.summary: Remove Assignment 2.2 (mod_assignment) from core
description: The Assignment 2.2 activity module has been disabled by default since 2012 but was kept to enable pre-2.2 backups to be restored and have the assignments auto-converted to new assignments. Lets remove it from Moodle 4.2 and add it to the git repository for anyone who still needs to restore pre-2.2 backups. Link to the plugin:
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Remove Assignment 2.2
description: Remove mod_assignment (NOT mod_assign) from the platform. This activity has been disabled by default since version 2.2 (2012) and has been long replaced by mod_assign. It It s important to remove things like this to reduce technical debt and the ongoing support burden, so we can focus on future initiatives. mod_assignment will still be available as a backup from the Moodle HQ github repo, but it wont be updated further by Moodle. From 4.2 onwards someone wishing to restore a backup containing instances of mod_assignment will need to install the plugin. Otherwise the course will restore without mod_assignment instances.
### Response:
1.summary: Remove Assignment 2.2 (mod_assignment) from core
description: The Assignment 2.2 activity module has been disabled by default since 2012 but was kept to enable pre-2.2 backups to be restored and have the assignments auto-converted to new assignments. Lets remove it from Moodle 4.2 and add it to the git repository for anyone who still needs to restore pre-2.2 backups. Link to the plugin:
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle Community Sites
summary: META: Downloads reboot
description: Download sites to have green colour-scheme and a better design covering all the downloads we have including mobile in nice clear pages.
| Solvable | 1.summary: Plugins redesign
description:
2.summary: Downloads site makeover
description: From Martins notes: bq. Re-make Download site as a simple web page and update it with new theme.
3.summary: Switch download.moodle.org from CVS to git
description: With CVS being abandoned completely in January 2013, its time to switch all the dependent stuff @ download.moodle.org to it. This involves: 1) Create one packager that, given one commit/tag/branch is able to build the corresponding package using git as source. 2) Switch from current nightly/daily executed scripts to better git hook based solution. 3) Modify the generation of windows and windows_wpi packages from CVS to git. 4) Modify the detection of available moodle versions in the updates API from CVS to git. 5) Verify all the scripts @ download.moodle.org, switching any use from CVS to git. 6) Cleanup unused scripts. 7) Improve the sync with sourceforge. 8) Improve the download/index.php page generation to dynamically change based on available/supported packages. 9) Document how everything is done (scripts, cron, uses...) once implemented. 10) Modify/adjust the minor & major releases Moodle Docs / mdlrelease process to define the git packaging system. Thats all I can imagine for now. Subtasks will be created to keep the process clear. Ciao :-)
4.summary: Create a downloads index page
description: Page (green colour scheme) should list all standard packages as on and have links to
5.summary: Add black sites bar to downloads pages
description:
6.summary: Show plugin announcements on moodle.org/plugins
description: Similar to the announcements bar on the front page of moodle.org, showing posts from a plugins news forum in the Moodle in English course. The plugins news forum could be in a blog-like format, like Integration, exposed It could also allow replies, and then only discussions (not replies) are shown on moodle.org/plugins.
7.summary: Style language pack download pages
description: etc Language pack download pages should have a green colour-scheme.
8.summary: Convert downloads2history2summary.php to Moodle 2.7 APIs
description: /var/www/vhosts/download.moodle.org/html/downloads2history2summary.php is currently running in crontab and emailing martin and eloy
9.summary: Verify entry point pages
description: Make sure all these subdirs all keep working: And these (without fancy index pages):
10.summary: Deal with serverscripts deployed php scripts
description: Files here get auto-deployed by the serversscripts stuff The distinction between these scripts and those which im going to be keeping in local_downloadmoodleorg should be made and adjustments ill need to be made to the actual deployed scritps (i.e. Moodle 2.4isms)
11.summary: Split Mac downloads metadata from index.php
description: For the new 2.7-based downloads site, the php script which generated the mac index page for dispaly will be part of the local_moodleorg plugin. As such well need to split the metadata away from the current index.php file. I suggest for the first step, we just move the $versions array into a seperate file which can be included by the old index page and the new one.
12.summary: Navigation to the windows/mac build pages
description: At the moment we have links to the mac/windows builds from the main download page. Its just this text: "We also have some special installer packages for Mac OS X and Windows.". We are getting rid of that wall of text from the top of So we need to replace it with some way to navigate to these pages.. Maybe a block or something.. NOTE: IMO these builds are not recommended, wed prefer people to use the standard downloads - especially large institutions. So they shouldnt be especially prominent links.
13.summary: Create a download.moodle.org/mobile page
description: For listing links to download the Moodle mobile app for Android, iOS and Windows, also other relevant links such as Moodle for mobile forum also a screenshot of the app. For similar page see
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle Community Sites
summary: META: Downloads reboot
description: Download sites to have green colour-scheme and a better design covering all the downloads we have including mobile in nice clear pages.
### Response:
1.summary: Plugins redesign
description:
2.summary: Downloads site makeover
description: From Martins notes: bq. Re-make Download site as a simple web page and update it with new theme.
3.summary: Switch download.moodle.org from CVS to git
description: With CVS being abandoned completely in January 2013, its time to switch all the dependent stuff @ download.moodle.org to it. This involves: 1) Create one packager that, given one commit/tag/branch is able to build the corresponding package using git as source. 2) Switch from current nightly/daily executed scripts to better git hook based solution. 3) Modify the generation of windows and windows_wpi packages from CVS to git. 4) Modify the detection of available moodle versions in the updates API from CVS to git. 5) Verify all the scripts @ download.moodle.org, switching any use from CVS to git. 6) Cleanup unused scripts. 7) Improve the sync with sourceforge. 8) Improve the download/index.php page generation to dynamically change based on available/supported packages. 9) Document how everything is done (scripts, cron, uses...) once implemented. 10) Modify/adjust the minor & major releases Moodle Docs / mdlrelease process to define the git packaging system. Thats all I can imagine for now. Subtasks will be created to keep the process clear. Ciao :-)
4.summary: Create a downloads index page
description: Page (green colour scheme) should list all standard packages as on and have links to
5.summary: Add black sites bar to downloads pages
description:
6.summary: Show plugin announcements on moodle.org/plugins
description: Similar to the announcements bar on the front page of moodle.org, showing posts from a plugins news forum in the Moodle in English course. The plugins news forum could be in a blog-like format, like Integration, exposed It could also allow replies, and then only discussions (not replies) are shown on moodle.org/plugins.
7.summary: Style language pack download pages
description: etc Language pack download pages should have a green colour-scheme.
8.summary: Convert downloads2history2summary.php to Moodle 2.7 APIs
description: /var/www/vhosts/download.moodle.org/html/downloads2history2summary.php is currently running in crontab and emailing martin and eloy
9.summary: Verify entry point pages
description: Make sure all these subdirs all keep working: And these (without fancy index pages):
10.summary: Deal with serverscripts deployed php scripts
description: Files here get auto-deployed by the serversscripts stuff The distinction between these scripts and those which im going to be keeping in local_downloadmoodleorg should be made and adjustments ill need to be made to the actual deployed scritps (i.e. Moodle 2.4isms)
11.summary: Split Mac downloads metadata from index.php
description: For the new 2.7-based downloads site, the php script which generated the mac index page for dispaly will be part of the local_moodleorg plugin. As such well need to split the metadata away from the current index.php file. I suggest for the first step, we just move the $versions array into a seperate file which can be included by the old index page and the new one.
12.summary: Navigation to the windows/mac build pages
description: At the moment we have links to the mac/windows builds from the main download page. Its just this text: "We also have some special installer packages for Mac OS X and Windows.". We are getting rid of that wall of text from the top of So we need to replace it with some way to navigate to these pages.. Maybe a block or something.. NOTE: IMO these builds are not recommended, wed prefer people to use the standard downloads - especially large institutions. So they shouldnt be especially prominent links.
13.summary: Create a download.moodle.org/mobile page
description: For listing links to download the Moodle mobile app for Android, iOS and Windows, also other relevant links such as Moodle for mobile forum also a screenshot of the app. For similar page see
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: META: Events 2
description: Major overhaul of the current event system. Specification doc:
| Unsolvable | 1.summary: Pre and post performance profiling
description: Decide and implement performance tests, to measure the impact of the changes.
2.summary: Check coverage of unit tests for new events API
description: Write unit tests for anything that was not covered in previous issues. Create new event handler management class that deals with installation and upgrades of both legacy and new handlers.
3.summary: Define new event dispatcher behaviour and implement it
description: 1/ Describe new event dispatcher 2/ Implement new event dispatching 3/ Add phpunit support for event observation
4.summary: Remove deprecated calls to get_plugin_types(), get_plugin_list() etc
description: After is integrated we need to: Get rid of the deprecated calls in core. Add much more docs about the deprecations, including in upgrade.txt
5.summary: Define and implement the event base class
description: Define the base class for the event system.
6.summary: check usage of class_exists to avoid usage of autoloading
description: Currently class_exits is not passing second parameter as false, in blocklib.php and pluginlib.php, because of which autoloader is called and hence can hit performance with autoloader functionality. Look at other usage of class_exists function and pass second param as false, where appropriate.
7.summary: Define the new observers API
description: Describe new observer definition - just few new flags in current db/events.php
8.summary: Decide how to deal with legacy events
description: See: The requirements are: 1/ 100 backwards compatibility - all existing events are triggered with the same data 2/ easy migration - the migration process should be easy for developers 3/ performance - in future we may way to disable legacy events completely with simple setting, there should not be any overhead when legacy events disabled
9.summary: Automatic class loading
description: It would be nice to have an official class loader for Frankenstyle based class names in Moodle core. See
10.summary: change observer priority handling
description: At present we calculate the priority of "" and observers of individual events together, I would like to propose to always first execute all "" ordered by priority and then all other observers sorted separately by priority. benefits: 1/ tiny bit faster when constructing the nested array of observers 2/ tiny less memory used because the cached list of handlers would be smaller ( would not be repeated) 3/ this would allow us to introduce observing of parent class events without breaking BC (if we ever want that in the future) problems: 1/ specific observers could not be executed first and could not be last The priority was introduced in order to allow the logging subsystems to process events as the first observer to eliminate data modifications from previous handlers. So far we did not find any other major use cases for the priority flag in observers - ideas?
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: META: Events 2
description: Major overhaul of the current event system. Specification doc:
### Response:
1.summary: Pre and post performance profiling
description: Decide and implement performance tests, to measure the impact of the changes.
2.summary: Check coverage of unit tests for new events API
description: Write unit tests for anything that was not covered in previous issues. Create new event handler management class that deals with installation and upgrades of both legacy and new handlers.
3.summary: Define new event dispatcher behaviour and implement it
description: 1/ Describe new event dispatcher 2/ Implement new event dispatching 3/ Add phpunit support for event observation
4.summary: Remove deprecated calls to get_plugin_types(), get_plugin_list() etc
description: After is integrated we need to: Get rid of the deprecated calls in core. Add much more docs about the deprecations, including in upgrade.txt
5.summary: Define and implement the event base class
description: Define the base class for the event system.
6.summary: check usage of class_exists to avoid usage of autoloading
description: Currently class_exits is not passing second parameter as false, in blocklib.php and pluginlib.php, because of which autoloader is called and hence can hit performance with autoloader functionality. Look at other usage of class_exists function and pass second param as false, where appropriate.
7.summary: Define the new observers API
description: Describe new observer definition - just few new flags in current db/events.php
8.summary: Decide how to deal with legacy events
description: See: The requirements are: 1/ 100 backwards compatibility - all existing events are triggered with the same data 2/ easy migration - the migration process should be easy for developers 3/ performance - in future we may way to disable legacy events completely with simple setting, there should not be any overhead when legacy events disabled
9.summary: Automatic class loading
description: It would be nice to have an official class loader for Frankenstyle based class names in Moodle core. See
10.summary: change observer priority handling
description: At present we calculate the priority of "" and observers of individual events together, I would like to propose to always first execute all "" ordered by priority and then all other observers sorted separately by priority. benefits: 1/ tiny bit faster when constructing the nested array of observers 2/ tiny less memory used because the cached list of handlers would be smaller ( would not be repeated) 3/ this would allow us to introduce observing of parent class events without breaking BC (if we ever want that in the future) problems: 1/ specific observers could not be executed first and could not be last The priority was introduced in order to allow the logging subsystems to process events as the first observer to eliminate data modifications from previous handlers. So far we did not find any other major use cases for the priority flag in observers - ideas?
|
End of preview. Expand
in Dataset Viewer.
Instruction Tuning Dataset (Split)
This dataset is a copy of the alvwjy/instruct_dataset. This is the split version of the dataset to training and testing which will be used for measuring the performance of the model.
- Downloads last month
- 33