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
c14a9077
Commit
c14a9077
authored
Sep 19, 2019
by
Evan Read
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add guidance for documenting feature flags
parent
2ec6f251
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
28 additions
and
0 deletions
+28
-0
doc/development/documentation/styleguide.md
doc/development/documentation/styleguide.md
+28
-0
No files found.
doc/development/documentation/styleguide.md
View file @
c14a9077
...
@@ -1051,6 +1051,34 @@ In this case:
...
@@ -1051,6 +1051,34 @@ In this case:
-
Different highlighting languages are used for each config in the code block.
-
Different highlighting languages are used for each config in the code block.
-
The
[
GitLab Restart
](
#gitlab-restart
)
section is used to explain a required restart/reconfigure of GitLab.
-
The
[
GitLab Restart
](
#gitlab-restart
)
section is used to explain a required restart/reconfigure of GitLab.
## Feature flags
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, it's important that users know:
-
Why a feature flag is necessary. Some of the reasons are
[
outlined in the handbook
](
https://about.gitlab.com/handbook/product/#alpha-beta-ga
)
.
-
That administrative access is required to make a feature flag change.
-
What to ask for when requesting a change to a feature flag's state.
The following is sample text for adding feature flag documentation for a feature:
````
md
### Disabling feature
This feature comes with the
`:feature_flag`
feature flag enabled by default. However, in some cases
this feature is incompatible with old configuration. To turn off the feature while configuration is
migrated, ask a GitLab administrator with Rails console access to run the following command:
```
ruby
Feature
.
disable
(
:feature_flag
)
```
````
## API
## API
Here is a list of must-have items. Use them in the exact order that appears
Here is a list of must-have items. Use them in the exact order that appears
...
...
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