General Design for Sharing Open edX Credentials

[e0d]

This work represents a review of the existing Credentials service and the creation of design documents and other artifacts for generalized mechanism for enabling Credentials sharing from the Open edX platform to external networks.

The design requirements should be agreed to during the design review, however, here are some initial thoughts:

• There should be a way on integrating with external providers without altering the service core
• Current mechanism for sharing credentials, Badgr and Accredible would ideally could migrate to the new integration mechanism.
• Discovery work should consider integrations that are important to the community and provide a pathway to supporting them.
  • openedx/credentials#1732
  • The OpenBadges 3.0 specification which will enable DCC Integration openedx/credentials#1731
• Proposal should include a plan for deprecating code that made obsolete by this effort.

AC:

• Kick it off this project by opening an issue in the Credentials repo and scheduling some time at one of the Arch hours to brainstorm the implementation direction.
• Do discovery work and create 1 or more candidate designs in the issue for discussion with the 2U team and other members of the community.
• Convert the chosen option into an ADR that was merged into the Credential repository.
• Ticket the work required to implement the accepted design

[github-actions[bot]]

Thanks for your submission, @openedx/open-edx-project-managers will review shortly.

[hurtstotouchfire]

Is this effectively blocked by openedx/credentials#1734 or would we consider doing some of this work for just the credentials currently implemented in the Credentials service (meaning Program creds only)?

[e0d]

I'd like to avoid blocking this on the migration of course certificates to credentials unless that's simply not possible.

Obviously, to get the most value form sharing, course certificates need to also be available to share.

openedx/credentials#1734 has three proposed epics. I think we should strike (3) as it is redundant with the overall initiative openedx/credentials#1736.

I don't think that (2) -- MFE migration -- should be a blocker.

Does the work in (1) capture what you think is the best path forward here? Ideally the edx.org migration work, which will almost certainly be the long-pole-in-the tent, could be done in a non-blocking fashion. Support for course credentials in the service clearly needs to be part of this design work.