From 101545e387f753f258f7f35013dd78fef4c35f31 Mon Sep 17 00:00:00 2001 From: Christian Vogt Date: Mon, 16 Sep 2024 14:31:59 -0400 Subject: [PATCH] add doc for dev feature flags (#3211) --- docs/dev-setup.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/dev-setup.md b/docs/dev-setup.md index 2d649bdf50..fd65ebe3ab 100644 --- a/docs/dev-setup.md +++ b/docs/dev-setup.md @@ -58,6 +58,12 @@ Run the tests. For in-depth testing guidance review the [testing guidelines](./testing.md) +### Dev Feature Flags + +Feature flags are defined in the [dashboard config](./dashboard-config.md#features). When testing on a live cluster, changing feature flags via the config affects all users on the cluster. It is also possible to personally control the enablement of feature flags within the browser session. Simply append `?devFeatureFlags` to the dashboard URL. A blue banner will appear at the top of the page where a modal can be opened, allowing one to adjust the enablement of feature flags. These settings will persist for the length of the browser session. + +With the dev feature flags modal opened, the browser URL will update to include the current feature flag enablement settings. The URL can then be bookmarked or shared. + ## Deploying the ODH Dashbard ### Official Image Builds