edx-platform icon indicating copy to clipboard operation
edx-platform copied to clipboard

feat: add necessary models for Openedx survey report

Open Alec4r opened this issue 3 years ago • 4 comments

Description:

This PR adds the model needed to manage the report with the openedx instance data that will be sent to Openedx API, in accordance with the queries sent to the community to gathering impact data on Open edX Instances.

Also, this PR contains the methods to get the data from django models

https://github.com/eduNEXT/edx-platform/pull/286

  • https://github.com/eduNEXT/edx-platform/pull/285

  • https://github.com/eduNEXT/edx-platform/pull/284

  • https://github.com/eduNEXT/edx-platform/pull/283

  • https://github.com/eduNEXT/edx-platform/pull/282

  • https://github.com/eduNEXT/edx-platform/pull/288

  • https://github.com/eduNEXT/edx-platform/pull/287

And, contains the extra data setting: https://github.com/eduNEXT/edx-platform/pull/288 and unit tests https://github.com/eduNEXT/edx-platform/pull/290


The discovery was done by tCrill team and was discussed by tCrill Team and eduNEXT Team.

ISSUE:

https://github.com/openedx/tcril-engineering/issues/349

APPROVED DESIGN:

https://docs.google.com/document/d/1tm1O5BQsAwekphI5IN9pBn8behQDZigXePLGqCl5he8

ToDo

  • [x] Query methods
  • [x] CLI Commmand
  • [ ] Survey report admin model
  • [ ] Feature flag

Merge checklist:

  • [ ] Documentation updated
  • [ ] CI build is green
  • [ ] Unit tests
  • [ ] Commits are squashed

Alec4r avatar Oct 20 '22 16:10 Alec4r

Thanks for the pull request, @Alec4r! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

openedx-webhooks avatar Oct 20 '22 16:10 openedx-webhooks

@felipemontoya @ormsbee @jmakowski1123 @mariajgrimaldi We would appreciated your comments in this PR.

Alec4r avatar Oct 27 '22 12:10 Alec4r

Thanks for this PR! in addition to the specific items listed, could you please add a top level README.rst for this app that explains what the purpose of the app is and why we decided to put it in edx-platform?

From a product perspective, the purpose of the app is: To enable collection of aggregated, anonymized data about Open edX courses at scale, so that we can begin to track the growth and trends in Open edX usage over time, namely in the annual Open edX Impact Report. We wish to be able to answer questions such as:

How many unique courses are currently being offered across the Open edX ecosystem? How many learners are currently registered on an Open edX Instance? How many learners are currently using an Instance? How many learners are currently enrolled in an Open edX course? How many learners have completed an Open edX course?

jmakowski1123 avatar Oct 28 '22 16:10 jmakowski1123

@mariajgrimaldi This is a tCRIL funded projected (not an edX Blended Dev project). The code is FC-0005

jmakowski1123 avatar Oct 28 '22 16:10 jmakowski1123

Just some minor requests and questions. Looks close to merging.

It doesn't have to be this PR, but please consider adding an admin.py module at some point so that operators can look at the information that's been collected.

We are working on this (https://github.com/eduNEXT/edx-platform/pull/292), I hope to merge those changes here today.

Alec4r avatar Nov 09 '22 16:11 Alec4r

Hello! I left a few comments (non-blocking); I hope they're helpful. Great job!

mariajgrimaldi avatar Nov 10 '22 15:11 mariajgrimaldi

We are working on this (https://github.com/eduNEXT/edx-platform/pull/292), I hope to merge those changes here today.

I would argue that we better not merge into this PR. Instead make a new PR to edx-platform so that we can merge this once we agree on the model. The discussion on the admin page should not hold the model PR.

felipemontoya avatar Nov 10 '22 20:11 felipemontoya

@Alec4r we have green light. One final thing. Could you please squash the branch so instead of 25, we merge only one commit with the whole feature in the tree.

felipemontoya avatar Nov 15 '22 22:11 felipemontoya

Sorry @Alec4r, no need. I can squash and merge from the UI.

felipemontoya avatar Nov 15 '22 22:11 felipemontoya

@Alec4r 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

openedx-webhooks avatar Nov 15 '22 22:11 openedx-webhooks

EdX Release Notice: This PR has been deployed to the staging environment in preparation for a release to production.

edx-pipeline-bot avatar Nov 16 '22 00:11 edx-pipeline-bot

EdX Release Notice: This PR has been deployed to the production environment.

edx-pipeline-bot avatar Nov 16 '22 00:11 edx-pipeline-bot