eduhub-org / eduhub

A comprehensive education platform focusing on course applications, event registrations, learning communities, and more.
https://edu.opencampus.sh
GNU Affero General Public License v3.0
10 stars 7 forks source link

Add achievement documentation template #766

Open steffen74 opened 8 months ago

steffen74 commented 8 months ago

Write a customer announcement
Admins can now add a documentation template to each achievement option. The template will then be downloadable to a user the selects the specific achievement.

Is your feature request related to a problem? Please describe. Currently users often structure their documentation very differently. For later publication of projects via a project database, it is crucial to have a more homogeneous documentation.

Describe the solution you'd like
A new table AchievementDocumentationTemplate is added. It includes the columns ìd, title, and url. The table includes all currently available documentation templates.

The view manage/achievements gets a new element for each achievement that allows to select a template via dropdown from the table AchievementDocumentationTemplate. Also a + button next to the dropdown menu allows to add new templates to the table. If a new template is added, it is also automatically selected as template for the given achievement.

The achievement documentation section of the course view is extended by a text field including the link to the documentation template. The text field is blurred if no achievement option is selected and activated (including the correct template link ) as soon as an achievement option is selected.

Additional requirements
Currently users do not get a feedback why a documentation upload might not have worked. Possible errors (in particular considering files that are tool large) should be reported back to the user.

ericstumper commented 8 months ago

@steffen74 When type ONLINE_COURSE is set, the template functionality should not be visible? Is that correct?

ericstumper commented 8 months ago

@steffen74 is it correct that every AchievementOption should only have one AchievementDocumentationTemplate associated with it at a time? Or or should it be possible to provide multiple files without having to resort to a zip file?

steffen74 commented 8 months ago

@steffen74 When type ONLINE_COURSE is set, the template functionality should not be visible? Is that correct?

@ericstumper It should be visible in that case as well.

steffen74 commented 8 months ago

@steffen74 is it correct that every AchievementOption should only have one AchievementDocumentationTemplate associated with it at a time? Or or should it be possible to provide multiple files without having to resort to a zip file?

@ericstumper Yes, only one should be attached.

ericstumper commented 8 months ago

@steffen74 Should the DOCUMENTATION_AND_CSV type be removed or does it still have a purpose?

steffen74 commented 8 months ago

@steffen74 Should the DOCUMENTATION_AND_CSV type be removed or does it still have a purpose?

We might still need it in the future

ericstumper commented 3 months ago

TODO: