Skip to content

feat: add django admin page for survey report - #31323

Merged
felipemontoya merged 9 commits into
openedx:masterfrom
eduNEXT:survey_report_admin_site
Nov 30, 2022
Merged

feat: add django admin page for survey report#31323
felipemontoya merged 9 commits into
openedx:masterfrom
eduNEXT:survey_report_admin_site

Conversation

@Alec4r

@Alec4r Alec4r commented Nov 21, 2022

Copy link
Copy Markdown
Contributor

Description:

This PR adds the django model admin to visualize the data from the SurveyReport model (#31183).

ISSUE:
openedx/axim-engineering#349

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

DECISIONS:

  • We removed the add and save buttons because the user shouldn't to create or edit the original report data to protect data consistency.

How to test

With a dev environment running, you should run the command:

python manage.py lms generate_report

and you could check the reports in /admin/survey_report/surveyreport/

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

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.

@Alec4r

Alec4r commented Nov 22, 2022

Copy link
Copy Markdown
Contributor Author

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

Comment thread openedx/features/survey_report/admin.py
@mariajgrimaldi

Copy link
Copy Markdown
Member

can you include how to generate the survey reports to check them in the admin? thanks

Comment thread openedx/features/survey_report/admin.py
Comment thread openedx/features/survey_report/admin.py Outdated

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

I think that we should use this PR to also add the help_text field to the django model. This could help reduce the confusion with what each fields exactly represents.

@Alec4r

Alec4r commented Nov 25, 2022

Copy link
Copy Markdown
Contributor Author

I think that we should use this PR to also add the help_text field to the django model. This could help reduce the confusion with what each fields exactly represents.

Done, I have added a form and help_text for each field, I used the same message from model comments.

@Alec4r

Alec4r commented Nov 25, 2022

Copy link
Copy Markdown
Contributor Author

@mariajgrimaldi @felipemontoya the tests are failing in master, what I have to do?

@felipemontoya

Copy link
Copy Markdown
Member

@Alec4r you can update to the latest master and leave it be. On monday a lot of people return from PTO and we can get better support.

@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 good to me! Can you rebase with master so we can merge?

Comment thread openedx/features/survey_report/admin.py Outdated
@felipemontoya
felipemontoya merged commit cd54e8b into openedx:master Nov 30, 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.

5 participants