From 8f7a8a64cba377f56389945352f15f4cafa19cc9 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Mon, 1 Jul 2024 15:16:47 -0700 Subject: [PATCH 1/9] docs: PEM-5064 --- _partials/_feature_flags_overview.mdx | 6 ++++++ .../system-management/feature-flags.md | 12 ++++++++++++ .../vertex/system-management/feature-flags.md | 12 ++++++++++++ 3 files changed, 30 insertions(+) create mode 100644 _partials/_feature_flags_overview.mdx create mode 100644 docs/docs-content/enterprise-version/system-management/feature-flags.md create mode 100644 docs/docs-content/vertex/system-management/feature-flags.md diff --git a/_partials/_feature_flags_overview.mdx b/_partials/_feature_flags_overview.mdx new file mode 100644 index 0000000000..de7aff6a22 --- /dev/null +++ b/_partials/_feature_flags_overview.mdx @@ -0,0 +1,6 @@ +--- +partial_category: feature-flags +partial_name: feature-flags-overview +--- + +Feature flags are ..... {props.edition} diff --git a/docs/docs-content/enterprise-version/system-management/feature-flags.md b/docs/docs-content/enterprise-version/system-management/feature-flags.md new file mode 100644 index 0000000000..92b1f2757e --- /dev/null +++ b/docs/docs-content/enterprise-version/system-management/feature-flags.md @@ -0,0 +1,12 @@ +--- +sidebar_label: "Feature Flags" +title: "Feature Flags" +description: "Learn how to to use feature flags to manage features in Palette" +icon: "" +hide_table_of_contents: false +sidebar_position: 60 +tags: ["self-hosted", "management", "feature-flags"] +keywords: ["self-hosted", "palette", "feature-flags"] +--- + + diff --git a/docs/docs-content/vertex/system-management/feature-flags.md b/docs/docs-content/vertex/system-management/feature-flags.md new file mode 100644 index 0000000000..cdf4e9855b --- /dev/null +++ b/docs/docs-content/vertex/system-management/feature-flags.md @@ -0,0 +1,12 @@ +--- +sidebar_label: "Feature Flags" +title: "Feature Flags" +description: "Learn how to to use feature flags to manage features in Palette VerteX" +icon: "" +hide_table_of_contents: false +sidebar_position: 60 +tags: ["vertex", "management", "feature-flags"] +keywords: ["self-hosted", "vertex", "feature-flags"] +--- + + From 4c05ad7dd41190ee3402d16061cf9eee1ca2baf5 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Tue, 2 Jul 2024 05:46:44 -0700 Subject: [PATCH 2/9] draft --- _partials/_feature_flags_overview.mdx | 10 +++++++++- .../system-management/system-management.md | 2 ++ .../vertex/system-management/system-management.md | 2 ++ 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/_partials/_feature_flags_overview.mdx b/_partials/_feature_flags_overview.mdx index de7aff6a22..a7548cfca8 100644 --- a/_partials/_feature_flags_overview.mdx +++ b/_partials/_feature_flags_overview.mdx @@ -3,4 +3,12 @@ partial_category: feature-flags partial_name: feature-flags-overview --- -Feature flags are ..... {props.edition} + +Feature flags allows manage what features are available to the tenants in the system. +System administrators can use this capability to roll out new features to tenants in a controlled manner, or choose to +not implement a feature for their tenants due to security or compliance reasons. + +Features enabled by system administrators are applied to all tenants in the system. Once a feature is enabled, it cannot +be disabled. + +{props.edition} diff --git a/docs/docs-content/enterprise-version/system-management/system-management.md b/docs/docs-content/enterprise-version/system-management/system-management.md index 0719f37d0c..73aa4ab25f 100644 --- a/docs/docs-content/enterprise-version/system-management/system-management.md +++ b/docs/docs-content/enterprise-version/system-management/system-management.md @@ -50,6 +50,8 @@ Platform administrators can use the system console to perform the following oper - Enable metrics collection. +- [Manage feature flags](./feature-flags.md). + - Manage Palette platform upgrades. - Configuere login banner. diff --git a/docs/docs-content/vertex/system-management/system-management.md b/docs/docs-content/vertex/system-management/system-management.md index 3e22180715..ce80ffc8dc 100644 --- a/docs/docs-content/vertex/system-management/system-management.md +++ b/docs/docs-content/vertex/system-management/system-management.md @@ -44,6 +44,8 @@ System administrators can use the system console to perform the following operat - Enable metrics collection. +- [Manage feature flags](./feature-flags.md). + - [Manage VerteX platform upgrades](../upgrade/upgrade.md). - Configuere login banner. From 41c42c1bfcdf0fa5f1645f78a1969712b025ac0a Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Tue, 2 Jul 2024 06:13:25 -0700 Subject: [PATCH 3/9] docs: test --- _partials/_feature_flags_overview.mdx | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/_partials/_feature_flags_overview.mdx b/_partials/_feature_flags_overview.mdx index a7548cfca8..95b9ef5ba6 100644 --- a/_partials/_feature_flags_overview.mdx +++ b/_partials/_feature_flags_overview.mdx @@ -5,10 +5,15 @@ partial_name: feature-flags-overview Feature flags allows manage what features are available to the tenants in the system. -System administrators can use this capability to roll out new features to tenants in a controlled manner, or choose to +System administrators can use this capability to roll out new features to {props.edition} tenants in a controlled manner, or choose to not implement a feature for their tenants due to security or compliance reasons. Features enabled by system administrators are applied to all tenants in the system. Once a feature is enabled, it cannot be disabled. -{props.edition} +To learn how to manage feature flags, review the following section for detailed instructions on how to enable a feature +flag. + +## Enable a Feature + +Use the following steps to enable a feature flag. From 484570e478910b88959021727c45e210ac2c7b60 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Tue, 2 Jul 2024 07:38:05 -0700 Subject: [PATCH 4/9] docs: added draft --- _partials/_feature_flags_overview.mdx | 54 ++++++++++++++++++++++++--- 1 file changed, 48 insertions(+), 6 deletions(-) diff --git a/_partials/_feature_flags_overview.mdx b/_partials/_feature_flags_overview.mdx index 95b9ef5ba6..549aa4917a 100644 --- a/_partials/_feature_flags_overview.mdx +++ b/_partials/_feature_flags_overview.mdx @@ -4,16 +4,58 @@ partial_name: feature-flags-overview --- -Feature flags allows manage what features are available to the tenants in the system. -System administrators can use this capability to roll out new features to {props.edition} tenants in a controlled manner, or choose to -not implement a feature for their tenants due to security or compliance reasons. +Feature flags allow to +manage what features are available to the system's tenants. They can use this capability to roll out new features {prop.edition} tenants in a controlled manner or choose not to implement a feature for their tenants due to security or compliance reasons. Features enabled by system administrators are applied to all tenants in the system. Once a feature is enabled, it cannot be disabled. -To learn how to manage feature flags, review the following section for detailed instructions on how to enable a feature -flag. +To learn how to manage feature flags, review the following section for detailed instructions on enabling a feature flag. ## Enable a Feature -Use the following steps to enable a feature flag. +Use the following steps to enable a feature flag, but first, ensure your user meets the necessary prerequisites. + +## Prerequisites + +- You are a system administrator of the type _Operations Administrator_ or _Root Administrator_. + +- You have access to the system console. + +## Enablement + + +1. Log in to the system console. For additional guidance on accessing the system console, check out the + guide. + +2. From the left **Main Menu** select **Administration**. + +3. Select the **Feature Flags** tab. + +4. Locate the feature you want to enable and toggle the switch on the right to enable the feature. You can also search + for a feature by typing the feature name in the search bar. + +## Validate + +Use the following steps to validate that the feature flag is enabled. + +1. Log in as a tenant administrator to one of the tenants in the system. + +2. Depending on the feature, attempt to access it. If the feature is enabled, you will be able to use it. If the feature + is disabled, you will not be able to access it. + +export function PaletteURL({ edition, text, url }) { + return ( + <> + {edition.toLowerCase() === "palette" ? ( + + ) : ( + + )} + + ); +} From 2b7b6150389dbc7fd8a8adc15f62e0527cbe89b3 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Tue, 2 Jul 2024 07:39:16 -0700 Subject: [PATCH 5/9] chore: fix broken page issue --- _partials/_feature_flags_overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_partials/_feature_flags_overview.mdx b/_partials/_feature_flags_overview.mdx index 549aa4917a..812d1742f5 100644 --- a/_partials/_feature_flags_overview.mdx +++ b/_partials/_feature_flags_overview.mdx @@ -5,7 +5,7 @@ partial_name: feature-flags-overview Feature flags allow to -manage what features are available to the system's tenants. They can use this capability to roll out new features {prop.edition} tenants in a controlled manner or choose not to implement a feature for their tenants due to security or compliance reasons. +manage what features are available to the system's tenants. They can use this capability to roll out new features {props.edition} tenants in a controlled manner or choose not to implement a feature for their tenants due to security or compliance reasons. Features enabled by system administrators are applied to all tenants in the system. Once a feature is enabled, it cannot be disabled. From 6b548bc49cd10fddb75515e6168742e7e6ab86f4 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Tue, 2 Jul 2024 07:45:03 -0700 Subject: [PATCH 6/9] docs: added warning --- _partials/_feature_flags_overview.mdx | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/_partials/_feature_flags_overview.mdx b/_partials/_feature_flags_overview.mdx index 812d1742f5..ddc146d347 100644 --- a/_partials/_feature_flags_overview.mdx +++ b/_partials/_feature_flags_overview.mdx @@ -10,6 +10,13 @@ manage what features are available to the system's tenants. They can use this ca Features enabled by system administrators are applied to all tenants in the system. Once a feature is enabled, it cannot be disabled. +:::warning + +We recommend trying out new features in a test environment before enabling them in a production environment. Depending +on the feature, enabling it may have a significant impact on the system and current workloads. + +::: + To learn how to manage feature flags, review the following section for detailed instructions on enabling a feature flag. ## Enable a Feature From b0badb80d2b6bbdfdebb1222b207527a5c857a5d Mon Sep 17 00:00:00 2001 From: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com> Date: Wed, 10 Jul 2024 09:33:35 -0700 Subject: [PATCH 7/9] Apply suggestions from code review Co-authored-by: caroldelwing --- _partials/_feature_flags_overview.mdx | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/_partials/_feature_flags_overview.mdx b/_partials/_feature_flags_overview.mdx index ddc146d347..481da58eb5 100644 --- a/_partials/_feature_flags_overview.mdx +++ b/_partials/_feature_flags_overview.mdx @@ -5,7 +5,7 @@ partial_name: feature-flags-overview Feature flags allow to -manage what features are available to the system's tenants. They can use this capability to roll out new features {props.edition} tenants in a controlled manner or choose not to implement a feature for their tenants due to security or compliance reasons. +manage what features are available to the system's tenants. They can use this capability to roll out new features to {props.edition} tenants in a controlled manner or choose not to implement a feature for their tenants due to security or compliance reasons. Features enabled by system administrators are applied to all tenants in the system. Once a feature is enabled, it cannot be disabled. @@ -17,11 +17,11 @@ on the feature, enabling it may have a significant impact on the system and curr ::: -To learn how to manage feature flags, review the following section for detailed instructions on enabling a feature flag. +Review the following section for detailed instructions on enabling and managing feature flags. ## Enable a Feature -Use the following steps to enable a feature flag, but first, ensure your user meets the necessary prerequisites. +Use the following steps to enable a feature flag. ## Prerequisites @@ -39,11 +39,11 @@ Use the following steps to enable a feature flag, but first, ensure your user me url="/system-management/#access-the-system-console" /> guide. -2. From the left **Main Menu** select **Administration**. +2. From the left **Main Menu**, select **Administration**. 3. Select the **Feature Flags** tab. -4. Locate the feature you want to enable and toggle the switch on the right to enable the feature. You can also search +4. Locate the feature you want to enable and toggle the switch on the right to enable it. You can also search for a feature by typing the feature name in the search bar. ## Validate @@ -52,7 +52,7 @@ Use the following steps to validate that the feature flag is enabled. 1. Log in as a tenant administrator to one of the tenants in the system. -2. Depending on the feature, attempt to access it. If the feature is enabled, you will be able to use it. If the feature +2. Attempt to access the enabled feature flag. If the feature is enabled, you will be able to use it. If the feature is disabled, you will not be able to access it. export function PaletteURL({ edition, text, url }) { From 949b941998481e7ad31c98651b5246bbc677798f Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 10 Jul 2024 09:41:52 -0700 Subject: [PATCH 8/9] chore: fix prettier --- _partials/_feature_flags_overview.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_partials/_feature_flags_overview.mdx b/_partials/_feature_flags_overview.mdx index 481da58eb5..e16fa7bcfc 100644 --- a/_partials/_feature_flags_overview.mdx +++ b/_partials/_feature_flags_overview.mdx @@ -52,8 +52,8 @@ Use the following steps to validate that the feature flag is enabled. 1. Log in as a tenant administrator to one of the tenants in the system. -2. Attempt to access the enabled feature flag. If the feature is enabled, you will be able to use it. If the feature - is disabled, you will not be able to access it. +2. Attempt to access the enabled feature flag. If the feature is enabled, you will be able to use it. If the feature is + disabled, you will not be able to access it. export function PaletteURL({ edition, text, url }) { return ( From 31da5e49fb6aff2fa6b9c2fe4555ab3542e217ba Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 10 Jul 2024 10:00:04 -0700 Subject: [PATCH 9/9] chore: fixed partials --- .../_feature_flags_overview.mdx | 0 .../system-management/feature-flags.md | 4 +- .../vertex/system-management/feature-flags.md | 4 +- .../IconMapper/dynamicFontAwesomeImports.js | 100 +++++++++--------- 4 files changed, 56 insertions(+), 52 deletions(-) rename _partials/{ => feature_flags}/_feature_flags_overview.mdx (100%) diff --git a/_partials/_feature_flags_overview.mdx b/_partials/feature_flags/_feature_flags_overview.mdx similarity index 100% rename from _partials/_feature_flags_overview.mdx rename to _partials/feature_flags/_feature_flags_overview.mdx diff --git a/docs/docs-content/enterprise-version/system-management/feature-flags.md b/docs/docs-content/enterprise-version/system-management/feature-flags.md index 92b1f2757e..ecc3ecf4b9 100644 --- a/docs/docs-content/enterprise-version/system-management/feature-flags.md +++ b/docs/docs-content/enterprise-version/system-management/feature-flags.md @@ -9,4 +9,6 @@ tags: ["self-hosted", "management", "feature-flags"] keywords: ["self-hosted", "palette", "feature-flags"] --- - +import FeatureFlagsPartial from "../../../../_partials/feature_flags/_feature_flags_overview.mdx"; + + diff --git a/docs/docs-content/vertex/system-management/feature-flags.md b/docs/docs-content/vertex/system-management/feature-flags.md index cdf4e9855b..df03ea0ecb 100644 --- a/docs/docs-content/vertex/system-management/feature-flags.md +++ b/docs/docs-content/vertex/system-management/feature-flags.md @@ -9,4 +9,6 @@ tags: ["vertex", "management", "feature-flags"] keywords: ["self-hosted", "vertex", "feature-flags"] --- - +import FeatureFlagsPartial from "../../../../_partials/feature_flags/_feature_flags_overview.mdx"; + + diff --git a/src/components/IconMapper/dynamicFontAwesomeImports.js b/src/components/IconMapper/dynamicFontAwesomeImports.js index 4057225659..a98f03e718 100644 --- a/src/components/IconMapper/dynamicFontAwesomeImports.js +++ b/src/components/IconMapper/dynamicFontAwesomeImports.js @@ -1,51 +1,51 @@ -import { faCubes } from '@fortawesome/free-solid-svg-icons'; -import { faTerminal } from '@fortawesome/free-solid-svg-icons'; -import { faPersonWalkingLuggage } from '@fortawesome/free-solid-svg-icons'; -import { faObjectGroup } from '@fortawesome/free-solid-svg-icons'; -import { faEnvelopeOpenText } from '@fortawesome/free-solid-svg-icons'; -import { faDatabase } from '@fortawesome/free-solid-svg-icons'; -import { faHdd } from '@fortawesome/free-solid-svg-icons'; -import { faCloudArrowDown } from '@fortawesome/free-solid-svg-icons'; -import { faNetworkWired } from '@fortawesome/free-solid-svg-icons'; -import { faServer } from '@fortawesome/free-solid-svg-icons'; -import { faUsers } from '@fortawesome/free-solid-svg-icons'; -import { faWarehouse } from '@fortawesome/free-solid-svg-icons'; -import { faFlagCheckered } from '@fortawesome/free-solid-svg-icons'; -import { faPalette } from '@fortawesome/free-solid-svg-icons'; -import { faBook } from '@fortawesome/free-solid-svg-icons'; -import { faBookmark } from '@fortawesome/free-solid-svg-icons'; -import { faGavel } from '@fortawesome/free-solid-svg-icons'; -import { faTowerObservation } from '@fortawesome/free-solid-svg-icons'; -import { faLock } from '@fortawesome/free-solid-svg-icons'; -import { faGears } from '@fortawesome/free-solid-svg-icons'; -import { faScrewdriverWrench } from '@fortawesome/free-solid-svg-icons'; -import { faEyeSlash } from '@fortawesome/free-solid-svg-icons'; -import { faShield } from '@fortawesome/free-solid-svg-icons'; -import { faMicrochip } from '@fortawesome/free-solid-svg-icons'; - -export const fontAwesomeIcons = { - "cubes": faCubes, - "terminal": faTerminal, - "person-walking-luggage": faPersonWalkingLuggage, - "object-group": faObjectGroup, - "envelope-open-text": faEnvelopeOpenText, - "database": faDatabase, - "hdd": faHdd, - "cloud-arrow-down": faCloudArrowDown, - "network-wired": faNetworkWired, - "server": faServer, - "users": faUsers, - "warehouse": faWarehouse, - "flag-checkered": faFlagCheckered, - "palette": faPalette, - "book": faBook, - "bookmark": faBookmark, - "gavel": faGavel, - "tower-observation": faTowerObservation, - "lock": faLock, - "gears": faGears, - "screwdriver-wrench": faScrewdriverWrench, - "eye-slash": faEyeSlash, - "shield": faShield, - "microchip": faMicrochip +import { faCubes } from '@fortawesome/free-solid-svg-icons'; +import { faTerminal } from '@fortawesome/free-solid-svg-icons'; +import { faPersonWalkingLuggage } from '@fortawesome/free-solid-svg-icons'; +import { faObjectGroup } from '@fortawesome/free-solid-svg-icons'; +import { faEnvelopeOpenText } from '@fortawesome/free-solid-svg-icons'; +import { faDatabase } from '@fortawesome/free-solid-svg-icons'; +import { faHdd } from '@fortawesome/free-solid-svg-icons'; +import { faCloudArrowDown } from '@fortawesome/free-solid-svg-icons'; +import { faNetworkWired } from '@fortawesome/free-solid-svg-icons'; +import { faServer } from '@fortawesome/free-solid-svg-icons'; +import { faUsers } from '@fortawesome/free-solid-svg-icons'; +import { faWarehouse } from '@fortawesome/free-solid-svg-icons'; +import { faFlagCheckered } from '@fortawesome/free-solid-svg-icons'; +import { faPalette } from '@fortawesome/free-solid-svg-icons'; +import { faBook } from '@fortawesome/free-solid-svg-icons'; +import { faBookmark } from '@fortawesome/free-solid-svg-icons'; +import { faGavel } from '@fortawesome/free-solid-svg-icons'; +import { faTowerObservation } from '@fortawesome/free-solid-svg-icons'; +import { faLock } from '@fortawesome/free-solid-svg-icons'; +import { faGears } from '@fortawesome/free-solid-svg-icons'; +import { faScrewdriverWrench } from '@fortawesome/free-solid-svg-icons'; +import { faEyeSlash } from '@fortawesome/free-solid-svg-icons'; +import { faShield } from '@fortawesome/free-solid-svg-icons'; +import { faMicrochip } from '@fortawesome/free-solid-svg-icons'; + +export const fontAwesomeIcons = { + "cubes": faCubes, + "terminal": faTerminal, + "person-walking-luggage": faPersonWalkingLuggage, + "object-group": faObjectGroup, + "envelope-open-text": faEnvelopeOpenText, + "database": faDatabase, + "hdd": faHdd, + "cloud-arrow-down": faCloudArrowDown, + "network-wired": faNetworkWired, + "server": faServer, + "users": faUsers, + "warehouse": faWarehouse, + "flag-checkered": faFlagCheckered, + "palette": faPalette, + "book": faBook, + "bookmark": faBookmark, + "gavel": faGavel, + "tower-observation": faTowerObservation, + "lock": faLock, + "gears": faGears, + "screwdriver-wrench": faScrewdriverWrench, + "eye-slash": faEyeSlash, + "shield": faShield, + "microchip": faMicrochip }; \ No newline at end of file