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

PADV-233: Credly Xblock Discovery #86

Open
wants to merge 12 commits into
base: pearson-release/juniper.stage
Choose a base branch
from

Conversation

kuipumu
Copy link

@kuipumu kuipumu commented Nov 17, 2022

Ticket

https://agile-jira.pearson.com/browse/PADV-233

Description

This PR adds the discovery document with a proposal to implement an XBlock using Credly as a badging backend to award badges to learners for various grading conditions other than course completion.

Type of Change

  • Add Credly XBlock discovery document

Reviewers

Copy link

@Jacatove Jacatove left a comment

Choose a reason for hiding this comment

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

Could you please detail how the xblock would generate a Badge for Course Completion?. My assumption is that instead of querying grades of subsections it will need to query if student has completed the course or something equivalent.

docs/decisions/0005-credly-xblock.rst Outdated Show resolved Hide resolved
docs/decisions/0005-credly-xblock.rst Outdated Show resolved Hide resolved
docs/decisions/0005-credly-xblock.rst Outdated Show resolved Hide resolved
docs/decisions/0005-credly-xblock.rst Outdated Show resolved Hide resolved
@kuipumu
Copy link
Author

kuipumu commented Nov 17, 2022

Could you please detail how the xblock would generate a Badge for Course Completion?. My assumption is that instead of querying grades of subsections it will need to query if student has completed the course or something equivalent.

@Jacatove It would be exactly how you describe it, it could be done using the grades API or using anything else available at runtime.

docs/decisions/0005-credly-xblock.rst Outdated Show resolved Hide resolved
created badge for this user, otherwise, it will reload the HTML to an
error message.

XBlock Proposal
Copy link

@Jacatove Jacatove Nov 18, 2022

Choose a reason for hiding this comment

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

This proposal clearly defines the events for which the xblock would award badges. Could you please provide a brief integration or logic workflow with Credly?. Credly and Badgr are not exactly the same, therefore as a result of this fact the workflow might be slightly different. For example: Badgr allows us to create BadgeClass via API while Credly apparently does not, which means that for Credly the Badges would need to be created manually on Credly side and once staff/content creators are setting up the Xblock, this Xblock could get all available Badges to link the course with an specifc one. @kuipumu

Choose a reason for hiding this comment

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

This xblock will rely on the Credly implementation we would create for the platform, so this block does not need to interact directly with Credly API. @Jacatove So it's worth mentioning that this block will depend on the Credly backend implementation @kuipumu

Copy link
Author

Choose a reason for hiding this comment

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

@Jacatove I haven't checked if templates can be created using the Credly API. We should let the staff decide which template to use, so it would be logical to let staff set on the XBlock settings the template to use. @Squirrel18 I will add a reference to PADV-234 so we can have a reference on how the API logic workflow works with Credly.

Choose a reason for hiding this comment

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

@Squirrel18 I got it, I was missing that link.

Choose a reason for hiding this comment

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

@kuipumu There is no such API and the way I see things from current approach of this Xblock relying on a Credly Badging system, therefore my concern should not be a issue here as result of that when using this Xbloxk, then the Badging system should guarantee everything is working just fine. Therefore my concern will need to be addressed in the other discovery.

Copy link
Author

Choose a reason for hiding this comment

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

@Jacatove We should not have a problem with the XBlock approach if we follow the same approach of badgr-xblock and set the badge_slug (template slug) to be used on badges (assertions) in the XBlock fields.


OpenEDX supports badges using Badgr as a badge generator. Badges can
only be obtained by learners when they trigger a course completion event
for a course or a set of courses. Badgr works by using the Open Badges

Choose a reason for hiding this comment

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

Suggested change
for a course or a set of courses. Badgr works by using the Open Badges
for a course or a set of courses (...). Badgr works by using the Open Badges

Could you mention the different current events available to earn a badge?

created badge for this user, otherwise, it will reload the HTML to an
error message.

XBlock Proposal

Choose a reason for hiding this comment

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

This xblock will rely on the Credly implementation we would create for the platform, so this block does not need to interact directly with Credly API. @Jacatove So it's worth mentioning that this block will depend on the Credly backend implementation @kuipumu

- Course/subsection scope which means there would be no badges that
involve multiple courses, for example, courses of the program.
- Badges can only be awarded manually when a learner interacts
with an XBlock.

Choose a reason for hiding this comment

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

One more:

This xblock will rely on the Credly backend implementation, so the integration with Credly will depend upon the Credly backend implementation and where where it will be located (Plugin, add a new Djangoapp in edx-platform, Python package...). @kuipumu

Choose a reason for hiding this comment

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

Since we will be merging https://agile-jira.pearson.com/browse/PADV-233 and https://agile-jira.pearson.com/browse/PADV-234 into a single document, this is explained in PADV-234.

@Jacatove
Copy link

Jacatove commented Nov 21, 2022

@kuipumu LGTM!. But I'm not approving it until we have the Credly Badging System.

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

Successfully merging this pull request may close these issues.

4 participants