docs: adr for data storage in course_roles djangoapp #33241
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| We will be using a combination of data storage in the database and data storage structures within the code. | ||
| We will store the roles, permissions, role permissions (rolepermission table), and role assignments (userrole table) in the database. | ||
| We will store the role names (for default roles), permission names, and permission descriptions in a data object in the code. | ||
| We will write code that pulls the role name from the database table for any role not found in the data object in the code. This applies to non-default roles that may differ from instance to instance. |
There was a problem hiding this comment.
To me, this sounds like there are two sources of truth, and I think there's a simpler approach.
Namely:
- We will store the roles, permissions, role permissions (rolepermission table), role assignments (userrole table), role names (for default roles), permission names, and permission descriptions in the database.
- "Default" roles and permissions used by all Open edX instances will be created in the database via migrations.
- Before displaying role names, permission names, or permission descriptions to the user we will use
pgettextto translate them into the user's locale if a translation is available. - Somewhere in the code we will maintain a list of strings, marked for translation, that contains the names and descriptions of the default roles and permissions. This code will not be directly used at runtime, but only exists to ensure that the names/descriptions are detected and made available for localization. (This could even be done in the data migration files themselves, which would be the most efficient.)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR is a PR to a feature branch with an ADR about the way in which data will be stored for course_roles.
Supporting information
Relates to openedx/platform-roadmap#246
https://discuss.openedx.org/t/translating-strings-from-db-fields/11143/2