You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This has always been an issue with edx-platform, but it has unfortunately not been fixed with MFEs: a sysadmin needs to read the code to find out how many features work, or what particular configuration settings actually do. Furthermore, some MFEs are better documented than others. This makes it very difficult to streamline an upgrade pipeline, for example: one can never rely on documentation to be up-to-date on a new MFE.
Product/Platform Value
This has a direct impact on platform adoption: poor or lacking documentation not only hinders the process of including MFEs in releases, it makes them harder to use and to market.
Acceptance Criteria
Related or in-progress work
Connect to documentation workflows, explore creating an MFE Developer persona and use docs.openedx.org as the pathway for collating and channeling this persona to the right places as they currently exist. This does not solve the full problem of documentation not existing to begin with, but it would be a step in the process to define the gaps. #381
Problem
This has always been an issue with edx-platform, but it has unfortunately not been fixed with MFEs: a sysadmin needs to read the code to find out how many features work, or what particular configuration settings actually do. Furthermore, some MFEs are better documented than others. This makes it very difficult to streamline an upgrade pipeline, for example: one can never rely on documentation to be up-to-date on a new MFE.
Product/Platform Value
This has a direct impact on platform adoption: poor or lacking documentation not only hinders the process of including MFEs in releases, it makes them harder to use and to market.
Acceptance Criteria
Related or in-progress work
Connect to documentation workflows, explore creating an MFE Developer persona and use docs.openedx.org as the pathway for collating and channeling this persona to the right places as they currently exist. This does not solve the full problem of documentation not existing to begin with, but it would be a step in the process to define the gaps. #381
Task 1:
#333
Contingencies
The text was updated successfully, but these errors were encountered: