Documenting experimental and beta features

Some features are not generally available and are instead considered experimental or beta.

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 history lists the feature’s status.

These features are usually behind a feature flag, which follow these documentation guidelines.

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: 

## Great new feature

DETAILS:
**Status:** Experiment

> - [Introduced](https://issue-link) in GitLab 15.10. This feature is an [experiment](<link_to>/policy/experiment-beta-support.md).

FLAG:
The availability of this feature is controlled by a feature flag.
For more information, see the history.
This feature is available for testing, but not ready for production use.

Use this 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](https://link).

When features become generally available

When the feature changes from experiment or beta to generally available, remove:

  • The Status from the availability details.
  • Any language about the feature not being ready for production in the body description.
  • The feature flag information if available.

Ensure the history is up-to-date by adding a note about the production release.

GitLab Duo features

When a GitLab Duo feature becomes generally available:

  • In the top-level GitLab Duo page, move the topic from the Beta features or Experimental features section to the Generally available features section.
  • If the feature is documented in GitLab Duo experiments, move the content somewhere more appropriate (to other related features).
  • Make sure you update the history and status values, including any add-on information.