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

Contextual Course FAQ by Category #2506

Open
igobranco opened this issue Oct 4, 2024 · 1 comment
Open

Contextual Course FAQ by Category #2506

igobranco opened this issue Oct 4, 2024 · 1 comment

Comments

@igobranco
Copy link
Collaborator

Feature Request

Is your feature request related to a problem or unsupported use case? Please describe.

We, at NAU, need to have different FAQs depending on the type of course, eg. course available on edx.org or course with payments or other condition in future and/or other courses.
The existing Complementary Information placeholder on the course detail page doesn't scale, because we would need to manage too much FAQs ( 1 per course, it won't scale).

Describe the solution you'd like

So the idea is to have a FAQ managed/edited on the Category Page, meaning that the Category Page template would include a new page placeholder with the code/acronym course_faq.
Then at the bottom of the course detail page template we would iterate all categories associated to the course, and show the course_faq placeholders for each category. Meaning that the course detail page template would include all FAQs of its associated categories.
The course_faq should be edited only on the category page template and not on the course page.
If there isn't any category associated with a FAQ, the course detail template should render an empty Django template block. So on NAU installation we overwrite that block and include inside a static placeholder to show a FAQ for other courses.

Describe alternatives you've considered
Use a static placeholder on course detail page, because this would be rendered for all courses. So we would have only a FAQ for all courses.
Add a switch case and render 3 static placeholders depending on the criteria's and show only 1 of the FAQ.

Discovery, Documentation, Adoption, Migration Strategy
If you can, explain how users will be able to use this and possibly write out a version the docs (if applicable).
Maybe a screenshot or design?

On the page:
https://demo.richie.education/en/categories/subject/education-and-career-guidance/

Add a new placeholder course_faq that allow only NestedItemPlugins similar to course_plan

"courses/cms/course_detail.html course_plan": {
"name": _("Plan"),
"plugins": ["NestedItemPlugin"],
"child_classes": {"NestedItemPlugin": ["NestedItemPlugin"]},
},
bellow the category page description.
image

Then on the course detail page, after the Course Complementary Information and before the Licenses, include this new blocks.
For all Course categories that has a FAQ render that FAQ.

Do you want to work on it through a Pull Request?

@Tiago-Salles would work on this. Firstly he will create a POC on our code base, but our idea is to upstream this.

@igobranco
Copy link
Collaborator Author

@jbpenrath what do you think about this requirement/feature. Can @Tiago-Salles start the work upstream directly, or should be just implement this feature on our site? Do you have any further comments about the implementation?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant