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
700b65ca
Commit
700b65ca
authored
Apr 07, 2022
by
Marcin Sedlak-Jakubowski
Committed by
Suzanne Selhorn
Apr 07, 2022
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Swap parts of feature flag doc doc
parent
507260f3
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
24 additions
and
23 deletions
+24
-23
doc/development/documentation/feature_flags.md
doc/development/documentation/feature_flags.md
+24
-23
No files found.
doc/development/documentation/feature_flags.md
View file @
700b65ca
...
...
@@ -19,8 +19,29 @@ must be documented. For context, see the
When you document feature flags, you must:
-
[
Add a note at the start of the topic
](
#use-a-note-to-describe-the-state-of-the-feature-flag
)
.
-
[
Add version history text
](
#add-version-history-text
)
.
-
[
Add a note at the start of the topic
](
#use-a-note-to-describe-the-state-of-the-feature-flag
)
.
## Add version history text
When the state of a flag changes (for example, disabled by default to enabled by default), add the change to the version history.
Possible version history entries are:
```
markdown
> - [Introduced](issue-link) in GitLab X.X [with a flag](../../administration/feature_flags.md) named <flag name>. Disabled by default.
> - [Enabled on GitLab.com](issue-link) in GitLab X.X.
> - [Enabled on GitLab.com](issue-link) in GitLab X.X. Available to GitLab.com administrators only.
> - [Enabled on self-managed](issue-link) in GitLab X.X.
> - [Generally available](issue-link) in GitLab X.Y. [Feature flag <flag name>](issue-link) removed.
```
You can combine entries if they happened in the same release:
```
markdown
> - Introduced in GitLab 14.2 [with a flag](../../administration/feature_flags.md) named `ci_include_rules`. Disabled by default.
> - [Enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/337507) in GitLab 14.3.
```
## Use a note to describe the state of the feature flag
...
...
@@ -30,7 +51,8 @@ The note has three parts, and follows this structure:
```
markdown
FLAG:
<Self-managed
GitLab
availability
information
.
>
<GitLab
.
com
availability
information
.
>
<Self-managed
GitLab
availability
information
.
>
<GitLab
.
com
availability
information
.
>
<This
feature
is
not
ready
for
production
use
.
>
```
...
...
@@ -61,27 +83,6 @@ If needed, you can add this sentence:
`The feature is not ready for production use.`
## Add version history text
When the state of a flag changes (for example, disabled by default to enabled by default), add the change to the version history.
Possible version history entries are:
```
markdown
> - [Introduced](issue-link) in GitLab X.X [with a flag](../../administration/feature_flags.md) named <flag name>. Disabled by default.
> - [Enabled on GitLab.com](issue-link) in GitLab X.X.
> - [Enabled on GitLab.com](issue-link) in GitLab X.X. Available to GitLab.com administrators only.
> - [Enabled on self-managed](issue-link) in GitLab X.X.
> - [Generally available](issue-link) in GitLab X.Y. [Feature flag <flag name>](issue-link) removed.
```
You can combine entries if they happened in the same release:
```
markdown
> - Introduced in GitLab 14.2 [with a flag](../../administration/feature_flags.md) named `ci_include_rules`. Disabled by default.
> - [Enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/337507) in GitLab 14.3.
```
## Feature flag documentation examples
The following examples show the progression of a feature flag.
...
...
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