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
620541f1
Commit
620541f1
authored
Aug 02, 2021
by
Suzanne Selhorn
Committed by
Craig Norris
Aug 02, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Added guidance for GitLab.com administrator-only features
parent
a9684310
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
11 additions
and
4 deletions
+11
-4
doc/development/documentation/feature_flags.md
doc/development/documentation/feature_flags.md
+11
-4
No files found.
doc/development/documentation/feature_flags.md
View file @
620541f1
...
@@ -18,6 +18,11 @@ Every feature introduced to the codebase, even if it's behind a feature flag,
...
@@ -18,6 +18,11 @@ Every feature introduced to the codebase, even if it's behind a feature flag,
must be documented. For context, see the
must be documented. For context, see the
[
latest merge request that updated this guideline
](
https://gitlab.com/gitlab-org/gitlab/-/merge_requests/47917#note_459984428
)
.
[
latest merge request that updated this guideline
](
https://gitlab.com/gitlab-org/gitlab/-/merge_requests/47917#note_459984428
)
.
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
)
.
## Use a note to describe the state of the feature flag
## Use a note to describe the state of the feature flag
Information about feature flags should be in a
**Note**
at the start of the topic (just below the version history).
Information about feature flags should be in a
**Note**
at the start of the topic (just below the version history).
...
@@ -47,8 +52,9 @@ NOTE:
...
@@ -47,8 +52,9 @@ NOTE:
|If the feature is... | Use this text |
|If the feature is... | Use this text |
|-|-|
|-|-|
|Available|
`On GitLab SaaS, this feature is available.`
|
|Available|
`On GitLab.com, this feature is available.`
|
|Unavailable|
`On GitLab SaaS, this feature is not available.`
|
|Available to GitLab.com admins only|
`On GitLab.com, this feature is available but can be configured by GitLab.com administrators only.`
|Unavailable|
`On GitLab.com, this feature is not available.`
|
### Optional information
### Optional information
...
@@ -63,7 +69,8 @@ When the state of a flag changes (for example, disabled by default to enabled by
...
@@ -63,7 +69,8 @@ When the state of a flag changes (for example, disabled by default to enabled by
Possible version history entries are:
Possible version history entries are:
```
markdown
```
markdown
> - [Enabled for GitLab.com](issue-link) in GitLab X.X and is ready for production use.
> - [Enabled on GitLab.com](issue-link) in GitLab X.X and is ready for production use.
> - [Enabled on GitLab.com](issue-link) in GitLab X.X and is ready for production use. Available to GitLab.com administrators only.
> - [Enabled with <flag name> flag](issue-link) for self-managed GitLab in GitLab X.X and is ready for production use.
> - [Enabled with <flag name> flag](issue-link) for self-managed GitLab in GitLab X.X and is ready for production use.
> - [Feature flag <flag name> removed](issue-line) in GitLab X.X.
> - [Feature flag <flag name> removed](issue-line) in GitLab X.X.
```
```
...
@@ -96,7 +103,7 @@ And, when the feature is done and fully available to all users:
...
@@ -96,7 +103,7 @@ And, when the feature is done and fully available to all users:
```
markdown
```
markdown
> - Introduced in GitLab 13.7.
> - Introduced in GitLab 13.7.
> - [Enabled
for
GitLab.com](https://gitlab.com/issue/etc) in GitLab X.X and is ready for production use.
> - [Enabled
on
GitLab.com](https://gitlab.com/issue/etc) in GitLab X.X and is ready for production use.
> - [Enabled with `forti_token_cloud` flag](https://gitlab.com/issue/etc) for self-managed GitLab in GitLab X.X and is ready for production use.
> - [Enabled with `forti_token_cloud` flag](https://gitlab.com/issue/etc) for self-managed GitLab in GitLab X.X and is ready for production use.
> - [Feature flag `forti_token_cloud`](https://gitlab.com/issue/etc) removed in GitLab X.X.
> - [Feature flag `forti_token_cloud`](https://gitlab.com/issue/etc) removed in GitLab X.X.
```
```
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