Skip to content

Commit 7124559

Browse files
authored
feat: updating readmes for program/cert/creds apps (#35104)
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
1 parent 96da990 commit 7124559

File tree

3 files changed

+48
-11
lines changed

3 files changed

+48
-11
lines changed

lms/djangoapps/certificates/README.rst

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,20 @@ Status: Maintenance
22

33
Responsibilities
44
================
5-
The Certificates app is responsible for creating and managing course run certificates, including relevant data models for invalidating certificates and managing the allowlist.
5+
The Certificates app is responsible for creating and managing course certificates, including
6+
certificate settings, course certificate templates, and generated learner course certificates.
7+
The app includes relevant data models for invalidating certificates and managing the allowlist.
68

7-
Direction: Move and Extract
8-
===========================
9-
Certificates related functionality is scattered across a number of places and should be better consolidated. Today we have:
9+
See Also
10+
========
11+
Course Certificates related functionality is scattered across a number of places:
1012

1113
* ``lms/djangoapps/certificates``
12-
* ``openedx/core/djangoapps/certificates``
14+
* ``openedx/core/djangoapps/credentials``
1315
* ``cms/djangoapps/contentstore/views/certificates.py``
1416
* Various front-end static templates in multiple locations
1517

16-
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.
18+
See also the `credentials service`_, which is the system of record for a learner's Program Certificates.
1719

1820
.. _credentials service: https://github.com/openedx/credentials
1921

20-
Glossary
21-
========
22-
23-
More Documentation
24-
==================
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Status: Maintenance
2+
3+
Responsibilities
4+
================
5+
The Credentials app is responsible (along with the `programs app`_)
6+
for communicating with the `credentials service`_, which is
7+
the system of record for a learner's Program Certificates, and which (when enabled by the edX
8+
instance) is the system of record for accessing all of a learner's credentials.
9+
10+
.. _credentials service: https://github.com/openedx/credentials
11+
12+
.. _programs app: https://github.com/openedx/edx-platform/tree/master/openedx/core/djangoapps/programs
13+
14+
See Also
15+
========
16+
17+
* ``lms/djangoapps/certificates``
18+
* ``openedx/core/djangoapps/programs``
19+
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Status: Maintenance
2+
3+
Responsibilities
4+
================
5+
The Programs app is responsible (along with the `credentials app`_)
6+
for communicating with the `credentials service`_, which is
7+
the system of record for a learner's Program Certificates, and which (when enabled by the edX
8+
instance) is the system of record for accessing all of a learner's credentials.
9+
10+
It also hosts program discussion forum and program live configuration.
11+
12+
.. _credentials service: https://github.com/openedx/credentials
13+
14+
.. _credentials app: https://github.com/openedx/edx-platform/tree/master/openedx/core/djangoapps/credentials
15+
16+
See Also
17+
========
18+
19+
* ``lms/djangoapps/learner_dashboard/``, which hosts the program dashboard.
20+
* ``openedx/core/djangoapps/credentials``
21+

0 commit comments

Comments
 (0)