diff options
Diffstat (limited to 'doc/development')
| -rw-r--r-- | doc/development/documentation/alpha_beta.md | 43 | ||||
| -rw-r--r-- | doc/development/service_ping/metrics_lifecycle.md | 2 |
2 files changed, 44 insertions, 1 deletions
diff --git a/doc/development/documentation/alpha_beta.md b/doc/development/documentation/alpha_beta.md new file mode 100644 index 00000000000..4b5c24d512f --- /dev/null +++ b/doc/development/documentation/alpha_beta.md @@ -0,0 +1,43 @@ +--- +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 +--- + +# Document Alpha, Beta, LA features + +Some features are not generally available and are instead considered +[Alpha, Beta, or Limited Availability](../../policy/alpha-beta-support.md). + +When you document a feature in one of these three statuses: + +- Add `(Alpha)`, `(Beta)`, or `(Limited Availability)` in parentheses after the page or topic title. +- Do not include `(Alpha)`, `(Beta)`, or `(Limited Availability)` 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 (Alpha) + +FLAG: +On self-managed GitLab, by default this feature is not available. +To make it available, ask an administrator to 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 in Alpha. 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 released, remove: + +- The text in parentheses. +- Any language about the feature not being ready for production. +- The feature flag information. + +Ensure the version history is up-to-date. diff --git a/doc/development/service_ping/metrics_lifecycle.md b/doc/development/service_ping/metrics_lifecycle.md index 1c9cc5b15b7..7fcbafe50f7 100644 --- a/doc/development/service_ping/metrics_lifecycle.md +++ b/doc/development/service_ping/metrics_lifecycle.md @@ -111,7 +111,7 @@ To remove a metric: can be safely removed from Service Ping. Use this [example issue](https://gitlab.com/gitlab-data/analytics/-/issues/15266) for guidance. -1. Notify the Customer Success Ops team (`@csops-team`), Analytics Engineers (`@gitlab-data/analytics-engineers`), and Product Analysts (`@gitlab-data/product-analysts`) by `@` mentioning those groups in a comment in the issue regarding the deletion of the metric. +1. Notify the Customer Success Ops team (`@csops-team`), Analytics Engineers (`@gitlab-data/analytics-engineers`), and Product Analysts (`@gitlab-data/product-analysts`) by `@` mentioning those groups in a comment in the issue from step 1 regarding the deletion of the metric. Many Service Ping metrics are relied upon for health score and XMAU reporting and unexpected changes to those metrics could break reporting. 1. After you verify the metric can be safely removed, |