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

feat: updating readmes for program/cert/creds apps (#35104)

Browse Source 
The LMS `certificates` app `README`  has been, and the
openedx core `credentials` and `programs` READMEs  have been created.
This will clarify not only what the limited responsibilities
of each of these django apps is, but also the way they interact with
each other.

FIXES: APER-2929
This commit is contained in:
Deborah Kaplan
2024-07-10 10:34:16 -04:00
committed by GitHub
parent 96da9902c6
commit 7124559906
3 changed files with 48 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
lms/djangoapps/certificates/README.rst
View File

@@ -2,23 +2,20 @@ Status: Maintenance
Responsibilities
================
The Certificates app is responsible for creating and managing course run certificates, including relevant data models for invalidating certificates and managing the allowlist.
The Certificates app is responsible for creating and managing course certificates, including
certificate settings, course certificate templates, and generated learner course certificates.
The app includes relevant data models for invalidating certificates and managing the allowlist.
Direction: Move and Extract
===========================
Certificates related functionality is scattered across a number of places and should be better consolidated. Today we have:
See Also
========
Course Certificates related functionality is scattered across a number of places:
* ``lms/djangoapps/certificates``
* ``openedx/core/djangoapps/certificates``
* ``openedx/core/djangoapps/credentials``
* ``cms/djangoapps/contentstore/views/certificates.py``
* Various front-end static templates in multiple locations
Ideally, we want to extract these into the `credentials service`_, which would be ultimately responsible for Course-Run and Program certificates (and possibly other credentials). Right now, the `credentials service`_ only manages Program certificates.
See also the `credentials service`_, which is the system of record for a learner's Program Certificates.
.. _credentials service: https://github.com/openedx/credentials
Glossary
========
More Documentation
==================

19
openedx/core/djangoapps/credentials/README.rst Normal file
View File

@@ -0,0 +1,19 @@
Status: Maintenance
Responsibilities
================
The Credentials app is responsible (along with the `programs app`_)
for communicating with the `credentials service`_, which is
the system of record for a learner's Program Certificates, and which (when enabled by the edX
instance) is the system of record for accessing all of a learner's credentials.
.. _credentials service: https://github.com/openedx/credentials
.. _programs app: https://github.com/openedx/edx-platform/tree/master/openedx/core/djangoapps/programs
See Also
========
* ``lms/djangoapps/certificates``
* ``openedx/core/djangoapps/programs``

21
openedx/core/djangoapps/programs/README.rst Normal file
View File

@@ -0,0 +1,21 @@
Status: Maintenance
Responsibilities
================
The Programs app is responsible (along with the `credentials app`_)
for communicating with the `credentials service`_, which is
the system of record for a learner's Program Certificates, and which (when enabled by the edX
instance) is the system of record for accessing all of a learner's credentials.
It also hosts program discussion forum and program live configuration.
.. _credentials service: https://github.com/openedx/credentials
.. _credentials app: https://github.com/openedx/edx-platform/tree/master/openedx/core/djangoapps/credentials
See Also
========
* ``lms/djangoapps/learner_dashboard/``, which hosts the program dashboard.
* ``openedx/core/djangoapps/credentials``