Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create standardized documentation guidelines for MFEs #426

Open
jmakowski1123 opened this issue Aug 15, 2022 · 0 comments
Open

Create standardized documentation guidelines for MFEs #426

jmakowski1123 opened this issue Aug 15, 2022 · 0 comments
Labels
epic Large unit of work, consisting of multiple tasks

Comments

@jmakowski1123
Copy link

jmakowski1123 commented Aug 15, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
epic Large unit of work, consisting of multiple tasks
Projects
Status: Backlog
Development

No branches or pull requests

2 participants