Skip to content

docs: add more details to the survey report README - #33623

Merged
felipemontoya merged 3 commits into
openedx:masterfrom
eduNEXT:mfmz/update-readme-survey-report
Dec 19, 2023
Merged

docs: add more details to the survey report README#33623
felipemontoya merged 3 commits into
openedx:masterfrom
eduNEXT:mfmz/update-readme-survey-report

Conversation

@MaferMazu

Copy link
Copy Markdown
Contributor

Description

This PR only adds extra information to the Survey Report Django App in the README.

Supporting information

Context of the project FC-0005 - Openedx Survey Report Djangoapp

Testing instructions

You can see the GitHub view here: https://github.com/eduNEXT/edx-platform/tree/mfmz/update-readme-survey-report/openedx/features/survey_report#survey-report

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

openedx-webhooks commented Oct 31, 2023

Copy link
Copy Markdown

Thanks for the pull request, @MaferMazu! 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.

@MaferMazu

Copy link
Copy Markdown
Contributor Author

@Alec4r @Asespinel @wlvasquez Every feedback you can provide will be helpful 🙌

@MaferMazu
MaferMazu requested a review from ormsbee November 28, 2023 15:07
@MaferMazu
MaferMazu force-pushed the mfmz/update-readme-survey-report branch from 18e66a1 to f09e52f Compare November 28, 2023 15:08
@MaferMazu

Copy link
Copy Markdown
Contributor Author

@ormsbee @mariajgrimaldi @felipemontoya, could you please help me review this PR?

Comment thread openedx/features/survey_report/README.rst Outdated
@Asespinel

Copy link
Copy Markdown
Contributor

Hi @MaferMazu thanks for the documentation. I was thinking that we could add a screenshot of the new banner and ahcve a small description on how it works. Something like: "the banner will appear automatically if a survey report hasn't been sent in a month". What do you think?

@MaferMazu
MaferMazu force-pushed the mfmz/update-readme-survey-report branch from cd44df5 to 75c4f17 Compare December 13, 2023 21:06
@MaferMazu
MaferMazu force-pushed the mfmz/update-readme-survey-report branch from 75c4f17 to c74ead2 Compare December 13, 2023 21:09
@MaferMazu

MaferMazu commented Dec 13, 2023

Copy link
Copy Markdown
Contributor Author

Thanks, @Asespinel, for your review.

When we merge #33633, we can merge this PR @ormsbee.

@MaferMazu

Copy link
Copy Markdown
Contributor Author

I think we can merge this.

cc @ormsbee @Alec4r @felipemontoya

@felipemontoya
felipemontoya merged commit 7a15d36 into openedx:master Dec 19, 2023
@openedx-webhooks

Copy link
Copy Markdown

@MaferMazu 🎉 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

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

@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

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

@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

Alec4r pushed a commit to eduNEXT/edx-platform that referenced this pull request Feb 29, 2024
* docs: add more details to the survey report README

* docs: improve the doc with numbered steps, bold and capitalize words

* docs: add more information about the survey report banner
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.

7 participants