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.

Sign up for GitHub

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

Jump to bottom

FC-0068 docs: reference and how-tos reviewed by edunext 20 #771

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

FC-0068 docs: reference and how-tos reviewed by edunext 20 #771

wants to merge 2 commits into from

Conversation

Apgomeznext
Copy link
Contributor

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

@Apgomeznext
FC-0068 docs: reference and how-tos reviewed by edunext 20
1fa104c 
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 •
edited
Loading

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.

@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Jan 13, 2025
@Apgomeznext Apgomeznext marked this pull request as ready for review January 13, 2025 22:24
sarina
sarina requested changes Jan 14, 2025
View reviewed changes
source/educators/how-tos/communication/email_task_history_report.rst
@@ -0,0 +1,83 @@
.. _Email Task History Report:

Email Task History Report
Copy link
Contributor

Choose a reason for hiding this comment

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

This is a How To, the title should be "How To ...", maybe "Use the Email Task History Report"?

source/educators/how-tos/course_development/additional_video_options.rst
@@ -1,6 +1,5 @@
.. _Additional Video Options:

###################################
Specifying Additional Video Options
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Specifying Additional Video Options
Specify Additional Video Options

source/educators/how-tos/course_development/create_discussion.rst
@@ -11,7 +10,7 @@ components, such as videos or text, in the unit. A discussion component gives
learners a chance to respond to and interact with each other about a specific
subject.

Discussion topics that you create by adding discussion components in your
Discussion topics you create by adding discussion components in your
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Discussion topics you create by adding discussion components in your
Discussion topics that you create by adding discussion components in your

I am not sure why you removed the word "that" so often, but in American English, the word "that" is helpful and clarifying and I would not remove it. Most places are whatever, but in this place specifically I find the sentence much harder to read without it.

source/educators/references/communication/automatic_email.rst
#################################
Automatic Email Messages from edX
#################################
Automatic Email Messages from Open edX Instance
Copy link
Contributor

Choose a reason for hiding this comment

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

Do you know if these automatically send in all Open edX instances, or if these automatic emails were specifically on edx.org?

source/educators/references/communication/bulk_email.rst
have logged in within the last 18 months. This helps reduce the risk of
messages being marked as spam (or bouncing) and helps ensure the continued
delivery of bulk course email messages through edX's email providers.
delivery of bulk course email messages through Open edX's email providers.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
delivery of bulk course email messages through Open edX's email providers.
delivery of bulk course email messages through your instance's email providers.

source/educators/references/communication/example_bulk_emails.rst
@@ -164,7 +159,7 @@ You can use this template as a starting point for designing your own message,
omitting the discussion highlights if they are not appropriate for your course
(the example discussion highlights are from a course about urban solutions to
the global water crisis). Search for the values enclosed by {braces} and
replace them with information for your course. In addition, check that you are
replace them with information for your course. In addition, check you are
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
replace them with information for your course. In addition, check you are
replace them with information for your course. In addition, check that you are

source/educators/references/communication/example_bulk_emails.rst
@@ -208,7 +202,7 @@ and encourages contributions to the discussions. You may want to send out more
than one message while the course is running. You can use this template as a
starting point for your own messages; search for the values enclosed by
{braces} and replace them with information for your course. In
addition, check that you are using :ref:`keywords <Use Keywords in Messages>`
addition, check you are using :ref:`keywords <Use Keywords in Messages>`
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
addition, check you are using :ref:`keywords <Use Keywords in Messages>`
addition, check that you are using :ref:`keywords <Use Keywords in Messages>`

source/educators/references/communication/example_bulk_emails.rst
@@ -266,7 +259,7 @@ completion. This example lets learners know:
graders.

Be sure to search for the values enclosed by {braces} and replace them with
information for your course. In addition, check that you are using
information for your course. In addition, check you are using
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
information for your course. In addition, check you are using
information for your course. In addition, check that you are using

source/educators/references/communication/example_bulk_emails.rst
While you may see the link in a few days, it can take up to two weeks for
edX to generate all of the course certificates.
platform to generate all of the course certificates.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
platform to generate all of the course certificates.
all of the course certificates to be generated.

source/educators/references/course_development/about_course_wiki.rst
@@ -29,10 +28,6 @@ contribute to a repository of information about your course that can be
immediately useful to other learners, or useful for you and your course team as
you develop other courses or future runs of the same course.

The wiki for each course is a "child" wiki of the edX-wide wiki. From within
any course wiki, select the top level **Wiki** link in the breadcrumb trail
at the top of the page to visit the edX-wide wiki.
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 leave this in, because it's an unexpected and odd behavior. Reword as:

The wiki for each course is a "child" wiki of the single wiki that exists for your
whole instance. From within any course wiki, select the top level **Wiki** link
in the breadcrumb trail at the top of the page to visit the instance-wide wiki.

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

@sarina sarina sarina requested changes

@jswope00 jswope00 Awaiting requested review from jswope00

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Status: Waiting on Author
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Apgomeznext @openedx-webhooks @sarina @mphilbrick211