Skip to content

Documentation - Clarify default feature flag for all instances

Olivier Gonzalez requested to merge defaul_feature_flag_all_instances into master

What does this MR do?

Update docs to clarify the default value of implicit feature flag on all instances (gitlab.com and self-managed).

The current documentation is dangerously misleading to me:

As an example, if you were to ship the backend half of a feature behind a flag, you'd want to explicitly disable that flag until the frontend half is also ready to be shipped. You can do this via Chatops:

/chatops run feature set some_feature 0

Note that you can do this at any time, even before the merge request using the flag has been merged!

This makes engineer thinking running that chatops command is enough to hide their feature, but this will only impact the gitlab.com instance. The feature_flag will still default to true on the self-managed instances, making these half-backed features enabled there.

Related issues

Refs #34884

A recent real case of this: #35669 (closed)

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 and that you merge the equivalent EE MR before the CE MR if both exist.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.

Merge request reports