Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Add ADR on regular course certificate requirements (#27140)

Browse Source 
MICROBA-1039
This commit is contained in:
Christie Rice
2021-03-29 09:53:50 -04:00
committed by GitHub
parent 0ad27ed2fe
commit b452f3d5f3
2 changed files with 42 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
lms/djangoapps/certificates/docs/decisions/001-allowlist-requirements.rst → lms/djangoapps/certificates/docs/decisions/001-allowlist-cert-requirements.rst
View File

@@ -1,4 +1,4 @@
Course Certificate Allowlist Requirements
Allowlist Course Certificate Requirements
=========================================
Status
@@ -7,6 +7,8 @@ Accepted
Background
----------
This doc covers requirements for allowlist course certificates.
Users can earn a course certificate in a particular course run (the certificate
is stored in the *GeneratedCertificate* model). If a user has not earned a certificate
but the course staff would like them to have a certificate anyway, the user can
@@ -22,16 +24,16 @@ won't necessarily have a course certificate available to them. To receive a
downloadable allowlist course certificate, the following things must be true at
the time the certificate is generated:
* The user must have an enrollment in the course
* The user must have an enrollment in the course run
* The enrollment mode must be eligible for a certificate
* The enrollment does not need to be active
* The user must have an approved, unexpired, ID verification
* The user must be on the allowlist for the course run (see the *CertificateWhitelist* model)
* The user must not have an invalidated certificate for the course run (see the *CertificateInvalidation* model)
* Automatic certificate generation must be globally enabled
* HTML (web) certificates must be globally enabled, and also enabled for the course run
* The user must be on the allowlist for the course run (see the *CertificateWhitelist* model)
Note: the above requirements were written for the allowlist, which assumes the
CourseWaffleFlag *certificates_revamp.use_allowlist* has been enabled for the

37
lms/djangoapps/certificates/docs/decisions/002-cert-requirements.rst Normal file
View File

@@ -0,0 +1,37 @@
Regular Course Certificate Requirements
=======================================
Status
------
Accepted
Background
----------
This doc covers requirements for regular (non-allowlist) course certificates.
Users can earn a course certificate in a particular course run if they meet a
number of criteria, and the course run is configured to grant them the certificate.
The certificates are stored in the *GeneratedCertificate* model.
Requirements
------------
For a user to receive a course certificate in the *downloadable* state (for the
user to have a course certificate available to them), the following things must
be true at the time the certificate is generated:
* The user must have an enrollment in the course run
* The enrollment mode must be eligible for a certificate
* The enrollment does not need to be active
* The user must have an approved, unexpired, ID verification
* The user must not have an invalidated certificate for the course run (see the *CertificateInvalidation* model)
* Automatic certificate generation must be globally enabled
* HTML (web) certificates must be globally enabled, and also enabled for the course run
* The user must have passed the course run
* The user must not be a beta tester in the course run
* The course run must not be a CCX (custom edX course)
Note: the above requirements were written for V2 of course certificates, which
assumes the CourseWaffleFlag *certificates_revamp.use_updated* has been enabled
for the course run. If it has not been enabled, the prior logic will apply.