From b7d024c426e3f29dbcfcaf91628d2bdb4ec0b82d Mon Sep 17 00:00:00 2001 From: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com> Date: Mon, 13 May 2024 12:44:14 -0400 Subject: [PATCH] Docs: update headings and add release info (#87058) * Updated headings and to align with release life cycle stages and adding release info * Update generated files Signed-off-by: Jack Baldry --------- Signed-off-by: Jack Baldry Co-authored-by: Jack Baldry --- .../configure-grafana/feature-toggles/index.md | 14 +++++++++----- pkg/services/featuremgmt/toggles_gen_test.go | 14 +++++++++----- 2 files changed, 18 insertions(+), 10 deletions(-) diff --git a/docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md b/docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md index 44879c127e0..b6ea344bd2d 100644 --- a/docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md +++ b/docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md @@ -7,7 +7,7 @@ weight: 150 --- - + # Configure feature toggles @@ -15,9 +15,11 @@ You use feature toggles, also known as feature flags, to enable or disable featu This page contains a list of available feature toggles. To learn how to turn on feature toggles, refer to our [Configure Grafana documentation]({{< relref "../_index.md#feature_toggles" >}}). Feature toggles are also available to Grafana Cloud Advanced customers. If you use Grafana Cloud Advanced, you can open a support ticket and specify the feature toggles and stack for which you want them enabled. -## Feature toggles +For more information about feature release stages, refer to [Release life cycle for Grafana Labs](https://grafana.com/docs/release-life-cycle/) and [Manage feature toggles](https://grafana.com/docs/grafana//administration/feature-toggles/#manage-feature-toggles). -Some features are enabled by default. You can disable these feature by setting the feature flag to "false" in the configuration. +## General availability feature toggles + +[Generally available](https://grafana.com/docs/release-life-cycle/#general-availability) features are enabled by default. You can disable these feature by setting the feature flag to "false" in the configuration. | Feature toggle name | Description | Enabled by default | | ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | @@ -63,7 +65,9 @@ Some features are enabled by default. You can disable these feature by setting t | `betterPageScrolling` | Removes CustomScrollbar from the UI, relying on native browser scrollbars | Yes | | `cloudWatchNewLabelParsing` | Updates CloudWatch label parsing to be more accurate | Yes | -## Preview feature toggles +## Public preview feature toggles + +[Public preview](https://grafana.com/docs/release-life-cycle/#public-preview) features are supported by our Support teams, but might be limited to enablement, configuration, and some troubleshooting. | Feature toggle name | Description | | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -100,7 +104,7 @@ Some features are enabled by default. You can disable these feature by setting t ## Experimental feature toggles -These features are early in their development lifecycle and so are not yet supported in Grafana Cloud. +[Experimental](https://grafana.com/docs/release-life-cycle/#experimental) features are early in their development lifecycle and so are not yet supported in Grafana Cloud. Experimental features might be changed or removed without prior notice. | Feature toggle name | Description | diff --git a/pkg/services/featuremgmt/toggles_gen_test.go b/pkg/services/featuremgmt/toggles_gen_test.go index 6881e21d07b..9247c7c6005 100644 --- a/pkg/services/featuremgmt/toggles_gen_test.go +++ b/pkg/services/featuremgmt/toggles_gen_test.go @@ -329,7 +329,7 @@ weight: 150 --- - + # Configure feature toggles @@ -337,16 +337,20 @@ You use feature toggles, also known as feature flags, to enable or disable featu This page contains a list of available feature toggles. To learn how to turn on feature toggles, refer to our [Configure Grafana documentation]({{< relref "../_index.md#feature_toggles" >}}). Feature toggles are also available to Grafana Cloud Advanced customers. If you use Grafana Cloud Advanced, you can open a support ticket and specify the feature toggles and stack for which you want them enabled. -## Feature toggles +For more information about feature release stages, refer to [Release life cycle for Grafana Labs](https://grafana.com/docs/release-life-cycle/) and [Manage feature toggles](https://grafana.com/docs/grafana//administration/feature-toggles/#manage-feature-toggles). -Some features are enabled by default. You can disable these feature by setting the feature flag to "false" in the configuration. +## General availability feature toggles + +[Generally available](https://grafana.com/docs/release-life-cycle/#general-availability) features are enabled by default. You can disable these feature by setting the feature flag to "false" in the configuration. ` + writeToggleDocsTable(func(flag FeatureFlag) bool { return flag.Stage == FeatureStageGeneralAvailability }, true) buf += ` -## Preview feature toggles +## Public preview feature toggles + +[Public preview](https://grafana.com/docs/release-life-cycle/#public-preview) features are supported by our Support teams, but might be limited to enablement, configuration, and some troubleshooting. ` + writeToggleDocsTable(func(flag FeatureFlag) bool { return flag.Stage == FeatureStagePublicPreview @@ -366,7 +370,7 @@ When features are slated for removal, they will be marked as Deprecated first. buf += ` ## Experimental feature toggles -These features are early in their development lifecycle and so are not yet supported in Grafana Cloud. +[Experimental](https://grafana.com/docs/release-life-cycle/#experimental) features are early in their development lifecycle and so are not yet supported in Grafana Cloud. Experimental features might be changed or removed without prior notice. ` + writeToggleDocsTable(func(flag FeatureFlag) bool {