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

(FC-68) Jswope00/Update Quickstart to Only use How-to snippets #840

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
+115 −284
Open

(FC-68) Jswope00/Update Quickstart to Only use How-to snippets #840

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
742da9d
docs: move sidebar_view_course_sections to learner
jswope00 Feb 19, 2025
cf7d7fa
Merge branch 'jswope00/reorg_educator_engagement_communication' into …
jswope00 Feb 19, 2025
165f730
docs: Update tags and refs for Learner Sidebar
jswope00 Feb 19, 2025
720185c
Merge branch 'jswope00/move-sidebar_view_course_sections-to-learner' …
jswope00 Feb 19, 2025
06fe5af
docs: Move Dashboard and Profile items to Learner Persona and Update …
jswope00 Feb 19, 2025
af9e659
docs: Move remaining "other" docs to more appropriate sections and re…
jswope00 Feb 19, 2025
656ad1c
docs: replace redundant "reusable" txt files with links to how-to doc…
jswope00 Feb 19, 2025
01d6f9f
Merge branch 'main' into jswope00/fix-see-also-links
jswope00 Feb 24, 2025
eccba06
Merge branch 'main' into jswope00/fix-see-also-links
jswope00 Mar 3, 2025
7a62a66
docs: Update Build a Course Quickstart Refs and change images from th…
jswope00 Mar 3, 2025
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
2 changes: 1 addition & 1 deletion source/educators/concepts/open_edx_platform/what_is_lms.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Studio.

:ref:`What is Studio` (concept)

:ref:`What is the Course Dashboard` (concept)
:ref:`About the Course Dashboard` (concept)

**Maintenance chart**

Expand Down
4 changes: 2 additions & 2 deletions source/educators/concepts/open_edx_platform/what_is_programs_page.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,15 @@ On the **Programs** page, you can perform the following actions.
.. seealso::


:ref:`What is the Course Dashboard` (concept)
:ref:`About the Course Dashboard` (concept)

:ref:`What is LMS` (concept)

:ref:`What is Studio` (concept)

:ref:`About the Course Outline` (concept)

:ref:`What is the User Profile Page` (concept)
:ref:`About the User Profile Page` (concept)

**Maintenance chart**

Expand Down
13 changes: 12 additions & 1 deletion source/educators/how-tos/add_multiple_choice.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,17 @@ This video explains how to add a multiple choice (also known as "single-select")

.. youtube:: ij5VHvY6jBk

.. START ADD MULTIPLE CHOICE PROBLEM

. In the unit where you want to place the text, select :guilabel:`Problem` at the bottom of the page.
.. sidebar:: Add Multiple Choice Problem

.. thumbnail:: /_images/Educators_add_multiple_choice.png

.. sidebar:: Edit Multiple Choice Problem

.. thumbnail:: /_images/Educators_edit_multiple_choice.png
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure how I feel about using sidebars and thumbnails. There's already a righthand and lefthand sidebar on the site, so this gets really crammed in on a laptop screen

image image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, I'm in favor of inline images for all images. I know that a lot of effort was put into the the original quickstart, but given the formatting changes it makes sense now to just shift the images from thumbnail to inline. I'll make the change.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Full size images are in the latest commit: 7a62a66


#. In the unit where you want to place the text, select :guilabel:`Problem` at the bottom of the page.

#. From the list of problem types, select :guilabel:`Multiple Choice`.

Expand All @@ -35,6 +44,8 @@ This video explains how to add a multiple choice (also known as "single-select")

#. Click :guilabel:`Save` to save the problem in the unit.

.. END ADD MULTIPLE CHOICE PROBLEM


.. seealso::

Expand Down
16 changes: 15 additions & 1 deletion source/educators/how-tos/course_development/add_video_to_course.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,16 @@ Add a Video

To add a video, follow these steps.

.. START ADD A VIDEO

.. sidebar:: Add Video

.. thumbnail:: /_images/Educators_add_video.png

.. sidebar:: Edit Video

.. thumbnail:: /_images/Educators_video_edit.png

#. From Studio, in the unit where you want to place the video, under **Add New Component** select :guilabel:`Video`.

A video with default settings is added to the unit.
Expand All @@ -16,7 +26,7 @@ To add a video, follow these steps.

#. In the **Component Display Name** field, enter the name that you want learners to see for this video.

This name appears as a heading above the video in the LMS, and it identifies the video for you in reports and analytics. If you do not enter a display name, the platform specifies “video” for you.
This name appears as a heading above the video in the LMS, and it identifies the video for you in reports and analytics. If you do not enter a display name, the platform specifies “video” for you.

#. Paste the video URL in the default Video URL field, and then enter the location of your video. This is the URL that was created when you uploaded the video to the hosting site.

Expand All @@ -37,6 +47,8 @@ This name appears as a heading above the video in the LMS, and it identifies the

#. Click :guilabel:`Save` to save the video in the unit.

.. END ADD A VIDEO


.. seealso::

Expand All @@ -51,6 +63,8 @@ This name appears as a heading above the video in the LMS, and it identifies the

:ref:`Create a Video` (how-to)

:ref:`Add a Transcript` (how-to)

:ref:`Specifying Additional Video Options <Additional Video Options>` (how-to)

:ref:`Add an In Video Quiz` (how-to)
Expand Down
23 changes: 22 additions & 1 deletion source/educators/how-tos/course_development/exercise_tools/add_text.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,15 @@
Add Text
########

.. START ADD TEXT

.. sidebar:: Add Text

.. thumbnail:: /_images/Educators_add_text.png

.. sidebar:: Edit Text

.. thumbnail:: /_images/Educators_edit_text.png

#. In the unit where you want to place the text, select :guilabel:`Text` at the bottom of the page.

Expand All @@ -22,11 +30,24 @@ Add Text

#. Click :guilabel:`Save` to save the text in the unit.

.. END ADD TEXT


.. seealso::

:ref:`Work with HTML code` (how-to)

:ref:`Working with Text Components` (reference)

:ref:`Create a Text Component` (how-to)

:ref:`Add Link to Website Course Unit or File` (how-to)

:ref:`Add an Image to a Text Component` (how-to)

:ref:`Full Screen Image` (reference)

:ref:`Embed an iframe in the Text Editor` (how-to)
:ref:`Paste without Formatting in a Text Component` (how-to)


**Maintenance chart**
Expand Down
10 changes: 10 additions & 0 deletions source/educators/how-tos/course_development/publish_from_outline.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,24 @@ To publish new and changed units, select the **Publish** icon for a section,
subsection, or unit. In the following example, the **Publish** icon is circled
for a section, subsection, and unit.

.. START PUBLISH COURSE

.. image:: /_images/educator_how_tos/outline-publish-icons.png
:alt: Publishing icons in the course outline.
:width: 500

#. Go back to the course outline.

You see the unit you created, within the subsection and section, in an unpublished state.

#. For the section, click the Publish icon (|Publish Icon|).

.. note::
The **Publish** icon only appears when there is new or changed content within
the object.

.. END PUBLISH COURSE

For more information, see the following topics.

* :ref:`Unit Publishing Status`
Expand Down
38 changes: 0 additions & 38 deletions source/educators/how-tos/reusable_content/add_html.txt
View file
Open in desktop

This file was deleted.

52 changes: 0 additions & 52 deletions source/educators/how-tos/reusable_content/add_multiple_choice.txt
View file
Open in desktop

This file was deleted.

53 changes: 0 additions & 53 deletions source/educators/how-tos/reusable_content/add_video.txt
View file
Open in desktop

This file was deleted.

31 changes: 0 additions & 31 deletions source/educators/how-tos/reusable_content/create_course.txt
View file
Open in desktop

This file was deleted.

28 changes: 0 additions & 28 deletions source/educators/how-tos/reusable_content/publish_course.txt
View file
Open in desktop

This file was deleted.

Loading