-
-
Notifications
You must be signed in to change notification settings - Fork 130
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
docs: update progressive rollout docs #2456
docs: update progressive rollout docs #2456
Conversation
✅ Deploy Preview for go-feature-flag-doc-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Hey @thomaspoignant , I faced this issue and wanted to contribute to the docs. I think it might be worth to explain a little more on changing the percentage field. However, it is unintuitive. The following is my proposal to be added to the Example section: Using the percentage field (advanced)If you do not intend to completely rollout a feature, you can modify the percentage field. progressiveRollout:
initial:
variation: variationA
percentage: 20
date: 2024-01-01T05:00:00.100Z
end:
variation: variationB
percentage: 80
date: 2024-01-05T05:00:00.100Z
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2456 +/- ##
=======================================
Coverage 85.56% 85.56%
=======================================
Files 103 103
Lines 3816 3816
=======================================
Hits 3265 3265
Misses 425 425
Partials 126 126 ☔ View full report in Codecov by Sentry. |
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.
@Light2Dark thanks a lot for this improvement of the documentation this is really great.
I agree that your proposal for the example is better to understand how it works, just to be sure you want to have 2 different examples? One without percentage `(which means that we go from 0 to 100) and one with it?
I like your proposal, the bullet list helps a lot to understand better how it works.
The only thing I would change is the Configuration fields
table that is not reflecting the format, I would prefer to have an entry for initial
and one for end
.
| **`percentage`** | *(optional)*<br/>It represents the ramp of progress, at which level the flag starts (`initial`) and ends (`end`).<br/>**Default: `initial` = `0` and `end` = `100`** | | ||
| Field | Description | | ||
|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| **`percentage`**<br/>*(optional)* | It represents the ramp of progress, at which level the flag starts (`initial`) and ends (`end`).<br/>**Default: `initial` = `0` and `end` = `100`**. | |
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.
We probably need to change this table with explaining what should be in initial and end.
Yeap, 2 examples. One is a simple use case, and another for more advanced use. Let me make some changes and you could review then :)
Noted, let me add to this. |
Quality Gate passedIssues Measures |
Description
Update the example used and add a description of how the configuration works. (updated)
Closes issue(s)
Resolve #2452
Checklist
README.md
and/website/docs
)