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
3f02eee5
Commit
3f02eee5
authored
Nov 26, 2019
by
Evan Read
Committed by
Russell Dickenson
Nov 26, 2019
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Cross link between feature flag guidance
parent
aeb20d58
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
7 additions
and
1 deletion
+7
-1
doc/development/documentation/styleguide.md
doc/development/documentation/styleguide.md
+4
-1
doc/development/feature_flags/index.md
doc/development/feature_flags/index.md
+3
-0
No files found.
doc/development/documentation/styleguide.md
View file @
3f02eee5
...
...
@@ -1055,7 +1055,7 @@ Sometimes features are shipped with feature flags, either:
-
On by default, but providing the option to turn the feature off.
-
Off by default, but providing the option to turn the feature on.
When documenting feature flags for a feature, i
t's important that users know
:
When documenting feature flags for a feature, i
nclude
:
-
Why a feature flag is necessary. Some of the reasons are
[
outlined in the handbook
](
https://about.gitlab.com/handbook/product/#alpha-beta-ga
)
.
...
...
@@ -1080,6 +1080,9 @@ Feature.disable(:feature_flag)
```
````
For guidance on developing with feature flags, see
[
Feature flags in development of GitLab
](
../feature_flags/index.md
)
.
## API
Here is a list of must-have items. Use them in the exact order that appears
...
...
doc/development/feature_flags/index.md
View file @
3f02eee5
...
...
@@ -10,3 +10,6 @@ Before using feature flags for GitLab's development, read through the following:
-
[
Process for using features flags
](
process.md
)
.
-
[
Developing with feature flags
](
development.md
)
.
-
[
Controlling feature flags
](
controls.md
)
.
When documenting feature flags, see
[
Feature flags
](
../documentation/styleguide.md#feature-flags
)
in the Documentation Style Guide.
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