Add docs for using feature flags in govuk-frontend #46
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for govuk-design-system-team-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| ### The thing is a breaking change | ||
| Feature flags should only be used for things considered breaking changes. This is something where users will potentially need to change their service, or assess if their service needs changing, in order to continue staying up to date with govuk-frontend. In this case, a feature flag would be a way for a user to stay up to date whilst also opting out of the feature for a period of time. We don’t need to do this for minor releases or new features such as a new component because a user can opt out by simply not using the new feature. | ||
|
|
||
| ### The thing might be a long term project for users |
There was a problem hiding this comment.
I'm not a fan of using 'the thing' in the subheads, but can't think if a different option at present
There was a problem hiding this comment.
"The feature"? "The change"?
There was a problem hiding this comment.
'feature' risks getting confused with specific 'new features'. 'change' might work. Or perhaps 'action'?
or I'm probably overthinking it and it doesn't really matter.
There was a problem hiding this comment.
Shall I give action a go?
There was a problem hiding this comment.
Let's give it whirl and see what others think
There was a problem hiding this comment.
I tried replacing everything with action and it didn't feel right in a few places so I've used a mix of "action" and "change" depending on the context. What do you think?
There was a problem hiding this comment.
Sounds like a good plan
owenatgov
force-pushed
the
feature-flags
branch
2 times, most recently
from
e52c145 to
744547f
Compare
owenatgov
force-pushed
the
feature-flags
branch
3 times, most recently
from
7a8f3aa to
7bacd40
Compare
owenatgov
force-pushed
the
feature-flags
branch
4 times, most recently
from
d0f4ef2 to
85e9ef6
Compare
Update source/development/feature-flags.html.md Update source/development/feature-flags.html.md Update source/development/feature-flags.html.md Update source/development/feature-flags.html.md Update source/development/feature-flags.html.md Update source/development/feature-flags.html.md Update source/development/feature-flags.html.md Update source/development/feature-flags.html.md Update source/development/feature-flags.html.md Update source/development/feature-flags.html.md Update source/development/feature-flags.html.md Update source/development/feature-flags.html.md Update source/development/feature-flags.html.md Update source/development/feature-flags.html.md Update source/development/feature-flags.html.md Update source/development/feature-flags.html.md Update source/development/feature-flags.html.md Update source/development/feature-flags.html.md Update source/development/feature-flags.html.md Co-Authored-By: CAAshworth <[email protected]>
owenatgov
force-pushed
the
feature-flags
branch
from
85e9ef6 to
df1d2d0
Compare
claireashworth
approved these changes
Jan 4, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What it says on the tin. Fixes #47