Skip to content
Snippets Groups Projects
Unverified Commit 0133288c authored by Robert Raposa's avatar Robert Raposa Committed by GitHub
Browse files

Merge pull request #22548 from edx/robrap/update-READMEs

update READMEs to clarify responsibilities
parents c5e0a9f6 c5f44bf2
No related branches found
Tags release-2021-06-15-13.28
No related merge requests found
......@@ -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,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,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
==================
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment