FC-0068 docs: how-to cleaning by edunext #14 #758

BryanttV · 2025-01-08T22:50:23Z

This PR modifies a series of how-to documents migrated from the legacy repositories to the educators' documentation.

The updated files were:

create_image_mapped_input.rst
adding_math_expresion_problems.rst
add_multiselect_partial_credit.rst
enable_notes.rst
edit_numerical_input_advanced.rst
add_checkbox.rst
enable_lti_component.rst. This file was divided and the following files were created:
- setting_up_lti_1_1_component.rst
- setting_up_lti_1_3_component.rst
- using_lti_advantage_features.rst
adding_multi_select.rst. This file was divided and the following file was created:
- editing_multi_select_using_advanced_editor.rst
award_partial_credit_numerical_input.rst. This file was divided and the following file was created:
- adding_text_in_numeric_response_field.rst

openedx-webhooks · 2025-01-08T22:50:27Z

Thanks for the pull request, @BryanttV!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/docs-openedx-org-maintainers. Tag them in a comment and let them know that your changes are ready for review.

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.

sarina · 2025-01-09T19:00:44Z

source/educators/how-tos/course_development/exercise_tools/add_multi_select_partial_credit.rst

@@ -1,8 +1,7 @@
 .. _Awarding Partial Credit in a Multi select Problem:

-=============================
 Awarding Partial Credit


Suggested change

Awarding Partial Credit

Award Partial Credit

You should be able to put "How To" in front of these titles and it should make sense ("How To Award Partial Credit", not "How To Awarding Partial Credit"

Thanks for the explanation! I will make sure to keep it in mind for future changes.
I updated the files: 83df8b2

@sarina, Should we also update the tags? This would also mean updating the :ref: commands.

sarina · 2025-01-09T19:01:02Z

source/educators/how-tos/course_development/exercise_tools/adding_math_expression_problem.rst


-**************************************
 Adding a Math Expression Input Problem


Suggested change

Adding a Math Expression Input Problem

Add a Math Expression Input Problem

sarina · 2025-01-09T19:01:11Z

source/educators/how-tos/course_development/exercise_tools/adding_multi_select.rst


-******************************
 Adding a Multi-select Problem


Suggested change

Adding a Multi-select Problem

Add a Multi-select Problem

sarina · 2025-01-09T19:01:27Z

...ducators/how-tos/course_development/exercise_tools/adding_text_in_numeric_response_field.rst

@@ -0,0 +1,66 @@
+.. _Adding Text After the Numeric Response Field:
+
+Adding Text after the Numeric Response Field


Suggested change

Adding Text after the Numeric Response Field

Add Text after the Numeric Response Field

sarina · 2025-01-09T19:01:47Z

...educators/how-tos/course_development/exercise_tools/award_partial_credit_numerical_input.rst

@@ -1,8 +1,7 @@
 .. _Awarding Partial Credit in a Numerical Input Problem:

-=========================================
 Awarding Partial


Suggested change

Awarding Partial

Award Partial Credit in a Numerical Input Problem

sarina · 2025-01-09T19:02:58Z

...ors/how-tos/course_development/exercise_tools/editing_multi_select_using_advanced_editor.rst

@@ -0,0 +1,162 @@
+.. _Editing Multi select Problems using the Advanced Editor:


Suggested change

.. _Editing Multi select Problems using the Advanced Editor:

.. _Edit Multi select Problems using the Advanced Editor:

sarina · 2025-01-09T19:03:30Z

source/educators/how-tos/course_development/exercise_tools/enable_lti_component.rst

@@ -1,8 +1,7 @@
 .. _enable_lti_components:

-******************************************
 Enabling LTI Components for a Course


Suggested change

Enabling LTI Components for a Course

Enable LTI Components for a Course

sarina · 2025-01-09T19:03:48Z

source/educators/how-tos/course_development/exercise_tools/enable_notes.rst

@@ -1,8 +1,7 @@
 .. _Notes Tool:

-##############################
 Notes Tool


Suggested change

Notes Tool

Enable the Notes Tool

sarina · 2025-01-09T19:04:34Z

source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1_1_component.rst

@@ -0,0 +1,145 @@
+.. _Setting up a LTI 1.1 component:
+
+Setting up an LTI 1.1 component


Suggested change

Setting up an LTI 1.1 component

Set up an LTI 1.1 component

sarina · 2025-01-09T19:05:15Z

source/educators/how-tos/course_development/exercise_tools/using_lti_advantage_features.rst

@@ -0,0 +1,130 @@
+.. _Enabling and using LTI Advantage features:
+
+Enabling and using LTI Advantage features


Suggested change

Enabling and using LTI Advantage features

Enable and Use LTI Advantage features

BryanttV added 10 commits January 8, 2025 17:48

docs: update 'create_image_mapped_input.rst' file

0bb4ae1

docs: update 'enable_lti_component.rst' file

091bf2a

docs: update 'adding_math_expresion_problems.rst' file

539c75e

docs: update 'add_multiselect_partial_credit.rst' file

93ca2dd

docs: update 'enable_notes.rst' file

fe5f253

docs: update 'edit_numerical_input_advanced.rst' file

607ffe4

docs: remove note to edx in 'enable_notes.rst' file

3721839

docs: update 'add_checkbox.rst' file

acb4342

docs: update and split 'adding_multi_select.rst' file

bcbb24e

docs: update and split 'award_partial_credit_numerical_input.rst' file

2781afd

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 8, 2025

BryanttV added 2 commits January 8, 2025 18:16

fix: replace '.' by '_' in the file names

e5d55d6

fix: remove blank space in the filename

e4ea2e9

sarina requested changes Jan 9, 2025

View reviewed changes

docs: replace adding by add in tags

fbb67b4

BryanttV force-pushed the bav/educators_documentation_review_edunext_15 branch from b232803 to fbb67b4 Compare January 9, 2025 19:06

fix(docs): adjust titles for consistency with 'How To' phrasing

83df8b2

BryanttV requested review from sarina and Apgomeznext January 10, 2025 14:40

fix(docs): add missing tag and update :ref: command

cfff858

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FC-0068 docs: how-to cleaning by edunext #14 #758

FC-0068 docs: how-to cleaning by edunext #14 #758

BryanttV commented Jan 8, 2025 •

edited

Loading

openedx-webhooks commented Jan 8, 2025

sarina Jan 9, 2025

BryanttV Jan 10, 2025

BryanttV Jan 10, 2025

sarina Jan 9, 2025

sarina Jan 9, 2025

sarina Jan 9, 2025

sarina Jan 9, 2025

sarina Jan 9, 2025

sarina Jan 9, 2025

sarina Jan 9, 2025

sarina Jan 9, 2025

sarina Jan 9, 2025


		**************************************
		Adding a Math Expression Input Problem

	Adding a Math Expression Input Problem
	Add a Math Expression Input Problem

		@@ -0,0 +1,66 @@
		.. _Adding Text After the Numeric Response Field:

		Adding Text after the Numeric Response Field

	Adding Text after the Numeric Response Field
	Add Text after the Numeric Response Field

	Awarding Partial
	Award Partial Credit in a Numerical Input Problem

		@@ -0,0 +1,162 @@
		.. _Editing Multi select Problems using the Advanced Editor:

	.. _Editing Multi select Problems using the Advanced Editor:
	.. _Edit Multi select Problems using the Advanced Editor:

	Enabling LTI Components for a Course
	Enable LTI Components for a Course

		@@ -0,0 +1,145 @@
		.. _Setting up a LTI 1.1 component:

		Setting up an LTI 1.1 component

		@@ -0,0 +1,130 @@
		.. _Enabling and using LTI Advantage features:

		Enabling and using LTI Advantage features

	Enabling and using LTI Advantage features
	Enable and Use LTI Advantage features

FC-0068 docs: how-to cleaning by edunext #14 #758

Are you sure you want to change the base?

FC-0068 docs: how-to cleaning by edunext #14 #758

Conversation

BryanttV commented Jan 8, 2025 • edited Loading

openedx-webhooks commented Jan 8, 2025

What's next?

🔘 Get product approval

🔘 Provide context

🔘 Get a green build

🔘 Let us know that your PR is ready for review:

Who will review my changes?

Where can I find more information?

When can I expect my changes to be merged?

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BryanttV commented Jan 8, 2025 •

edited

Loading