Blended Project ID	BD-21
edX Product Lead	@Nimisha Asthagiri (Deactivated)
edX Technical Primary	@Robert Raposa
Provider	Overhang.IO
Provider Lead	@Régis Behmo
Calendly Scheduling Link	calendly.com/nasthagiri
Slack Channel	external-openedx-toggles-n-settings (edX-side) edx-shared-toggles-n-settings (Open edX side)
Meeting Cadence / Preference
Action Item Tracking
Escalation Path
Relevant Discovery Documents	Discovery doc
Status Update Frequency
Target Completion Date
~Dev Hours Per Sprint Expected	10
Total Hours Used	65% (129.4/200) - 2020/11/11
Blended Project Epic (Tracks pull requests )	BLENDED-216
Open edX Jira Epics	https://openedx.atlassian.net/browse/ARCHBOM-1184

Summary

Here are the major accomplishments of the project:

edx-platform toggles and settings documentation now available on readthedocs.
- Added sphinx plugins that are reusable for other IDAs.
Improvements to code-annotations in general
- Support for multi-line and optional annotations.
- Refactoring and clean-up.
- Automatic linting for most repositories to ensure annotation correctness.
Standardization of toggle and setting annotation format and fields
- Cleaned up toggle annotations definition.
- Created how-to for documenting toggles.
- Defined setting annotations for non-toggle Django settings.
- Added SettingToggle and SettingDictToggle classes for boolean Django settings.
- Linting to ensure certain toggles are documented with annotations, and that the annotations match the specification.
Support of the successful Toggle and Setting Docathon.
Enabled tooling capabilities for other IDAs
- Extracted (and simplified) toggle classes from edx-platform.
- Extracted toggle state endpoint capabilities from edx-platform.

Other resources:

Extraction ADRs
BD-21 PRs
BD-21 Blended Toggles and Settings Retrospective
Potential follow-up work: Toggles and Settings Documentation.

Open Action Items

Status Updates

Time Frame	Updates & Actions Needed	~Hours

Time Frame	Updates & Actions Needed	~Hours
June 25 - July 5	Implement multi-line code annotations [BD-21] Implement multi-line code annotations by regisb · Pull Request #40 · openedx/code-annotations Create a proof-of-concept Sphinx plugin for documenting feature toggles https://github.com/edx/edx-platform/pull/24344	10.75h/200
July 5 - July 28	Improve previous pull requests	9/200
July 28 - Sept 7	Merge previous PRs Document feature toggles in high-priority edx-platform applications: https://github.com/edx/edx-platform/pull/24815 Simplify feature toggle annotation format: [BD-21] Simplify feature toggle annotation configuration by regisb · Pull Request #49 · openedx/code-annotations Implement multi-line code annotations for sections prefixed by single-line comment token: [BD-21] Multiline annotations with single-line comment prefix ("#") by regisb · Pull Request #48 · openedx/code-annotations Draft setting annotation config: [BD-21] Sphinx extension and configuration file for setting annotations by regisb · Pull Request #45 · openedx/code-annotations Help finalize Django setting toggle ADR: https://github.com/edx/code-annotations/pull/43	19.25/200
Sep 8 - Sep 27	Finalize setting annotation format: [BD-21] Sphinx extension and configuration file for setting annotations by regisb · Pull Request #45 · openedx/code-annotations Implement setting toggles document settings in edx-platform (in progress)	13.25/200
Sep 28 - Nov 11	Minor doc improvements [BD-21] Link to annotation format how to from edx-toggles by regisb · Pull Request #50 · openedx/code-annotations [BD-21] Link to official feature toggle annotation docs in README by regisb · Pull Request #67 · openedx/edx-toggles [BD-21] Get rid of the `documented_elsewhere` annotation by regisb · Pull Request #51 · openedx/code-annotations Implement SettingToggle/SettingDictToggle [BD-21] Add setting toggles by regisb · Pull Request #66 · openedx/edx-toggles Document settings in edx-platform https://github.com/edx/edx-platform/pull/24794 Port waffle classes to edx-toggles Get rid of namespacing in edx-toggles==2.0.0	77.15/200
Nov 11 -	Linting: Implement optional fields to fix `code_annotations --lint` Add pylint checkers for toggles, settings and generic code annotations Make `code_annotations` report errors via pylint Various improvements

Relevant Jira Stories, Tasks, Bugs

This section will link to all the development stories, tasks, and bugs connected to the single (or multiple) epics used to track the work on the Open edX JIRA site.

key	summary	type	created	updated	due	assignee	reporter	priority	status	resolution

Loading...

Refresh

Relevant Pull Requests linked to Blended Project Epic

This section will link to the edX internal Blended project epic, and contains all Pull Requests related to this Blended Project.

key	summary	type	created	updated	due	assignee	reporter	priority	status	resolution	url