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

Jswope00/migrate learner docs #828

Merged
merged 21 commits into from
Feb 18, 2025
Merged
Show file tree
Hide file tree
Changes from 17 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added source/_images/learners/Calc_Closed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/learners/Calc_Open_InfoPage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/learners/CourseCard_StartDate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/learners/EntEx_LandingPage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/learners/HTMLandDisc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/learners/LMS_Unit_Page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/learners/LearnDash_GearIcon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/learners/Math1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/learners/Math2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/learners/Math4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/learners/Math5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/learners/Mob_FullScreenIcon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/learners/ORA_1YourResponse.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/learners/ORA_2LearnToAssess.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/learners/ORA_3PeerAssmt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/learners/ORA_Rubric.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/learners/ORA_Steps.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/learners/ORA_TopResponses.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/learners/ORA_ViewYourScore.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/learners/PrereqAboutPage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/learners/ProfileBadgesShare.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/learners/Progress_Chart.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/learners/Progress_Details.png
Binary file added source/_images/learners/SFD_BadgeShareButton.png
Binary file added source/_images/learners/SFD_Bkmk_PgsBkmkd.png
Binary file added source/_images/learners/SFD_Bkmk_UnitButton.png
Binary file added source/_images/learners/SFD_BookmarksLink.png
Binary file added source/_images/learners/SFD_Cert_web.png
Binary file added source/_images/learners/SFD_Mobile_Menu.png
Binary file added source/_images/learners/SFD_Mobile_View_Cert.png
Binary file added source/_images/learners/SFD_Prereq_Locked.png
Binary file added source/_images/learners/SFD_Prereq_Unlocked.png
Binary file added source/_images/learners/SFD_Profile_Full.png
Binary file added source/_images/learners/SFD_Profile_Limited.png
Binary file added source/_images/learners/SFD_SN_EditDeleteNote.png
Binary file added source/_images/learners/SFD_SN_NoteEditor.png
Binary file added source/_images/learners/SFD_SN_NotesPage.png
Binary file added source/_images/learners/SFD_SN_NotesShowHide.png
Binary file added source/_images/learners/ShowHideTimer.png
Binary file added source/_images/learners/Teams_JoinTeamButton.png
Binary file added source/_images/learners/Teams_LeaveTeam.png
Binary file added source/_images/learners/Teams_SearchTeams.png
Binary file added source/_images/learners/Teams_TeamsDetails.png
Binary file added source/_images/learners/Video_Intro.png
Binary file added source/_images/learners/Video_language_menu.png
Binary file added source/_images/learners/add_image_dialogue.png
Binary file added source/_images/learners/anonymous_post_card.png
Binary file added source/_images/learners/answer_label.png
Binary file added source/_images/learners/bell_and_tray.png
Binary file added source/_images/learners/dashboard_menu.png
Binary file added source/_images/learners/discussion_page.png
Binary file added source/_images/learners/filter_menu.png
Binary file added source/_images/learners/gear_icon.png
Binary file added source/_images/learners/google-calendar.png
Binary file added source/_images/learners/google-spreadsheet.png
Binary file added source/_images/learners/learner_video_license.png
Binary file added source/_images/learners/pi_correct_answer.png
Binary file added source/_images/learners/pi_final_response.png
Binary file added source/_images/learners/pi_histogram.png
Binary file added source/_images/learners/pi_review.png
Binary file added source/_images/learners/pin_post_icon.png
Binary file added source/_images/learners/post_actions_menu.png
Binary file added source/_images/learners/timed-exam-icon.png
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ them available to learners as a course handout file or on a defined page in
your course. These guidelines can define your expectations and optionally
introduce features of Open edX discussions.

You can also refer learners to the `course discussions index`_ section in the *Open EdX Learner's Guide*. Consider referring learners
You can also refer learners to the :ref:`course discussions index` section in the *Open EdX Learner's Guide*. Consider referring learners
in your courses to that section, which describes the structure and features of
Open edX course discussions, and provides useful information to help learners make
the most of their participation in course discussions.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To prepare learners for a proctored exam, follow these guidelines:
* Well before the exam, provide learners with information about the grading
policy in your course.
* Explain what proctored exams are, and provide learners with links to the
`OE SFD Proctored Exams`_ topic in the *Open edX
:ref:`OE SFD Proctored Exams` topic in the *Open edX
Learner’s Guide*.
* Communicate the rules for proctored exams, including the :ref:`Online Proctoring Rules` in the *Open edX Learner’s
Guide* as well as any specific rules for a particular exam. For information
Expand All @@ -30,7 +30,7 @@ The learner experience of a proctored exam depends on the proctoring service
that your course or organization uses. Typically, learners can expect to
download and install proctoring software, verify their identities, and use
their webcams to scan the testing environment before they take the exam. For
more information, see `OE SFD Proctored Exams`_ in the *Open
more information, see :ref:`OE SFD Proctored Exams` in the *Open
edX Learner's Guide*.

.. _Practice Proctored Exams:
Expand Down
4 changes: 2 additions & 2 deletions source/educators/how-tos/advanced_features/create_teams.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _Create a Team:
.. _Educator Create a Team:

Create a Team
#############
Expand Down Expand Up @@ -65,7 +65,7 @@ To create a team, follow these steps.

:ref:`Enable and Configure Teams` (how-to)

:ref:`Search for a Team` (how-to)
:ref:`Educator Search for a Team` (how-to)

:ref:`Edit a Team` (how-to)

Expand Down
4 changes: 2 additions & 2 deletions source/educators/how-tos/advanced_features/delete_teams.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,9 @@ To delete a team, follow these steps.

:ref:`Enable and Configure Teams` (how-to)

:ref:`Create a Team` (how-to)
:ref:`Educator Create a Team` (how-to)

:ref:`Search for a Team` (how-to)
:ref:`Educator Search for a Team` (how-to)

:ref:`Edit a Team` (how-to)

Expand Down
2 changes: 1 addition & 1 deletion source/educators/how-tos/advanced_features/edit_teams.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ To edit a team's details, follow these steps.

:ref:`Enable and Configure Teams` (how-to)

:ref:`Create a Team` (how-to)
:ref:`Educator Create a Team` (how-to)

:ref:`Remove Learner from Team` (how-to)

Expand Down
4 changes: 2 additions & 2 deletions source/educators/how-tos/advanced_features/enable_teams.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ To change access to the course team configuration options, follow these steps.

:ref:`Managing Teams via CSV Upload` (reference)

:ref:`Create a Team` (how-to)
:ref:`Educator Create a Team` (how-to)

:ref:`Search for a Team` (how-to)
:ref:`Educator Search for a Team` (how-to)

:ref:`Edit a Team` (how-to)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@ To remove a learner from a team, follow these steps.

:ref:`Enable and Configure Teams` (how-to)

:ref:`Create a Team` (how-to)
:ref:`Educator Create a Team` (how-to)

:ref:`Search for a Team` (how-to)
:ref:`Educator Search for a Team` (how-to)

:ref:`Edit a Team` (how-to)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _Search for a Team:
.. _Educator Search for a Team:

Search for a Team
#################
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ This section describes how you can contribute to the course wiki.
:depth: 2
:local:

.. START MANAGING WIKI ARTICLES

*********************
Adding a Wiki Article
Expand Down Expand Up @@ -150,6 +151,8 @@ Combine a Current Version with a Previous Version
#. Select **Merge selected with current** to combine the current and the
selected versions.

.. END MANAGING WIKI ARTICLES

.. seealso::


Expand Down
8 changes: 1 addition & 7 deletions source/educators/how-tos/share_courses_social_media.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@ Sharing Your Courses on Social Media
On your dashboard, you can share the courses you are enrolled in on social
media sites such as Facebook and Twitter.

.. only:: Open_edX

This feature is available only if it has been enabled by your course provider.
This feature is available only if it has been enabled by your course provider.

#. Sign in to the social media site on which you want to share your course
enrollment.
Expand All @@ -27,10 +25,6 @@ media sites such as Facebook and Twitter.
#. Select the appropriate button to publish your message on the social media
site.

.. _Explore edX Programs:

.. only:: Partners


.. seealso::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ specifications, how to add video content to your course, and how to specify
options for your videos.

For more information about how learners can interact with course videos, see
`Video Player`_.
:ref:`Video Player`.

.. important::

Expand All @@ -35,7 +35,7 @@ components, you add the name and location of your video, as well as the video
transcript. Learners view your videos in the LMS.

For information about the way learners interact with videos, see
`Video Player`_.
:ref:`Video Player`.

For more information about adding videos to your course, see :ref:`Add a Video`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ learner and the numerical expression that results.
the n minus 1 power.

For more information about how learners enter expressions, see
`Math Formatting`_ in the *Open edX Learner's Guide*.
:ref:`Math Formatting` in the *Open edX Learner's Guide*.

Some of the options for numerical input problems include the following.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ For more information about specifying rules, see
.. Open edX.


.. _Know Rules for Online Proctoring:
.. _Educator Know Rules for Online Proctoring:

****************************************
Learner Rules for Online Proctored Exams
Expand Down Expand Up @@ -113,7 +113,7 @@ Your Behavior
#. You must not leave the room during the exam for any reason, unless posted
rules for the exam specifically permit you to do so.

.. _Request Additional Time:
.. _Educator Request Additional Time:

=====================================
Additional Time or Special Allowances
Expand Down
4 changes: 3 additions & 1 deletion source/educators/references/resources_for_students.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _Resources for Open edX Learners:

###############################
Resources for Open edX Learners
###############################
Expand Down Expand Up @@ -33,7 +35,7 @@ these options for getting an answer.
**Discussion** page, or post a question about it yourself. Your comments and
questions give the course team useful feedback for improving the course.

* Investigate other resources. Some courses have a `SFD Wiki`_,
* Investigate other resources. Some courses have a :ref:`SFD Wiki`,
which can be a good source of information. Outside of the course, a
course-specific social media (ex: Facebook group) or messaging community (ex: Discord) might be available for
learners to share information.
Expand Down
1 change: 1 addition & 0 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Open edX Documentation

Community <community/index>
Educators <educators/index>
Learners <learners/index>
Site Operators <site_ops/index>
Developers <developers/index>
Documentors <documentors/index>
Expand Down
182 changes: 182 additions & 0 deletions source/learners/OpenSFD_certificates.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,182 @@
.. _Certificates:

######################################
Getting a Course Certificate or Badge
######################################

.. The edX Learner's Guide also includes a Certificates topic, but it has no
.. shared content with this topic and there is no "Certificates" file in the
.. Shared folder.

Your course might be set up to issue certificates as evidence that you
successfully completed the course. Different types of certificates might be
available for courses you take. For information about the certificates that
your course offers, contact the course team or institution that created your
course.

In addition, you might be able to earn badges for achievements such as
completing a course or a series of courses, or for participating in course
activities. The badges that you can earn depend on how badges have been set up
for the course platform that you are taking a course on.

.. contents::
:depth: 1
:local:

***********************
Accessing a Certificate
***********************

Some courses issue certificates, which you can access from your dashboard.

The following examples show the **View Certificate** option on a learner
dashboard on the edx.org website and on the mobile app.

.. image:: /_images/learners/SFD_Cert_web.png
:width: 600
:alt: Dashboard with course name, grade, and link to the web certificate.

.. image:: /_images/learners/SFD_Mobile_View_Cert.png
:width: 300
:alt: "View certificate" button on the mobile app course page.

To open a web certificate in your browser, select **View Certificate**. You can
then share or print your web certificate.

============================
Share a Web Certificate
============================

You can share your web certificates on Facebook, LinkedIn, and Twitter.

#. Make sure that you are logged in to the social site on which you want to
share your web certificate.

#. In a different browser tab or window, open your web certificate.

#. Select the social icon at the top of your web certificate.

A dialog box for the social site you selected opens, with the certificate
URL already entered.

On the mobile app, select the **Share** icon to open a page from which you
choose the social network to share your certificate to.

.. image:: /_images/learners/SFD_Mobile_SocialShare.png
:width: 300
:alt: Choose the social network to which you want to share your certificate.

#. Complete the steps for the social site to post your web certificate.

.. _Print a Web Certificate:

============================
Print a Web Certificate
============================

To print a web certificate, follow these steps.

#. Open the web certificate in your browser.

#. In the web certificate header, select **Print Certificate**.

To print your web certificate in the most professional looking format, follow
these guidelines.

* Do not print the header or footer. Depending on your system, you might need
to clear these print options.

* Set the margins to the minimum space available. Depending on your system, you
might need to select the **Minimum** option for the margins.


.. _View Earned Badges:

***************************************
Viewing Earned Badges in Your Profile
***************************************

If badges are available for your courses, you can see the badges you have
earned in the **Accomplishments** section of your profile.

.. image:: /_images/learners/ProfileAccomplishmentsTab.png
:width: 400
:alt: A user profile showing the Accomplishments tab

.. _Sharing Badges:

************************************************
Sharing Badges on Mozilla Backpack
************************************************

You can share any badge that you earned, including certificate badges, to a
badging site such as Mozilla Backpack.

===============================
Share Badges From Your Profile
===============================

To share badges from your profile to the Mozilla Backpack site, follow these
steps.

.. note:: You have to create an account on Mozilla Backpack before you can share
your badges.

#. On your profile, select **Accomplishments**.

#. For the badge that you want to share, select **Share**, or on the edX mobile
apps, select the **Share** icon.

The following examples show the **Share** options for badges on the edx.org
website and on the mobile app.

.. image:: /_images/learners/ProfileBadgesShare.png
:alt: The Mozilla Backpack share button is available for each badge on the
Accomplishments section of your user profile page.

.. image:: /_images/learners/SFD_Mobile_Profile_Accomplishments.png
:width: 300
:alt: Choose the social network to which you want to share your certificate.

You see instructions for downloading your badge and then sharing it on
the Mozilla Backpack site.

.. image:: /_images/learners/SFD_MozillaBackpackShareDialog.png
:width: 500
:alt: Dialog with instructions that opens when you select the Mozilla
Backpack share icon.


=========================
Share Certificate Badges
=========================

Some courses that offer web certificates allow you to download a badge that
represents the certificate, and then share that badge on a badging site such
as Mozilla Backpack. You can download your badge as soon as your web
certificate appears on your dashboard. Many courses distribute web
certificates within two weeks of the course end date.

To share your web certificate on the Mozilla Backpack site, follow these steps.

#. On your dashboard, locate the course that you want, and then select **View
Certificate**.

If this option is not available, the course might not have distributed
certificates yet. Check your dashboard again in a few days.

#. On the certificate web page, select the badge sharing icon.

.. image:: /_images/learners/SFD_BadgeShareButton.png
:width: 600
:alt: Icon bar at the top of the certificate web view, showing the
Mozilla Backpack share icon.

You see instructions for downloading your badge and then sharing it on
the Mozilla Backpack site. You have to create an account on Mozilla
Backpack before you can share your badge.

.. image:: /_images/learners/SFD_MozillaBackpackShareDialog.png
:width: 500
:alt: Dialog with instructions that opens when you select the Mozilla
Backpack share icon.
Loading