Skip to content
代码片段 群组 项目
提交 047b71b1 编辑于 作者: Phillip Wells's avatar Phillip Wells
浏览文件

Merge branch 'sselhorn-master-patch-17077' into 'master'

Updating guidance to mention tier badge

See merge request https://gitlab.com/gitlab-org/gitlab/-/merge_requests/130357



Merged-by: default avatarPhillip Wells <pwells@gitlab.com>
Approved-by: default avatarPhillip Wells <pwells@gitlab.com>
Co-authored-by: default avatarSuzanne Selhorn <sselhorn@gitlab.com>
No related branches found
No related tags found
无相关合并请求
---
info: For assistance with this Style Guide page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects
stage: none
group: unassigned
redirect_to: 'experiment_beta.md'
remove_date: '2023-11-29'
---
# Documenting Experiment and Beta features
This document was moved to [another location](experiment_beta.md).
Some features are not generally available and are instead considered
[Experiment or Beta](../../policy/experiment-beta-support.md).
When you document a feature in one of these three statuses:
- Add `(Experiment)` or `(Beta)` in parentheses after the page or topic title.
- Do not include `(Experiment)` or `(Beta)` in the left nav.
- Ensure the version history lists the feature's status.
These features are usually behind a feature flag, which follow [these documentation guidelines](feature_flags.md).
If you add details of how users should enroll, or how to contact the team with issues,
the `FLAG:` note should be above these details.
For example:
```markdown
## Great new feature (Experiment)
> [Introduced](link) in GitLab 15.10. This feature is an [Experiment](<link_to>/policy/experiment-beta-support.md).
FLAG:
On self-managed GitLab, by default this feature is not available.
To make it available, an administrator can enable the feature flag named `example_flag`.
On GitLab.com, this feature is not available. This feature is not ready for production use.
Use this great new feature when you need to do this new thing.
This feature is an [Experiment](<link_to>/policy/experiment-beta-support.md). To join
the list of users testing this feature, do this thing. If you find a bug,
[open an issue](link).
```
When the feature is ready for production, remove:
- The text in parentheses.
- Any language about the feature not being ready for production in the body
description.
- The feature flag information if available.
Ensure the version history is up-to-date by adding a note about the production release.
<!-- This redirect file can be deleted after <2023-11-29>. -->
<!-- Redirects that point to other docs in the same project expire in three months. -->
<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. -->
<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html -->
---
info: For assistance with this Style Guide page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects
stage: none
group: unassigned
---
# Documenting Experiment and Beta features
Some features are not generally available and are instead considered
[Experiment or Beta](../../policy/experiment-beta-support.md).
When you document a feature in one of these three statuses:
- Add the tier badge after the page or topic title.
- Do not include `(Experiment)` or `(Beta)` in the left nav.
- Ensure the version history lists the feature's status.
These features are usually behind a feature flag, which follow [these documentation guidelines](feature_flags.md).
If you add details of how users should enroll, or how to contact the team with issues,
the `FLAG:` note should be above these details.
For example:
```markdown
## Great new feature **(EXPERIMENT)**
> [Introduced](link) in GitLab 15.10. This feature is an [Experiment](<link_to>/policy/experiment-beta-support.md).
FLAG:
On self-managed GitLab, by default this feature is not available.
To make it available, an administrator can enable the feature flag named `example_flag`.
On GitLab.com, this feature is not available. This feature is not ready for production use.
Use this great new feature when you need to do this new thing.
This feature is an [Experiment](<link_to>/policy/experiment-beta-support.md). To join
the list of users testing this feature, do this thing. If you find a bug,
[open an issue](link).
```
When the feature is ready for production, remove:
- The text in parentheses.
- Any language about the feature not being ready for production in the body
description.
- The feature flag information if available.
Ensure the version history is up-to-date by adding a note about the production release.
0% 加载中 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册