openedx / edx-documentation

http://docs.edx.org
Other
161 stars 333 forks source link

docs: add note for html content subsections as prerequisite #2247

Closed Danyal-Faheem closed 1 month ago

Danyal-Faheem commented 2 months ago

Add a description of your changes with links to any relevant material.

Added a note to use subsections that only include HTML content as a prerequisite for other subsections. This is because after this PR, HTML components are not counted for grading or completion percentage and are automatically considered passed.

In a scenario where a subsection that has only HTML content is utilized as a prerequisite for another subsection, the student can just jump to that subsection from the main course outline page in the learning MFE and that subsection will be unlocked for the student. To mitigate this, subsections with just HTML content should not be used as prerequisites.

Reviewers

Possible roles follow. The PR submitter checks the boxes after each reviewer finishes and gives :+1:.

FYI: Tag anyone else who might be interested in this PR here.

Testing

Post-review

feanil commented 1 month ago

@Danyal-Faheem looks like this needs a rebase and then it will be good to go.

Danyal-Faheem commented 1 month ago

Hi @feanil, thanks for the review. I've rebased the branch, should be good to merge now.