-
-
Notifications
You must be signed in to change notification settings - Fork 734
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
Update 11 principles page #7907
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.OpenSSF Scorecard
Scanned Manifest Files |
website/docs/topics/feature-flags/feature-flag-best-practices.md
Outdated
Show resolved
Hide resolved
@michaelferranti wdyt about making the principles a bit more snappy? Current: Some ideas: |
website/docs/topics/feature-flags/feature-flag-best-practices.md
Outdated
Show resolved
Hide resolved
@melindafekete I am good with your proposed changes to the FF principles. They are consistent with what we are trying to communicate. |
website/docs/topics/feature-flags/feature-flag-best-practices.md
Outdated
Show resolved
Hide resolved
Add some missing context for small payload Add closing paragraph
website/docs/topics/feature-flags/feature-flag-best-practices.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Just a few changes.
website/docs/topics/feature-flags/feature-flag-best-practices.md
Outdated
Show resolved
Hide resolved
website/docs/topics/feature-flags/feature-flag-best-practices.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Michael Ferranti <[email protected]>
About the changes
An extension of #7801.
Docs preview
Key changes:
Improved readability—removed a lot of passive voice, made sections a bit less repetitive and reorganized a few sentences/headings for better structure.
Removed nested lists. I generally avoid using numbered lists, unless it's instructions or something that really calls for an order. I think it's fine to keep the high-level 11-step list (because 11 principles sounds catchy) but I would avoid nested lists like 1.1.a in this case.
Added some more links to tie back to some of the Unleash concepts in a subtle way. For example, linking the 4-eyes principle to the change requests docs.
Made the principles titles a bit more concise and readable.