openedx / openedx/credentials

General Design for Sharing Open edX Credentials

Open
#1,735 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

discovery epic
Dominant language
Python
Stars
25
Forks
83
Avg merge
11h 51m
Merged PRs (30d)
1

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the existing Credentials service and the related discovery issues openedx/credentials#1731 and #1732. Use an Arch hours session to brainstorm integration directions, then document candidate designs for community review. Done means an accepted option is captured in a merged ADR and follow-up implementation tickets are created.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.