need better docs on how to use/test feature flags

Bug #692480 reported by Martin Pool
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Launchpad itself
Fix Released
High
Martin Pool

Bug Description

Bryce pointed out that it was frustratingly hard (in the context of https://code.edge.launchpad.net/~bryce/launchpad/lp-617698-forwarding/+merge/41003) to understand how to use and debug feature flags. He said better docs are the things that will most help.

So this bug is a reminder to add some. It would be a better bug if it identified specific deficiencies, so please add them below.

Curtis Hovey (sinzui)
Changed in launchpad:
status: Confirmed → Triaged
Revision history for this message
Bryce Harrington (bryce) wrote :

The official docs people point to is https://dev.launchpad.net/LEP/FeatureFlags

Which is a rambling LEP containing details irrelevant to implementers and assumes knowledge that a newb doesn't have.
There's no tips for debugging when feature flags don't work.

A branch I was working on has been blocked for several months because I can't get feature flags working, and the little ambiguities in the documentation make me uncertain whether it's my own lack of knowledge about feature flags, or something more fundamental. Every couple weeks I try again, banging on it for several hours with no results. I've asked people for help, but they don't know either. To say it's frustratingly hard is an understatement.

Revision history for this message
Bryce Harrington (bryce) wrote :

Fwiw, I think the problem I'm blocked by is described by https://bugs.launchpad.net/launchpad/+bug/631884

Revision history for this message
Martin Pool (mbp) wrote :

I started <https://dev.launchpad.net/Foundations/FeatureFlags> for developer-oriented documentation.

(We should perhaps have a /Guide/ namespace rather than grouping things by historical-team, but that's what fits at the moment.)

Martin Pool (mbp)
Changed in launchpad:
importance: Medium → High
Revision history for this message
Martin Pool (mbp) wrote :

OK, I'm going to say this is provisionally closed by <https://dev.launchpad.net/FeatureFlags> and <https://dev.launchpad.net/TestingWithFeatureFlags>. If they're lacking anything, and they may well be, please ask.

Changed in launchpad:
assignee: nobody → Martin Pool (mbp)
status: Triaged → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.