Skip to content

[FC-005] feat: add necessary models for Openedx survey report - #31183

Merged
felipemontoya merged 25 commits into
openedx:masterfrom
eduNEXT:survey_report
Nov 15, 2022
Merged

[FC-005] feat: add necessary models for Openedx survey report#31183
felipemontoya merged 25 commits into
openedx:masterfrom
eduNEXT:survey_report

Conversation

@Alec4r

@Alec4r Alec4r commented Oct 20, 2022

Copy link
Copy Markdown
Contributor

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

eduNEXT#286

And, contains the extra data setting: eduNEXT#288 and unit tests eduNEXT#290


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

ISSUE:

openedx/axim-engineering#349

APPROVED DESIGN:

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

ToDo

  • Query methods
  • CLI Commmand
  • Survey report admin model
  • Feature flag

Merge checklist:

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

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Oct 20, 2022
@openedx-webhooks

openedx-webhooks commented Oct 20, 2022

Copy link
Copy Markdown

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.

@Henrrypg
Henrrypg force-pushed the survey_report branch 3 times, most recently from 52ee80a to 5d7fb71 Compare October 21, 2022 15:01
@Alec4r
Alec4r marked this pull request as ready for review October 27, 2022 12:11
@Alec4r

Alec4r commented Oct 27, 2022

Copy link
Copy Markdown
Contributor Author

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

@ormsbee ormsbee left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Comment thread openedx/features/survey_report/models.py Outdated
Comment thread openedx/features/survey_report/models.py Outdated
Comment thread openedx/features/survey_report/models.py Outdated
Comment thread openedx/features/survey_report/queries.py
Comment thread openedx/features/survey_report/queries.py
Comment thread openedx/features/survey_report/queries.py Outdated
Comment thread openedx/features/survey_report/queries.py Outdated
Comment thread openedx/features/survey_report/queries.py Outdated
Comment thread openedx/features/survey_report/queries.py Outdated
Comment thread openedx/features/survey_report/application.py
@jmakowski1123

Copy link
Copy Markdown

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

Copy link
Copy Markdown

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

Comment thread openedx/features/survey_report/models.py
@Alec4r
Alec4r requested review from felipemontoya and ormsbee and removed request for ormsbee November 4, 2022 20:27
@Alec4r
Alec4r requested review from felipemontoya, mariajgrimaldi and ormsbee and removed request for felipemontoya, mariajgrimaldi and ormsbee November 11, 2022 16:24

@felipemontoya felipemontoya left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for all the updates @Alec4r . From my side everything has been addressed and we are good to go.

Thanks also @Henrrypg

@mariajgrimaldi mariajgrimaldi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks exciting! Thank you so much. Great job!

@felipemontoya

Copy link
Copy Markdown
Member

@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

Copy link
Copy Markdown
Member

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

@felipemontoya
felipemontoya merged commit bfd212b into openedx:master Nov 15, 2022
@openedx-webhooks

Copy link
Copy Markdown

@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.

@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

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

@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

9 participants