Skip to content

Fix misinformation in FF documentation

Furkan Ayhan requested to merge furkanayhan-master-patch-58052 into master

What does this MR do?

Please correct me if these are wrong, and we can close this MR without merging.

1. Misinformation

In the current documentation, this is stated:

/chatops run feature set --project=gitlab-org/gitlab some_feature true

/chatops run feature set some_feature 25

Then some_feature will be enabled for 25% of the time the users are interacting with gitlab-org/gitlab.

We are using enable_percentage_of_time for FF rollout. And according to documentation of "Percentage of Time", this is not related to any actor.

That statement would have been correct, if we were using "Percentage of Actors".

2. Incorrect placement

Note that the the feature is not enabled to 25% of the users, rather a simple randomization is made each time the enabled? is checked.

That statement above was placed right after the complicated use-case. I think it would be best if we place this after a basic example.

Related issues

Author's checklist

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by 🤖 GitLab Bot 🤖

Merge request reports

Loading