Skip to content
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

Add feature flags documentation #473

Merged
merged 3 commits into from
Sep 29, 2023
Merged

Add feature flags documentation #473

merged 3 commits into from
Sep 29, 2023

Conversation

mrodriguez90
Copy link
Contributor

Board:

https://www.notion.so/rootstrap/Documentar-ac6a53fb2ec64aebb818bb9023c8ad11?pvs=4

Description:

Feature flags documentation

Notes:


Tasks:

  • Adds feature flags documentation at docs/feature_flags.md

Risk:

  • no

Preview:

👁️


The Rootstrap Rails API Base allows developers to define feature flags, which are essentially boolean variables representing whether a particular feature or piece of code should be enabled or disabled. These flags can be easily controlled without requiring code changes or redeployment.
Feature flags can be set at different levels of granularity, such as for individual users, user groups, or percentage-based rollouts. This allows for controlled feature releases and gradual rollouts.
Our feature flag engine is built upon Flipper. To learn more about Flipper, please visit the following website: [Flipper Documentation](https://www.flippercloud.io/docs/introduction)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Our feature flag engine is built upon Flipper. To learn more about Flipper, please visit the following website: [Flipper Documentation](https://www.flippercloud.io/docs/introduction)
Our feature flag implementation is based on Flipper. To learn more about Flipper, please visit the following website: [Flipper Documentation](https://www.flippercloud.io/docs/introduction)

Comment on lines 55 to 57
## Monitoring and Managing Feature Flags

To monitor and manage feature flags, we recommend using the Flipper UI, which can be accessed through `active_admin` or at this path: `/admin/feature-flags/`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would move this section below Set Up Feature Flags

@@ -0,0 +1,57 @@
# Feature Flags
Copy link
Member

@santib santib Sep 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

WDYT about adding a section to explain how FFs enable Continuous Delivery to our dev teams? This is a good reference to add: https://about.gitlab.com/handbook/product-development-flow/feature-flag-lifecycle/#the-benefits-of-feature-flags

Copy link
Member

@santib santib left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👌 Left some comments

@mrodriguez90 mrodriguez90 merged commit bca42b0 into main Sep 29, 2023
3 checks passed
@mrodriguez90 mrodriguez90 deleted the add-flipper-docs branch September 29, 2023 19:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants