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 a gated process for MFE release that's contingent on a threshold met for documentation #427

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

Comments

@jmakowski1123
Copy link

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

The best way to achieve this is via the Build-Test-Release working group, having it act as gatekeeper. build-test-release#31 exists as a placeholder and is assigned to tCRIL.

Related or in-progress work

Contingencies

#426

@arbrandes arbrandes added the epic Large unit of work, consisting of multiple tasks label Oct 6, 2022
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