We need to improve our documentation for features flags
I'm starting this discussion with the goal to come up with a protocol to document feature flags.
A good example is I just spent the last 30 minutes trying to figure it out how to have the user cards on my local. I went to success looking for a release note, found some client facing documentation, nothing technical.
Came here and found nothing...
Finally I looked directly for the code to find out some references that it might be behind a feature flag. (No readme though).
In my honest opinion, releasing a feature with no documentation is the same as the feature not existing at all.
Whenever I do some product related development I try documenting the feature I'm releasing in a readme or so. I'm not saying we should do exactly this but since we have been releasing a lot of feature flags recently I think it's becoming more pressing to have some sort of documentation protocol in place.
Comments
-
This discussion was posted by me btw ? (I was testing something as System earlier today and forgot to log out).
0 -
Another place that we have the component is on the Storybook. So, all the new components are going there... Is it a good place to check the component? We are working on some improvements like adding descriptions for each one, for example.
0 -
@Isis all these new features follow this format:
- On by default for site with foundation (eg. any theme with
DataDrivenThemefeature enabled). - On for any sites with that theme feature enabled.
- On for any sites with that feature flag enabled.
You can always see all the theme features as a dev here
https://github.com/vanilla/vanilla-cloud/blob/master/library/Vanilla/Theme/ThemeFeatures.php#L28-L37
TS has some backlog items for a UI to display feature flags and allow toggling them as well.
My real question though is why aren't you using foundation on your local?
1 - On by default for site with foundation (eg. any theme with
-
It's also in our article about about feature flags. I think that's about as well documented as anything else we've ever made.
0 -
My real question though is why aren't you using foundation on your local?
@Adam Charron Thanks for you reply, as for using Foundation on my local: I do use it, but as I do a bunch of support I switch themes all the time.
0
