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

OEP-0080: Adopt the Openfeature Specifications in OpenEdX For Toggles and Feature Flags #651

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions oeps/best-practices/oep-0080-openfeature-feature-flags.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
.. _external_link_template:

.. Below is the display in the left sidebar on RTD. Please omit leading 0's

OEP-80: OpenFeature Feature Flags
#################################

.. This OEP template is recommended when content is externally linked.

.. list-table::
:widths: 25 75

* - OEP
- Link to the doc in the following format::

:doc:`OEP-XXXX <oep-XXXX-YYYY-ZZZZ>`

* <XXXX is the next available OEP number>
* <YYYY is the abbreviated Type: proc | bp | arch>
* <ZZZZ is a brief (< 5 words) version of the title>

* - Title
- OpenFeature Feature Flags
* - Last Modified
- 2024-12-13
* - Authors
- Christ Patti <cpatti@mit.edu>, Tobias Macey <tmacey@mit.edu>
* - Arbiter
- <Arbiter's real name and email address>
* - Status
- <Draft
* - Type
- Best Practice
* - Created
- 2024-12-13
* - Review Period
- <start - target end dates for review>

Abstract
********

Right now OpenEdX has a huge array of toggles and feature flags in a number of repositories and using a number of formats.

Discoverability and interop with standard tools is poor, and the current system is not well documented.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[inform] If you decide to move forward with filling out this OEP, I think it would be useful to first become familiar with the current feature toggle documentation and tooling: https://edx.readthedocs.io/projects/edx-toggles/en/latest/readme.html.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you very much. I was asked to author this and I appreciate all the help I can get!


Using OpenFeature for all our toggles across the board would allow us to use tools like Posthog which would <Why we use Posthog? $REASONS?)

References
**********

.. _OpenFeature Website: https://openfeature.dev
.. _OpenFeature Specification: https://openfeature.dev/specification/

Decisions
*********

OpenEdX should use Openfeature for all its toggles and feature flags.

Change History
**************

YYYY-MM-DD
##########

* Document created
* `Pull request #XXX <https://github.com/openedx/open-edx-proposals/pull/XXX>`_
Loading