Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FC-0068 docs: reference and how-tos reviewed by edunext 21 #772

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Apgomeznext
Copy link
Contributor

@Apgomeznext Apgomeznext commented Jan 13, 2025

This PR modifies how-to and reference documents migrated from the legacy repositories to the educators' documentation.

This PR modifies how-to and reference4 documents migrated from the legacy repositories to the educators' documentation.
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 13, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Jan 13, 2025

Thanks for the pull request, @Apgomeznext!

This repository is currently maintained by @openedx/docs-openedx-org-maintainers.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.


Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@Apgomeznext Apgomeznext marked this pull request as ready for review January 13, 2025 23:17
########################

.. tags:: educator, how-to

Copy link
Contributor

Choose a reason for hiding this comment

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

I would add in the Note from the Reference to this page as well, because it's important.

.. note:: Creating a poll requires you to export your course, edit some of
 your course's XML files in a text editor, and then re-import your course. We
 recommend that you create a backup copy of your course before you create the
 poll. We also recommend that you only edit the files that will contain polls
 in the text editor if you are very familiar with editing XML.


For more information about accessing learner data, see :ref:`Learner Data`.

Download Data from Qualtrics
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't see why this is here. This either

(a) refers to the Qualtrics survey tool, in which case I don't see why you'd put these instructions next to the instructor dashboard instructions;

(b) refers to something edx.org-specific

I don't know which. @jswope00 - any ideas? This section seems incongruous with the above section on downloading data from the instructor dashboard.

@@ -154,6 +155,7 @@ Qualtrics Survey Tool

../how-tos/course_development/exercise_tools/add_qualtrics_survey.rst
../references/course_development/exercise_tools/view_qualtrics_responses.rst
../how-tos/course_development/exercise_tools/download_data_instructor_dashboard.rst
Copy link
Contributor

Choose a reason for hiding this comment

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

Downloading data from the instructor dashboard should be under Course Data, no? https://docs.openedx.org/en/latest/educators/navigation/data_analytics.html @jswope00


.. tags:: educator, reference

.. note:: Alternatively, you can use OLX to enable the poll tool.
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't understand why this note was added, without a link to the alternative option. What should I do with this note?

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
Status: Needs Triage
Development

Successfully merging this pull request may close these issues.

3 participants