Documenting experimental and beta features

When you document an experiment or beta feature:

When features become generally available

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

  • Remove the Status from the product availability details.
  • Remove any language about the feature not being ready for production.
  • Update the history.

Features that require user enrollment or feedback

To include details about how users should enroll or leave feedback, add it below the FLAG: note.

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).

GitLab Duo features

Follow these guidelines when you document GitLab Duo features.

Experiment

When documenting a GitLab Duo experiment:

Beta

When a GitLab Duo experiment moves to beta:

  • On the top-level GitLab Duo page, move the topic from the Experimental features to the Beta features section.
  • If the feature is documented on the GitLab Duo experiments page, move the content somewhere more appropriate (near other related features).
  • Make sure you update the history and status values, including any add-on information.
  • For features that are part of the Early Access Program in the #developer-relations-early-access-program Slack channel, post a comment that mentions the feature and its status.

Generally available

When a GitLab Duo feature becomes generally available:

  • On 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 on the GitLab Duo experiments page, move the content somewhere more appropriate (near other related features).
  • Make sure you update the history and status values, including any add-on information.
  • For features that are part of the Early Access Program in the #developer-relations-early-access-program Slack channel, post a comment that mentions the feature and its status.