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

update READMEs to clarify responsibilities

Browse Source 
Add some clarifications for student, user_api, and user_authn given
the recent clean-up of moving code to the appropriate apps.

ARCH-1248
This commit is contained in:
Robert Raposa
2019-12-16 13:51:43 -05:00
parent c5e0a9f636
commit c5f44bf20e
3 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
common/djangoapps/student/README.rst
View File

@@ -6,6 +6,8 @@ The Student app supplements Django's default user information with student-speci
If you are thinking of adding something here, strongly consider adding a new Django app instead. If you are extending something here, please consider extracting it into a separate app.
Intended responsibility: Student dashboard functionality.
Glossary
========

4
openedx/core/djangoapps/user_api/README.rst
View File

@@ -4,11 +4,11 @@ Responsibilities
================
The user_api app is currently a catch all that is used to provide various apis that are related to the user and also to features within the platform.
Intended responsibility: To manage user profile and general account information and to provide APIs to do so easily.
Intended responsibility: To manage user profile and general account information and to provide APIs to do so easily. This includes the following features: user preference, user profile, user retirement, and account activation/deactivation.
Direction: Decompose
===============
Currently this app is a catch all for many user related information even when that information sholud really belong in a different app. If you are building a feature and need to provide information about a user within the context of your feature, you should localize that API to your feature and make your assumptions about what user information you need clear.
Currently this app is a catch all for many user related information even when that information should really belong in a different app. If you are building a feature and need to provide information about a user within the context of your feature, you should localize that API to your feature and make your assumptions about what user information you need clear.
For example authentication related APIs have already been moved to the user_authn django app.

2
openedx/core/djangoapps/user_authn/README.rst
View File

@@ -2,7 +2,7 @@ Status: Maintenance
Responsibilities
================
The ``user_authn`` app contains user authentication related features such as login and registration.
The ``user_authn`` app contains user authentication related features such as login, registration, and credential management.
Direction: Extract
==================