Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
49fed19f
Commit
49fed19f
authored
Apr 05, 2021
by
Michael Kozono
Committed by
Craig Norris
Apr 05, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Warn about toggling development feature flags
parent
b5dd8548
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
29 additions
and
11 deletions
+29
-11
doc/development/documentation/feature_flags.md
doc/development/documentation/feature_flags.md
+12
-8
doc/user/feature_flags.md
doc/user/feature_flags.md
+17
-3
No files found.
doc/development/documentation/feature_flags.md
View file @
49fed19f
...
@@ -67,8 +67,9 @@ be enabled for a single project, and is not ready for production use:
...
@@ -67,8 +67,9 @@ be enabled for a single project, and is not ready for production use:
> - Not recommended for production use.
> - Not recommended for production use.
> - To use in GitLab self-managed instances, ask a GitLab administrator to [enable it](#anchor-to-section). **(FREE SELF)**
> - To use in GitLab self-managed instances, ask a GitLab administrator to [enable it](#anchor-to-section). **(FREE SELF)**
WARNING:
This in-development feature might not be available for your use. There can be
This feature might not be available to you. Check the
**version history**
note above for details.
[
risks when enabling features still in development
](
<
replace with path to
>
/user/feature_flags.md#risks-when-enabling-features-still-in-development).
Refer to this feature's version history for more details.
(...Regular content goes here...)
(...Regular content goes here...)
...
@@ -126,8 +127,9 @@ use:
...
@@ -126,8 +127,9 @@ use:
> - Recommended for production use.
> - Recommended for production use.
> - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#anchor-to-section). **(FREE SELF)**
> - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#anchor-to-section). **(FREE SELF)**
WARNING:
There can be
This feature might not be available to you. Check the
**version history**
note above for details.
[
risks when disabling released features
](
<
replace with path to
>
/user/feature_flags.md#risks-when-disabling-released-features).
Refer to this feature's version history for more details.
(...Regular content goes here...)
(...Regular content goes here...)
...
@@ -182,8 +184,9 @@ cannot be enabled for a single project, and is ready for production use:
...
@@ -182,8 +184,9 @@ cannot be enabled for a single project, and is ready for production use:
> - Recommended for production use.
> - Recommended for production use.
> - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#anchor-to-section). **(FREE SELF)**
> - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#anchor-to-section). **(FREE SELF)**
WARNING:
There can be
This feature might not be available to you. Check the
**version history**
note above for details.
[
risks when disabling released features
](
<
replace with path to
>
/user/feature_flags.md#risks-when-disabling-released-features).
Refer to this feature's version history for more details.
(...Regular content goes here...)
(...Regular content goes here...)
...
@@ -255,8 +258,9 @@ be enabled by project, and is ready for production use:
...
@@ -255,8 +258,9 @@ be enabled by project, and is ready for production use:
> - Recommended for production use.
> - Recommended for production use.
> - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#anchor-to-section). **(FREE SELF)**
> - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#anchor-to-section). **(FREE SELF)**
WARNING:
There can be
This feature might not be available to you. Check the
**version history**
note above for details.
[
risks when disabling released features
](
<
replace with path to
>
/user/feature_flags.md#risks-when-disabling-released-features).
Refer to this feature's version history for more details.
(...Regular content goes here...)
(...Regular content goes here...)
...
...
doc/user/feature_flags.md
View file @
49fed19f
...
@@ -18,9 +18,9 @@ may be unavailable to you.
...
@@ -18,9 +18,9 @@ may be unavailable to you.
In this case, you'll see a warning like this in the feature documentation:
In this case, you'll see a warning like this in the feature documentation:
WARNING:
This in-development feature might not be available for your use. There can be
This feature might not be available to you. Review the
**version history**
note
[
risks when enabling features still in development
](
#risks-when-enabling-features-still-in-development
)
.
on this page for
details.
Refer to this feature's version history for more
details.
In the version history note, you'll find information on the state of the
In the version history note, you'll find information on the state of the
feature flag, including whether the feature is on ("enabled by default") or
feature flag, including whether the feature is on ("enabled by default") or
...
@@ -41,3 +41,17 @@ although changing a feature's default state isn't recommended.
...
@@ -41,3 +41,17 @@ although changing a feature's default state isn't recommended.
If you're a GitLab.com user and the feature is disabled, be aware that GitLab may
If you're a GitLab.com user and the feature is disabled, be aware that GitLab may
be working on the feature for potential release in the future.
be working on the feature for potential release in the future.
## Risks when enabling features still in development
Features that are disabled by default may change or be removed without notice in a future version of GitLab.
Data corruption, stability degradation, or performance degradation might occur if
you enable a feature that's disabled by default. Problems caused by using a default
disabled feature aren't covered by GitLab support, unless you were directed by GitLab
to enable the feature.
## Risks when disabling released features
In most cases, the feature flag code is removed in a future version of GitLab.
If and when that occurs, from that point onward you can't keep the feature in a disabled state.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment