From 82b835d15d3250cab2308a77dd3f0965056f4fe9 Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Thu, 20 Feb 2025 17:14:34 +0530 Subject: [PATCH 01/25] Applied changes --- ...proc-customize-rhdh-sidebar-menuitems.adoc | 8 ++++---- ...g-the-layout-of-the-product-home-page.adoc | 8 ++++---- ...provide-data-to-the-quick-access-card.adoc | 20 +++++++++---------- ...provide-data-to-the-quick-access-card.adoc | 2 -- .../proc-customize-rhdh-tech-radar-page.adoc | 2 +- 5 files changed, 19 insertions(+), 21 deletions(-) diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc index 201d15172d..eb1cf5652b 100644 --- a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc @@ -9,12 +9,12 @@ The sidebar menu in {product} consists of two main parts: .Procedure -. Customize the main menu items using the following steps: +Customize the main menu items using the following steps: + -- -.. Open the `app-config-rhdh.yaml` file. -.. To customize the order and parent-child relationships for the main menu items, use the `dynamicPlugins.frontend.default.main-menu-items.menuItems` field. -.. For dynamic plugin menu items, use the `dynamicPlugins.frontend..menuItems` field. +. Open the `app-config-rhdh.yaml` file. +. To customize the order and parent-child relationships for the main menu items, use the `dynamicPlugins.frontend.default.main-menu-items.menuItems` field. +. For dynamic plugin menu items, use the `dynamicPlugins.frontend..menuItems` field. .Example `app-config-rhdh.yaml` file [source,yaml] diff --git a/modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc b/modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc index a8deb3d9ec..b55b493df0 100644 --- a/modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc +++ b/modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc @@ -12,8 +12,8 @@ ** position (x and y) .Procedure -* Configure your {product-short} `app-config.yaml` configuration file by choosing one of the following options: -** Use the full space on smaller windows and half of the space on larger windows as follows: +. Configure your {product-short} `app-config.yaml` configuration file by choosing one of the following options: +.. Use the full space on smaller windows and half of the space on larger windows as follows: [source,yaml] ---- @@ -36,7 +36,7 @@ dynamicPlugins: debugContent: a placeholder ---- -** Show the cards side by side by defining the `x` parameter as follows: +.. Show the cards side by side by defining the `x` parameter as follows: [source,yaml] ---- @@ -73,7 +73,7 @@ dynamicPlugins: ---- However, you can see a second card below this card by default. -* Show the cards in three columns by defining the `x` parameter as follows: +. Show the cards in three columns by defining the `x` parameter as follows: [source,yaml] ---- diff --git a/modules/customizing-the-quick-access-card/proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc b/modules/customizing-the-quick-access-card/proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc index 60348bd630..204409c38a 100644 --- a/modules/customizing-the-quick-access-card/proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc +++ b/modules/customizing-the-quick-access-card/proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc @@ -6,7 +6,7 @@ [id="using-a-dedicated-service-to-provide-data-to-the-quick-access-card_{context}"] = Using a dedicated service to provide data to the Quick access card -When using a dedicated service, you can do the following: +When using a dedicated service, you can do the following tasks: * Use the same service to provide the data to all configurable {product-short} pages or use a different service for each page. * Use the https://github.com/redhat-developer/red-hat-developer-hub-customization-provider[`red-hat-developer-hub-customization-provider`] as an example service, which provides data for both the Home and Tech Radar pages. The `red-hat-developer-hub-customization-provider` service provides the same data as default {product-short} data. You can fork the `red-hat-developer-hub-customization-provider` service repository from GitHub and modify it with your own data, if required. @@ -14,7 +14,7 @@ When using a dedicated service, you can do the following: .Prerequisites -* You have installed the {product} using Helm Chart. +* You have installed the {product} using Helm chart. For more information, see xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart]. .Procedure @@ -28,12 +28,12 @@ To use a separate service to provide the Home page data, complete the following To use the `red-hat-developer-hub-customization-provider` service, add the URL for the https://github.com/redhat-developer/red-hat-developer-hub-customization-provider[red-hat-developer-hub-customization-provider] repository or your fork of the repository containing your customizations. -- -. On the *General* tab, enter *red-hat-developer-hub-customization-provider* in the *Name* field and click *Create*. -. On the *Advanced Options* tab, copy the value from the *Target Port*. +. On the *General* tab, enter `red-hat-developer-hub-customization-provider` in the *Name* field and click *Create*. +. On the *Advanced Options* tab, copy the value from *Target Port*. + [NOTE] ==== -The *Target Port* automatically generates a Kubernetes or {ocp-short} service to communicate with. +*Target Port* automatically generates a Kubernetes or {ocp-short} service to communicate with. ==== + . Add the following code to the `app-config-rhdh.yaml` file: @@ -45,12 +45,12 @@ proxy: # Other Proxies # customize developer hub instance '/developer-hub': - target: ${HOMEPAGE_DATA_URL} + target: ${HOMEPAGE_DATA_URL} <1> changeOrigin: true # Change to "false" in case of using self-hosted cluster with a self-signed certificate secure: true ---- -where `HOMEPAGE_DATA_URL` is defined as `pass:c[http://:8080]`, for example, `pass:c[http://rhdh-customization-provider:8080]`. +<1> `pass:c[http://:8080]`, for example, `pass:c[http://rhdh-customization-provider:8080]`. + [NOTE] ==== @@ -62,11 +62,11 @@ The `red-hat-developer-hub-customization-provider` service contains the 8080 por . Delete the {product-short} pod to ensure that the new configurations are loaded correctly. .Verification -* To view the service, navigate to the *Administrator* perspective in the {ocp-short} web console and click *Networking* > *Service*. +* To view the service, go to the *Administrator* perspective in the {ocp-short} web console and click *Networking* > *Service*. + [NOTE] ==== -You can also view the *Service Resources* in the Topology view. +You can also view *Service Resources* in the Topology view. ==== * Ensure that the provided API URL for the Home page returns the data in JSON format as shown in the following example: @@ -109,7 +109,7 @@ You can also view the *Service Resources* in the Topology view. If the request call fails or is not configured, the {product-short} instance falls back to the default local data. ==== -* If the images or icons do not load, then allowlist them by adding your image or icon host URLs to the content security policy’s (csp) `img-src` in your custom ConfigMap as follows: +* If the images or icons do not load, then allowlist them by adding your image or icon host URLs to the content security policy (csp) `img-src` in your custom ConfigMap as shown in the following example: [source,yaml] ---- diff --git a/modules/customizing-the-quick-access-card/proc-using-hosted-json-files-to-provide-data-to-the-quick-access-card.adoc b/modules/customizing-the-quick-access-card/proc-using-hosted-json-files-to-provide-data-to-the-quick-access-card.adoc index 585c7f447f..3158bda1a0 100644 --- a/modules/customizing-the-quick-access-card/proc-using-hosted-json-files-to-provide-data-to-the-quick-access-card.adoc +++ b/modules/customizing-the-quick-access-card/proc-using-hosted-json-files-to-provide-data-to-the-quick-access-card.adoc @@ -14,8 +14,6 @@ See xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp[{installing-on-o .Procedure * To access the data from the JSON files, add the following code to the {product-short} `app-config.yaml` configuration file: - -* Add the following code to the `app-config.yaml` file: + [source,yaml] ---- diff --git a/modules/customizing-the-tech-radar-page/proc-customize-rhdh-tech-radar-page.adoc b/modules/customizing-the-tech-radar-page/proc-customize-rhdh-tech-radar-page.adoc index 7fccb0536d..4659f8518c 100644 --- a/modules/customizing-the-tech-radar-page/proc-customize-rhdh-tech-radar-page.adoc +++ b/modules/customizing-the-tech-radar-page/proc-customize-rhdh-tech-radar-page.adoc @@ -48,7 +48,7 @@ When using a dedicated service, you can do the following: .Prerequisites -* You have installed the {product} using Helm Chart. +* You have installed the {product} using Helm chart. For more information, see xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart]. .Procedure From 7aa3f8c72b190987a95c3e21f18491a5e335d8dd Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Wed, 26 Feb 2025 15:22:58 +0530 Subject: [PATCH 02/25] Incorporated comments --- .../proc-customize-rhdh-sidebar-menuitems.adoc | 6 +++--- .../proc-defining-the-layout-of-the-product-home-page.adoc | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc index eb1cf5652b..1aeeb5dee9 100644 --- a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc @@ -12,9 +12,9 @@ The sidebar menu in {product} consists of two main parts: Customize the main menu items using the following steps: + -- -. Open the `app-config-rhdh.yaml` file. -. To customize the order and parent-child relationships for the main menu items, use the `dynamicPlugins.frontend.default.main-menu-items.menuItems` field. -. For dynamic plugin menu items, use the `dynamicPlugins.frontend..menuItems` field. +. Open the `app-config-rhdh.yaml` file and do any of the following tasks: +* To customize the order and parent-child relationships for the main menu items, enter the `dynamicPlugins.frontend.default.main-menu-items.menuItems` field. +* To add dynamic plugin menu items, enter the `dynamicPlugins.frontend..menuItems` field. .Example `app-config-rhdh.yaml` file [source,yaml] diff --git a/modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc b/modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc index b55b493df0..3087308038 100644 --- a/modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc +++ b/modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc @@ -13,7 +13,7 @@ .Procedure . Configure your {product-short} `app-config.yaml` configuration file by choosing one of the following options: -.. Use the full space on smaller windows and half of the space on larger windows as follows: +* Use the full space on smaller windows and half of the space on larger windows as shown in the following example: [source,yaml] ---- @@ -36,7 +36,7 @@ dynamicPlugins: debugContent: a placeholder ---- -.. Show the cards side by side by defining the `x` parameter as follows: +* Show the cards side by side by defining the `x` parameter as shown in the following example: [source,yaml] ---- From 72f8589d69256c759bb89d778d3f75fc7a736c10 Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Thu, 6 Mar 2025 17:05:10 +0530 Subject: [PATCH 03/25] Incorporated Fabrice's comments --- ...proc-customize-rhdh-sidebar-menuitems.adoc | 139 +++++------------- 1 file changed, 36 insertions(+), 103 deletions(-) diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc index 1aeeb5dee9..089bdfaa28 100644 --- a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc @@ -7,123 +7,56 @@ The sidebar menu in {product} consists of two main parts: * *Dynamic plugin menu items*: These items are displayed beneath the main menu and can be customized based on the plugins installed. The main menu items section is dynamic and can change based on your preferences and installed plugins. + .Procedure -Customize the main menu items using the following steps: +. To configure a Dynamic plugin menu item, add the following content to your `{my-app-config-file}` file: + --- -. Open the `app-config-rhdh.yaml` file and do any of the following tasks: -* To customize the order and parent-child relationships for the main menu items, enter the `dynamicPlugins.frontend.default.main-menu-items.menuItems` field. -* To add dynamic plugin menu items, enter the `dynamicPlugins.frontend..menuItems` field. - -.Example `app-config-rhdh.yaml` file [source,yaml] ---- dynamicPlugins: frontend: - : # same as `scalprum.name` key in plugin's `package.json` - menuItems: # optional, allows you to configure plugin menu items in the main sidebar navigation - : # unique name in the plugin menu items list <1> - icon: home | group | category | extension | school | __ # <2> - title: My Plugin Page # optional, same as `menuItem.text` in `dynamicRoutes` <3> - priority: 10 # optional, defines the order of menu items in the sidebar <4> - parent: favorites # optional, defines parent-child relationships for nested menu items <5> ----- - -You can modify the fields in the previous example to configure the desired order and parent-child relationships of the sidebar menu items. - -<1> This attribute represents a unique name in the main sidebar navigation. It can denote either a standalone menu item or a parent menu item. If this attribute represents a plugin menu item, the name of the attribute must match with the corresponding path in `dynamicRoutes`. For example, if `dynamicRoutes` defines `path: /my-plugin`, then `menu_item_name` must be defined as `my-plugin`. + : # <1> + menuItems: # <2> + : # <3> + icon: # home | group | category | extension | school | __ <4> + title: My Plugin Page # <5> + priority: 10 # <6> + parent: favorites # <7> +---- +<1> `__`: Specifies the name of the package that is the same as `scalprum.name` key in the `package.json` of the plugin. +<2> `menuItems`: (Optional) Allows you to configure plugin menu items in the main sidebar navigation. +<3> `__`: Represents a unique name in the main sidebar navigation. It can denote either a standalone menu item or a parent menu item. If this attribute represents a plugin menu item, the name of the attribute must match with the corresponding path in `dynamicRoutes`. For example, if `dynamicRoutes` defines `path: /my-plugin`, then `menu_item_name` must be defined as `my-plugin`. +<4> `icon`: (Optional) Specifies the icon for the menu item. You can use default icons or extend the icon set with dynamic plugins. {product-short} also provides additional icons in its internal library, such as: +<5> `title`: (Optional) Specifies the title of the menu item. It can be removed if the title is already specified in the `dynamicRoutes` configuration under `menuItem.text`. +<6> `priority`: (Optional) Sets the order in which menu items appear in the sidebar. The default priority is 0, which places the item at the bottom of the list. A higher priority value places the item higher in the sidebar. You can define this attribute for each section. +<7> `parent`: (Optional) Specifies the parent menu item under which the current item is nested. If this attribute is used, the parent menu item must be defined elsewhere in the `menuItems` configuration of any enabled plugin. You can define this attribute for each section. + +. To add Main menu item, add the `default.` prefix to its key in your `{my-app-config-file}` file: + -For more complex, multi-segment paths such as `path: /metrics/users/info`, the `menu_item_name` must use dot notation to represent the full path, for example, `metrics.users.info`. Trailing and leading slashes in paths are ignored. For example, `path: /docs` results in `menu_item_name: docs`, and `path: /metrics/users` results in `menu_item_name: metrics.users`. - -<2> This optional attribute specifies the icon for the menu item. You can use default icons or extend the icon set with dynamic plugins. {product-short} also provides additional icons in its internal library, such as: -+ -.Home Icon in the internal library -[source, yaml] ----- -dynamicPlugins: - frontend: - : - menuItems: - : - icon: home ----- -+ -Similarly, the internal library includes icons for `group`, `category`, `extension`, and `school`. If the icon is already defined in the `dynamicRoutes` configuration under `menuItem.icon`, it can be removed from the in the `menuItems` configuration. Also, both SVG and HTML image icons are supported. For example: -+ -.Example SVG icon -[source,html] ----- -icon: ... ----- -+ -.Example image icon -[source,html] ----- -icon: https://img.icons8.com/ios-glyphs/20/FFFFFF/shop.png ----- - -<3> This optional attribute specifies the title of the menu item. It can be removed if the title is already specified in the `dynamicRoutes` configuration under `menuItem.text`. - -<4> This optional attribute sets the order in which menu items appear in the sidebar. The default priority is 0, which places the item at the bottom of the list. A higher priority value places the item higher in the sidebar. You can define this attribute for each section. - -<5> This optional attribute specifies the parent menu item under which the current item is nested. If this attribute is used, the parent menu item must be defined elsewhere in the `menuItems` configuration of any enabled plugin. You can define this attribute for each section. - -.Example `menuItems` configuration [source,yaml] ---- dynamicPlugins: frontend: - : - dynamicRoutes: - - path: /my-plugin - module: CustomModule - importName: FooPluginPage - menuItem: - icon: fooIcon - text: Foo Plugin Page + default.main-menu-items: # <1> menuItems: - my-plugin: # matches `path` in `dynamicRoutes` - priority: 10 # controls order of plugins under the parent menu item - parent: favorites # nests this plugin under the `favorites` parent menu item - favorites: # configuration for the parent menu item - icon: favorite # icon from RHDH system icons - title: Favorites # title for the parent menu item - priority: 100 # controls the order of this top-level menu item ----- --- - -. To ensure that a menu item is identified as a main menu item, you must add the `default.` prefix to its key. For example: -+ --- -.Example configuration of main menu items in sidebar navigation -[source,yaml] ----- -dynamicPlugins: - frontend: - default.main-menu-items: # key for configuring static main menu items - menuItems: - default.: # key of the menu item configuration. `default.` prefix is required for a main menu item key <1> - parent: my_menu_group # optional, specifies the parent menu item for this item - priority: 10 # optional, specifies the order of this menu item within its menu level - default.: # must be configured if it is specified as the parent of any menu items. `default.` prefix is required for a main group parent item key <1> - icon: my_menu_group_icon # required for parent menu items, defines the icon for the menu group - title: my_menu_group_title # required for parent menu items, defines the icon for the menu group - priority: 100 # optional, specifies the order of the parent menu item in the sidebar ----- - - -<1> The `default.` prefix identifies an item as a main menu item. You can add the `default.` prefix to both individual menu items or parent menu group configuration, such as `default.` in the previous example. + default.: # <2> + parent: my_menu_group # <3> + priority: 10 # <4> + default.: # <4> + icon: my_menu_group_icon # <5> + title: my_menu_group_title # <6> + priority: 100 # <7> +---- +<1> `default.main-menu-items`: Specifies the key for configuring static main menu items. The `default.` prefix identifies an item as a main menu item. You can add the `default.` prefix to both individual menu items or parent menu group configuration, such as `default.` in the previous example. +<2> `default.__`: Specifies the key of the menu item configuration. `default.` prefix is required for a main menu item key. +<3> `parent`: (Optional) Specifies the parent menu item for this item. +<4> `priority`: (Optional) Specifies the order of this menu item within its menu level. +<5> `icon`: Required for parent menu items It defines the icon for the menu group. +<6> `title`: Required for parent menu items. It defines the icon for the menu group. +<7> `priority`: (Optional) Specifies the order of the parent menu item in the sidebar. [NOTE] ==== The default priority of main menu items determines their order in the sidebar. You can customize the order of the static main menu items by adjusting their priority values. Ensure that the priority and title of each item is clear to facilitate easy reordering. -==== --- - - - - - - - +==== \ No newline at end of file From 88b45a833774c9a99eaa887ebb748fed4728d26b Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Thu, 6 Mar 2025 17:44:42 +0530 Subject: [PATCH 04/25] Incorporated comments Fabrice's --- ...proc-customize-rhdh-sidebar-menuitems.adoc | 39 +++++++++---------- 1 file changed, 19 insertions(+), 20 deletions(-) diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc index 089bdfaa28..9e6ca6006b 100644 --- a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc @@ -3,10 +3,9 @@ The sidebar menu in {product} consists of two main parts: -* *Main menu items*: These items are the static menu items that form the core navigation structure of sidebar. These menu items remain consistent and are predefined. - * *Dynamic plugin menu items*: These items are displayed beneath the main menu and can be customized based on the plugins installed. The main menu items section is dynamic and can change based on your preferences and installed plugins. +* *Main menu items*: These items are the static menu items that form the core navigation structure of sidebar. These menu items remain consistent and are predefined. .Procedure @@ -16,19 +15,19 @@ The sidebar menu in {product} consists of two main parts: ---- dynamicPlugins: frontend: - : # <1> - menuItems: # <2> - : # <3> - icon: # home | group | category | extension | school | __ <4> - title: My Plugin Page # <5> - priority: 10 # <6> - parent: favorites # <7> + : <1> + menuItems: <2> + : <3> + icon: # home | group | category | extension | school | __ <4> + title: My Plugin Page <5> + priority: 10 <6> + parent: favorites <7> ---- <1> `__`: Specifies the name of the package that is the same as `scalprum.name` key in the `package.json` of the plugin. <2> `menuItems`: (Optional) Allows you to configure plugin menu items in the main sidebar navigation. <3> `__`: Represents a unique name in the main sidebar navigation. It can denote either a standalone menu item or a parent menu item. If this attribute represents a plugin menu item, the name of the attribute must match with the corresponding path in `dynamicRoutes`. For example, if `dynamicRoutes` defines `path: /my-plugin`, then `menu_item_name` must be defined as `my-plugin`. -<4> `icon`: (Optional) Specifies the icon for the menu item. You can use default icons or extend the icon set with dynamic plugins. {product-short} also provides additional icons in its internal library, such as: -<5> `title`: (Optional) Specifies the title of the menu item. It can be removed if the title is already specified in the `dynamicRoutes` configuration under `menuItem.text`. +<4> `icon`: (Optional) Specifies the icon for the menu item. You can use default icons or extend the icon set with dynamic plugins. {product-short} also provides additional icons in its internal library. +<5> `title`: (Optional) Specifies the title of the menu item. Omit it when the title is already specified in the `dynamicRoutes` configuration under `menuItem.text`. <6> `priority`: (Optional) Sets the order in which menu items appear in the sidebar. The default priority is 0, which places the item at the bottom of the list. A higher priority value places the item higher in the sidebar. You can define this attribute for each section. <7> `parent`: (Optional) Specifies the parent menu item under which the current item is nested. If this attribute is used, the parent menu item must be defined elsewhere in the `menuItems` configuration of any enabled plugin. You can define this attribute for each section. @@ -38,15 +37,15 @@ dynamicPlugins: ---- dynamicPlugins: frontend: - default.main-menu-items: # <1> + default.main-menu-items: <1> menuItems: - default.: # <2> - parent: my_menu_group # <3> - priority: 10 # <4> - default.: # <4> - icon: my_menu_group_icon # <5> - title: my_menu_group_title # <6> - priority: 100 # <7> + default.: <2> + parent: my_menu_group <3> + priority: 10 <4> + default.: <4> + icon: my_menu_group_icon <5> + title: my_menu_group_title <6> + priority: 100 <7> ---- <1> `default.main-menu-items`: Specifies the key for configuring static main menu items. The `default.` prefix identifies an item as a main menu item. You can add the `default.` prefix to both individual menu items or parent menu group configuration, such as `default.` in the previous example. <2> `default.__`: Specifies the key of the menu item configuration. `default.` prefix is required for a main menu item key. @@ -55,7 +54,7 @@ dynamicPlugins: <5> `icon`: Required for parent menu items It defines the icon for the menu group. <6> `title`: Required for parent menu items. It defines the icon for the menu group. <7> `priority`: (Optional) Specifies the order of the parent menu item in the sidebar. - ++ [NOTE] ==== The default priority of main menu items determines their order in the sidebar. You can customize the order of the static main menu items by adjusting their priority values. Ensure that the priority and title of each item is clear to facilitate easy reordering. From 105ff74e29b4836a938986cea77d5b1243d1563a Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Thu, 6 Mar 2025 17:53:04 +0530 Subject: [PATCH 05/25] Minor changes --- .../proc-customize-rhdh-sidebar-menuitems.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc index 9e6ca6006b..6ba7f2eda5 100644 --- a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc @@ -26,7 +26,7 @@ dynamicPlugins: <1> `__`: Specifies the name of the package that is the same as `scalprum.name` key in the `package.json` of the plugin. <2> `menuItems`: (Optional) Allows you to configure plugin menu items in the main sidebar navigation. <3> `__`: Represents a unique name in the main sidebar navigation. It can denote either a standalone menu item or a parent menu item. If this attribute represents a plugin menu item, the name of the attribute must match with the corresponding path in `dynamicRoutes`. For example, if `dynamicRoutes` defines `path: /my-plugin`, then `menu_item_name` must be defined as `my-plugin`. -<4> `icon`: (Optional) Specifies the icon for the menu item. You can use default icons or extend the icon set with dynamic plugins. {product-short} also provides additional icons in its internal library. +<4> `icon`: (Optional) Specifies the icon for the menu item. You can use default icons, such as: `home`, `group`, `category`, `extension`, and `school`. You can also use an SVG or HTML image icon, such as: `icon: ... or icon: https://img.icons8.com/ios-glyphs/20/FFFFFF/shop.png` <5> `title`: (Optional) Specifies the title of the menu item. Omit it when the title is already specified in the `dynamicRoutes` configuration under `menuItem.text`. <6> `priority`: (Optional) Sets the order in which menu items appear in the sidebar. The default priority is 0, which places the item at the bottom of the list. A higher priority value places the item higher in the sidebar. You can define this attribute for each section. <7> `parent`: (Optional) Specifies the parent menu item under which the current item is nested. If this attribute is used, the parent menu item must be defined elsewhere in the `menuItems` configuration of any enabled plugin. You can define this attribute for each section. From c94fb32b01101a9eeb03a3ff0de7d8d561bfaa10 Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Thu, 6 Mar 2025 19:44:30 +0530 Subject: [PATCH 06/25] Lindey's and Fabrice's comments incorporated --- ...proc-customize-rhdh-sidebar-menuitems.adoc | 55 +++++++++---------- ...g-the-layout-of-the-product-home-page.adoc | 2 +- 2 files changed, 28 insertions(+), 29 deletions(-) diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc index 6ba7f2eda5..ca7580b1d0 100644 --- a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc @@ -1,58 +1,57 @@ [id='proc-customize-rhdh-sidebar-menuitems_{context}'] = Customizing the sidebar menu items for your {product-short} instance -The sidebar menu in {product} consists of two main parts: +The sidebar menu in {product} consists of two main parts that you can configure: -* *Dynamic plugin menu items*: These items are displayed beneath the main menu and can be customized based on the plugins installed. The main menu items section is dynamic and can change based on your preferences and installed plugins. - -* *Main menu items*: These items are the static menu items that form the core navigation structure of sidebar. These menu items remain consistent and are predefined. +* *Dynamic plugin menu items*: Your preferences and your active plugins define dynamically one part of the sidebar menu. +* *Main menu items*: The core navigation structure of sidebar is static. .Procedure -. To configure a Dynamic plugin menu item, add the following content to your `{my-app-config-file}` file: +. To configure *Dynamic plugin menu item*, add the following content to your `{my-app-config-file}` file: + [source,yaml] ---- dynamicPlugins: frontend: - : <1> - menuItems: <2> - : <3> - icon: # home | group | category | extension | school | __ <4> - title: My Plugin Page <5> - priority: 10 <6> - parent: favorites <7> + : # <1> + menuItems: # <2> + : # <3> + icon: # home | group | category | extension | school | __ # <4> + title: __ # <5> + priority: 10 # <6> + parent: favorites # <7> ---- -<1> `__`: Specifies the name of the package that is the same as `scalprum.name` key in the `package.json` of the plugin. -<2> `menuItems`: (Optional) Allows you to configure plugin menu items in the main sidebar navigation. -<3> `__`: Represents a unique name in the main sidebar navigation. It can denote either a standalone menu item or a parent menu item. If this attribute represents a plugin menu item, the name of the attribute must match with the corresponding path in `dynamicRoutes`. For example, if `dynamicRoutes` defines `path: /my-plugin`, then `menu_item_name` must be defined as `my-plugin`. -<4> `icon`: (Optional) Specifies the icon for the menu item. You can use default icons, such as: `home`, `group`, `category`, `extension`, and `school`. You can also use an SVG or HTML image icon, such as: `icon: ... or icon: https://img.icons8.com/ios-glyphs/20/FFFFFF/shop.png` +<1> `__`: Specifies the name of the package. This name is the same as the `scalprum.name` key in the plugin `package.json`. +<2> `menuItems`: (Optional) Use to configure plugin menu items in the main sidebar navigation. +<3> `__`: Specifies a unique name in the main sidebar navigation for either a standalone menu item or a parent menu item. If this field specifies a plugin menu item, the name of the menu item must match the name using in the corresponding path in `dynamicRoutes`. For example, if `dynamicRoutes` defines `path: /my-plugin`, then `menu_item_name` must be defined as `my-plugin`. +<4> `icon`: (Optional) Specifies the icon for the menu item. You can use default icons, such as: `home`, `group`, `category`, `extension`, and `school`. You can also use an SVG or HTML image icon, such as: `icon: ...` or `icon: https://img.icons8.com/ios-glyphs/20/FFFFFF/shop.png`. <5> `title`: (Optional) Specifies the title of the menu item. Omit it when the title is already specified in the `dynamicRoutes` configuration under `menuItem.text`. -<6> `priority`: (Optional) Sets the order in which menu items appear in the sidebar. The default priority is 0, which places the item at the bottom of the list. A higher priority value places the item higher in the sidebar. You can define this attribute for each section. -<7> `parent`: (Optional) Specifies the parent menu item under which the current item is nested. If this attribute is used, the parent menu item must be defined elsewhere in the `menuItems` configuration of any enabled plugin. You can define this attribute for each section. +<6> `priority`: (Optional) Sets the order in which menu items appear in the sidebar. The default priority is 0, which places the item at the bottom of the list. A higher priority value places the item higher in the sidebar. You can define this field for each section. +<7> `parent`: (Optional) Specifies the parent menu item under which the current item is nested. If this field is used, the parent menu item must be defined elsewhere in the `menuItems` configuration of any enabled plugin. You can define this field for each section. -. To add Main menu item, add the `default.` prefix to its key in your `{my-app-config-file}` file: +. To add *Main menu item* to the dynamic plugins configuration, add the `default.` prefix to its key in your `{my-app-config-file}` file: + [source,yaml] ---- dynamicPlugins: frontend: - default.main-menu-items: <1> + default.main-menu-items: # <1> menuItems: - default.: <2> - parent: my_menu_group <3> + default.__: # <2> + parent: __ # <3> priority: 10 <4> - default.: <4> - icon: my_menu_group_icon <5> - title: my_menu_group_title <6> - priority: 100 <7> + default.__: # <4> + icon: __ # <5> + title: __ # <6> + priority: 100 # <7> ---- <1> `default.main-menu-items`: Specifies the key for configuring static main menu items. The `default.` prefix identifies an item as a main menu item. You can add the `default.` prefix to both individual menu items or parent menu group configuration, such as `default.` in the previous example. <2> `default.__`: Specifies the key of the menu item configuration. `default.` prefix is required for a main menu item key. <3> `parent`: (Optional) Specifies the parent menu item for this item. <4> `priority`: (Optional) Specifies the order of this menu item within its menu level. -<5> `icon`: Required for parent menu items It defines the icon for the menu group. -<6> `title`: Required for parent menu items. It defines the icon for the menu group. +<5> `icon`: Specifies the icon for the menu group. Required for parent menu items. +<6> `title`: Specifies the title for the menu group. Required for parent menu items. <7> `priority`: (Optional) Specifies the order of the parent menu item in the sidebar. + [NOTE] diff --git a/modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc b/modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc index 3087308038..c0e8598d29 100644 --- a/modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc +++ b/modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc @@ -73,7 +73,7 @@ dynamicPlugins: ---- However, you can see a second card below this card by default. -. Show the cards in three columns by defining the `x` parameter as follows: +. Show the cards in three columns by defining the `x` parameter as shown in the following example: [source,yaml] ---- From f4aea6c38246742e3660082e1cd8fceeaa711e19 Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Fri, 7 Mar 2025 11:10:11 +0530 Subject: [PATCH 07/25] Minor changes and rebase --- .../proc-customize-rhdh-sidebar-menuitems.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc index ca7580b1d0..92c2a7da5d 100644 --- a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc @@ -30,7 +30,7 @@ dynamicPlugins: <6> `priority`: (Optional) Sets the order in which menu items appear in the sidebar. The default priority is 0, which places the item at the bottom of the list. A higher priority value places the item higher in the sidebar. You can define this field for each section. <7> `parent`: (Optional) Specifies the parent menu item under which the current item is nested. If this field is used, the parent menu item must be defined elsewhere in the `menuItems` configuration of any enabled plugin. You can define this field for each section. -. To add *Main menu item* to the dynamic plugins configuration, add the `default.` prefix to its key in your `{my-app-config-file}` file: +. To add *Main menu item* to the dynamic plugins configuration file, add the `default.` prefix to its key in your `{my-app-config-file}` file: + [source,yaml] ---- @@ -47,7 +47,7 @@ dynamicPlugins: priority: 100 # <7> ---- <1> `default.main-menu-items`: Specifies the key for configuring static main menu items. The `default.` prefix identifies an item as a main menu item. You can add the `default.` prefix to both individual menu items or parent menu group configuration, such as `default.` in the previous example. -<2> `default.__`: Specifies the key of the menu item configuration. `default.` prefix is required for a main menu item key. +<2> `default.__`: Specifies the key of the menu item configuration. The `default.` prefix is required for a main menu item key. <3> `parent`: (Optional) Specifies the parent menu item for this item. <4> `priority`: (Optional) Specifies the order of this menu item within its menu level. <5> `icon`: Specifies the icon for the menu group. Required for parent menu items. From bdec7bee9a9c5d56af39b0a7ce4eeb0949eea383 Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Fri, 7 Mar 2025 15:49:39 +0530 Subject: [PATCH 08/25] Fabrice's comments --- ...proc-customize-rhdh-sidebar-menuitems.adoc | 62 +++++++++---------- 1 file changed, 28 insertions(+), 34 deletions(-) diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc index 92c2a7da5d..ca0cd73e34 100644 --- a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc @@ -3,58 +3,52 @@ The sidebar menu in {product} consists of two main parts that you can configure: -* *Dynamic plugin menu items*: Your preferences and your active plugins define dynamically one part of the sidebar menu. -* *Main menu items*: The core navigation structure of sidebar is static. +* Dynamic plugin menu items:: Your preferences and your active plugins define dynamically one part of the sidebar menu. +* Main menu items:: The core navigation structure of sidebar is static. .Procedure -. To configure *Dynamic plugin menu item*, add the following content to your `{my-app-config-file}` file: +. To configure a dynamic plugin menu item, add a `menuItems` section for your __ plugin to your `{my-app-config-file}` file: + [source,yaml] ---- dynamicPlugins: frontend: - : # <1> - menuItems: # <2> - : # <3> - icon: # home | group | category | extension | school | __ # <4> - title: __ # <5> - priority: 10 # <6> - parent: favorites # <7> + : # <1> + menuItems: + : # <2> + icon: # home | group | category | extension | school | __ # <3> + title: __ # <4> + priority: 10 # <5> + parent: favorites # <6> ---- -<1> `__`: Specifies the name of the package. This name is the same as the `scalprum.name` key in the plugin `package.json`. -<2> `menuItems`: (Optional) Use to configure plugin menu items in the main sidebar navigation. -<3> `__`: Specifies a unique name in the main sidebar navigation for either a standalone menu item or a parent menu item. If this field specifies a plugin menu item, the name of the menu item must match the name using in the corresponding path in `dynamicRoutes`. For example, if `dynamicRoutes` defines `path: /my-plugin`, then `menu_item_name` must be defined as `my-plugin`. -<4> `icon`: (Optional) Specifies the icon for the menu item. You can use default icons, such as: `home`, `group`, `category`, `extension`, and `school`. You can also use an SVG or HTML image icon, such as: `icon: ...` or `icon: https://img.icons8.com/ios-glyphs/20/FFFFFF/shop.png`. -<5> `title`: (Optional) Specifies the title of the menu item. Omit it when the title is already specified in the `dynamicRoutes` configuration under `menuItem.text`. -<6> `priority`: (Optional) Sets the order in which menu items appear in the sidebar. The default priority is 0, which places the item at the bottom of the list. A higher priority value places the item higher in the sidebar. You can define this field for each section. -<7> `parent`: (Optional) Specifies the parent menu item under which the current item is nested. If this field is used, the parent menu item must be defined elsewhere in the `menuItems` configuration of any enabled plugin. You can define this field for each section. +<1> `__`: Enter the plugin name. This name is the same as the `scalprum.name` key in the `package.json` file. +<2> `__`: Enter a unique name in the main sidebar navigation for either a standalone menu item or a parent menu item. If this field specifies a plugin menu item, the name of the menu item must match the name using in the corresponding path in `dynamicRoutes`. For example, if `dynamicRoutes` defines `path: /my-plugin`, then `menu_item_name` must be defined as `my-plugin`. +<3> `icon`: (Optional) Enter the icon name. You can use default icons, such as: `home`, `group`, `category`, `extension`, and `school`. You can also use an SVG or HTML image icon, such as: `icon: ...` or `icon: https://img.icons8.com/ios-glyphs/20/FFFFFF/shop.png`. +<4> `title`: (Optional) Enter the menu item title. Omit it when the title is already specified in the `dynamicRoutes` configuration under `menuItem.text`. +<5> `priority`: (Optional) Sets the order in which menu items appear in the sidebar. The default priority is 0, which places the item at the bottom of the list. A higher priority value places the item higher in the sidebar. You can define this field for each section. +<6> `parent`: (Optional) Enter the parent menu item under which the current item is nested. If this field is used, the parent menu item must be defined elsewhere in the `menuItems` configuration of any enabled plugin. You can define this field for each section. -. To add *Main menu item* to the dynamic plugins configuration file, add the `default.` prefix to its key in your `{my-app-config-file}` file: +. To add a main menu item, add a section to the `default.main-menu-items` > `menuItems` section in your `{my-app-config-file}` file. Use the `default.` prefix to identify the key as a main menu item. + [source,yaml] ---- dynamicPlugins: frontend: - default.main-menu-items: # <1> + default.main-menu-items: menuItems: - default.__: # <2> - parent: __ # <3> - priority: 10 <4> + default.__: # <1> + parent: __ # <2> + priority: 10 # <3> default.__: # <4> icon: __ # <5> title: __ # <6> priority: 100 # <7> ---- -<1> `default.main-menu-items`: Specifies the key for configuring static main menu items. The `default.` prefix identifies an item as a main menu item. You can add the `default.` prefix to both individual menu items or parent menu group configuration, such as `default.` in the previous example. -<2> `default.__`: Specifies the key of the menu item configuration. The `default.` prefix is required for a main menu item key. -<3> `parent`: (Optional) Specifies the parent menu item for this item. -<4> `priority`: (Optional) Specifies the order of this menu item within its menu level. -<5> `icon`: Specifies the icon for the menu group. Required for parent menu items. -<6> `title`: Specifies the title for the menu group. Required for parent menu items. -<7> `priority`: (Optional) Specifies the order of the parent menu item in the sidebar. -+ -[NOTE] -==== -The default priority of main menu items determines their order in the sidebar. You can customize the order of the static main menu items by adjusting their priority values. Ensure that the priority and title of each item is clear to facilitate easy reordering. -==== \ No newline at end of file +<1> `default.__`: Enter the menu item name. Add the `default.` prefix to identify a main menu item. +<2> `parent`: (Optional) Enter the parent menu item for this item. +<3> `priority`: (Optional) Enter the order of this menu item within its menu level. +<4> `default.__`: Enter the menu group parent item name to configure static main menu items. +<5> `icon`: Enter the menu group icon. Required for parent menu items. +<6> `title`: Enter the menu group title. Required for parent menu items. +<7> `priority`: (Optional) Enter the order of the parent menu item in the sidebar. \ No newline at end of file From d13241913eee0d81c05b6d008ff42eb084b8f9c4 Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Fri, 7 Mar 2025 17:59:04 +0530 Subject: [PATCH 09/25] Minor comment --- .../proc-customize-rhdh-sidebar-menuitems.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc index ca0cd73e34..f35537288c 100644 --- a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc @@ -3,8 +3,8 @@ The sidebar menu in {product} consists of two main parts that you can configure: -* Dynamic plugin menu items:: Your preferences and your active plugins define dynamically one part of the sidebar menu. -* Main menu items:: The core navigation structure of sidebar is static. +Dynamic plugin menu items:: Your preferences and your active plugins define dynamically one part of the sidebar menu. +Main menu items:: The core navigation structure of sidebar is static. .Procedure From d3461c140b79d3101200bb3bb8934b0c9c1d7923 Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Mon, 10 Mar 2025 10:21:41 +0530 Subject: [PATCH 10/25] Minor changes --- .../proc-customize-rhdh-sidebar-menuitems.adoc | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc index f35537288c..de32692afa 100644 --- a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc @@ -24,7 +24,10 @@ dynamicPlugins: ---- <1> `__`: Enter the plugin name. This name is the same as the `scalprum.name` key in the `package.json` file. <2> `__`: Enter a unique name in the main sidebar navigation for either a standalone menu item or a parent menu item. If this field specifies a plugin menu item, the name of the menu item must match the name using in the corresponding path in `dynamicRoutes`. For example, if `dynamicRoutes` defines `path: /my-plugin`, then `menu_item_name` must be defined as `my-plugin`. -<3> `icon`: (Optional) Enter the icon name. You can use default icons, such as: `home`, `group`, `category`, `extension`, and `school`. You can also use an SVG or HTML image icon, such as: `icon: ...` or `icon: https://img.icons8.com/ios-glyphs/20/FFFFFF/shop.png`. +<3> `icon`: (Optional) Enter the icon name. You can use the following icons: + * Default icons, such as `home`, `group`, `category`, `extension`, and `school` + * An SVG icon, such as: `icon: ...` + * An HTML image, such as: `icon: https://img.icons8.com/ios-glyphs/20/FFFFFF/shop.png` <4> `title`: (Optional) Enter the menu item title. Omit it when the title is already specified in the `dynamicRoutes` configuration under `menuItem.text`. <5> `priority`: (Optional) Sets the order in which menu items appear in the sidebar. The default priority is 0, which places the item at the bottom of the list. A higher priority value places the item higher in the sidebar. You can define this field for each section. <6> `parent`: (Optional) Enter the parent menu item under which the current item is nested. If this field is used, the parent menu item must be defined elsewhere in the `menuItems` configuration of any enabled plugin. You can define this field for each section. From aa2eb8a798e78b90e1f5655c056d97718984fa5a Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Wed, 12 Mar 2025 13:21:55 +0530 Subject: [PATCH 11/25] Added Jai's and Divyanshi's updates --- .../proc-customize-rhdh-sidebar-menuitems.adoc | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc index de32692afa..04827728f9 100644 --- a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc @@ -28,7 +28,8 @@ dynamicPlugins: * Default icons, such as `home`, `group`, `category`, `extension`, and `school` * An SVG icon, such as: `icon: ...` * An HTML image, such as: `icon: https://img.icons8.com/ios-glyphs/20/FFFFFF/shop.png` -<4> `title`: (Optional) Enter the menu item title. Omit it when the title is already specified in the `dynamicRoutes` configuration under `menuItem.text`. +<4> `title`: (Optional) Enter the menu item title. Omit it when the title is already specified in the `dynamicRoutes` configuration under `menuItem.text`. To hide the title from the sidebar, set the title as an (`" "`) empty string. +// Update <6> for release 1.6 as this option (currently a workaround) would be added as a functionality. RHIDP-6333. <5> `priority`: (Optional) Sets the order in which menu items appear in the sidebar. The default priority is 0, which places the item at the bottom of the list. A higher priority value places the item higher in the sidebar. You can define this field for each section. <6> `parent`: (Optional) Enter the parent menu item under which the current item is nested. If this field is used, the parent menu item must be defined elsewhere in the `menuItems` configuration of any enabled plugin. You can define this field for each section. @@ -53,5 +54,6 @@ dynamicPlugins: <3> `priority`: (Optional) Enter the order of this menu item within its menu level. <4> `default.__`: Enter the menu group parent item name to configure static main menu items. <5> `icon`: Enter the menu group icon. Required for parent menu items. -<6> `title`: Enter the menu group title. Required for parent menu items. +<6> `title`: Enter the menu group title. Required for parent menu items. To hide the title from the sidebar, set the title as an (`" "`) empty string. +// Update <6> for release 1.6 as this option (currently a workaround) would be added as a functionality. RHIDP-6333. <7> `priority`: (Optional) Enter the order of the parent menu item in the sidebar. \ No newline at end of file From 986fe57f239c6fe8c221f7f9016332223ce1fe1b Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Wed, 12 Mar 2025 13:23:33 +0530 Subject: [PATCH 12/25] Minor changes --- .../proc-customize-rhdh-sidebar-menuitems.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc index 04827728f9..a1febdfccd 100644 --- a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc @@ -45,7 +45,7 @@ dynamicPlugins: parent: __ # <2> priority: 10 # <3> default.__: # <4> - icon: __ # <5> + icon: # home | group | category | extension | school | __ # <5> title: __ # <6> priority: 100 # <7> ---- From eeb627cf3ab3fb453471de827409a7bcee7269af Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Thu, 13 Mar 2025 10:43:31 +0530 Subject: [PATCH 13/25] Yi Cai's comments --- ...proc-customize-rhdh-sidebar-menuitems.adoc | 20 ++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc index a1febdfccd..143d1983b7 100644 --- a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc @@ -29,12 +29,12 @@ dynamicPlugins: * An SVG icon, such as: `icon: ...` * An HTML image, such as: `icon: https://img.icons8.com/ios-glyphs/20/FFFFFF/shop.png` <4> `title`: (Optional) Enter the menu item title. Omit it when the title is already specified in the `dynamicRoutes` configuration under `menuItem.text`. To hide the title from the sidebar, set the title as an (`" "`) empty string. -// Update <6> for release 1.6 as this option (currently a workaround) would be added as a functionality. RHIDP-6333. +// Update <4> for release 1.6 as this option (currently a workaround) would be added as a functionality. RHIDP-6333. <5> `priority`: (Optional) Sets the order in which menu items appear in the sidebar. The default priority is 0, which places the item at the bottom of the list. A higher priority value places the item higher in the sidebar. You can define this field for each section. <6> `parent`: (Optional) Enter the parent menu item under which the current item is nested. If this field is used, the parent menu item must be defined elsewhere in the `menuItems` configuration of any enabled plugin. You can define this field for each section. -. To add a main menu item, add a section to the `default.main-menu-items` > `menuItems` section in your `{my-app-config-file}` file. Use the `default.` prefix to identify the key as a main menu item. -+ +. To modify a main menu item or add a custom menu item, add a section to the `default.main-menu-items` > `menuItems` section in your `{my-app-config-file}` file. Use the `default.` prefix to identify the key as a main menu item. ++ [source,yaml] ---- dynamicPlugins: @@ -46,14 +46,16 @@ dynamicPlugins: priority: 10 # <3> default.__: # <4> icon: # home | group | category | extension | school | __ # <5> - title: __ # <6> - priority: 100 # <7> + title: __ # <6> + to: __ # <7> + priority: 100 # <8> ---- -<1> `default.__`: Enter the menu item name. Add the `default.` prefix to identify a main menu item. -<2> `parent`: (Optional) Enter the parent menu item for this item. +<1> `default.__`: Enter the menu item name for which you want to override the default value. Add the `default.` prefix to identify a main menu item. +<2> `parent`: (Optional) Enter the parent menu item for this item. Required if is specified as the child of any menu items. <3> `priority`: (Optional) Enter the order of this menu item within its menu level. <4> `default.__`: Enter the menu group parent item name to configure static main menu items. <5> `icon`: Enter the menu group icon. Required for parent menu items. <6> `title`: Enter the menu group title. Required for parent menu items. To hide the title from the sidebar, set the title as an (`" "`) empty string. -// Update <6> for release 1.6 as this option (currently a workaround) would be added as a functionality. RHIDP-6333. -<7> `priority`: (Optional) Enter the order of the parent menu item in the sidebar. \ No newline at end of file +// Update <6> for release 1.6 as this option (currently a workaround) would be added as a functionality. RHIDP-6333. +<7> `to`: (Optional) Enter the path that the menu item navigates to. If not set, it defaults to the home page. +<8> `priority`: (Optional) Enter the order of the parent menu item in the sidebar. \ No newline at end of file From dca51cd805abddb378da96ee422b7d91b3edd06f Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Thu, 13 Mar 2025 16:59:48 +0530 Subject: [PATCH 14/25] Minor changes --- ...proc-customize-rhdh-sidebar-menuitems.adoc | 113 +++++++++++++++--- 1 file changed, 94 insertions(+), 19 deletions(-) diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc index 143d1983b7..41b21707d1 100644 --- a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc @@ -17,7 +17,7 @@ dynamicPlugins: : # <1> menuItems: : # <2> - icon: # home | group | category | extension | school | __ # <3> + icon: # home | group | category | extension | school | __ # <3> title: __ # <4> priority: 10 # <5> parent: favorites # <6> @@ -33,6 +33,38 @@ dynamicPlugins: <5> `priority`: (Optional) Sets the order in which menu items appear in the sidebar. The default priority is 0, which places the item at the bottom of the list. A higher priority value places the item higher in the sidebar. You can define this field for each section. <6> `parent`: (Optional) Enter the parent menu item under which the current item is nested. If this field is used, the parent menu item must be defined elsewhere in the `menuItems` configuration of any enabled plugin. You can define this field for each section. ++ +.Example `menuItems` configuration +[source,yaml,subs="+attributes"] +---- +dynamicPlugins: + frontend: + : + dynamicRoutes: + - path: /my-plugin + module: CustomModule + importName: FooPluginPage + menuItem: + icon: fooIcon + text: Foo Plugin Page + menuItems: + my-plugin: # <1> + priority: 10 # <2> + parent: favorites # <3> + favorites: # <4> + icon: favorite # <5> + title: Favorites # <6> + priority: 100 # <7> +---- + <1> `my-plugin`: Matches `path` in `dynamicRoutes` + <2> `priority`: Controls order of plugins under the parent menu item. + <3> `parent`: Nests this plugin under the `favorites` parent menu item. + <4> `favourites`: Configuration for the parent menu item. + <5> `icon`: Displays the `favorite` icon from the {product-very-short} system icons. + <6> `title`: Displays the title name for the parent menu item. + <7> `priority`: Order of the `favourites` menu item in the sidebar. + + . To modify a main menu item or add a custom menu item, add a section to the `default.main-menu-items` > `menuItems` section in your `{my-app-config-file}` file. Use the `default.` prefix to identify the key as a main menu item. + [source,yaml] @@ -41,21 +73,64 @@ dynamicPlugins: frontend: default.main-menu-items: menuItems: - default.__: # <1> - parent: __ # <2> - priority: 10 # <3> - default.__: # <4> - icon: # home | group | category | extension | school | __ # <5> - title: __ # <6> - to: __ # <7> - priority: 100 # <8> ----- -<1> `default.__`: Enter the menu item name for which you want to override the default value. Add the `default.` prefix to identify a main menu item. -<2> `parent`: (Optional) Enter the parent menu item for this item. Required if is specified as the child of any menu items. -<3> `priority`: (Optional) Enter the order of this menu item within its menu level. -<4> `default.__`: Enter the menu group parent item name to configure static main menu items. -<5> `icon`: Enter the menu group icon. Required for parent menu items. -<6> `title`: Enter the menu group title. Required for parent menu items. To hide the title from the sidebar, set the title as an (`" "`) empty string. -// Update <6> for release 1.6 as this option (currently a workaround) would be added as a functionality. RHIDP-6333. -<7> `to`: (Optional) Enter the path that the menu item navigates to. If not set, it defaults to the home page. -<8> `priority`: (Optional) Enter the order of the parent menu item in the sidebar. \ No newline at end of file + default.__: # <1> + icon: # home | group | category | extension | school | __ # <2> + title: __ # <3> + priority: 10 # <4> + default.__: # <5> + parent: __ # <6> + icon: # home | group | category | extension | school | __ # <7> + title: __ # <8> + to: __ # <9> + priority: 100 # <10> +---- + <1> `default.__`: Enter the menu group parent item name to configure static main menu items. + <2> `icon`: Enter the menu icon. Required for parent menu items. + <3> `title`: Enter the menu group title. Required for parent menu items. To hide the title from the sidebar, set the title as an (`" "`) empty string. + <4> `priority`: (Optional) Enter the order of this menu item within its menu level. + <5> `default.__`: Enter the menu item name for which you want to override the default value. Add the `default.` prefix to identify a main menu item. + <6> `parent`: (Optional) Enter the parent menu item for this item. Required if is specified as the child of any menu items. + <7> `icon`: (Optional) Enter the menu icon. + <8> `title`: Enter the menu group title. To hide the title from the sidebar, set the title as an (`" "`) empty string. +// Update <8> for release 1.6 as this option (currently a workaround) would be added as a functionality. RHIDP-6333. + <9> `to`: (Optional) Enter the path that the menu item navigates to. If not set, it defaults to the home page. + <10> `priority`: (Optional) Enter the order of this menu item within its menu level. + ++ +.Example `mainItems` configuration + +[source,yaml] +---- +default.main-menu-items: + menuItems: + default.catalog: + icon: school + title: Catalog124 + priority: 5 + default.learning-path: + title: '' + default.list: + title: Home + icon: bookmarks + default.home2: + parent: default.list + title: home2 + icon: bookmarks + priority: 105 + default.home1: + parent: default.list + title: home1 + icon: bookmarks + priority: 205 + default.home: # <1> + parent: default.home2 # <2> + default.list2: + title: References # <3> + icon: bookmarks # <4> + to: /create # <5> +---- + <1> `default.home`: Specifies the main item name. + <2> `parent`: Nests this plugin under the `favorites` parent menu item. + <3> `title`: Specifies the name of `default.list2` + <4> `icon`: Displays the `bookmarks` icon. + <5> `to`: Redirects `default.list2` to the `/create` page. \ No newline at end of file From de289e4dbde51616d892ca1c2e44edf85eb91509 Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Thu, 13 Mar 2025 18:51:48 +0530 Subject: [PATCH 15/25] Incorporated Jai's comments --- ...proc-customize-rhdh-sidebar-menuitems.adoc | 52 ++++++++----------- 1 file changed, 22 insertions(+), 30 deletions(-) diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc index 41b21707d1..1ee0326bb0 100644 --- a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc @@ -24,7 +24,7 @@ dynamicPlugins: ---- <1> `__`: Enter the plugin name. This name is the same as the `scalprum.name` key in the `package.json` file. <2> `__`: Enter a unique name in the main sidebar navigation for either a standalone menu item or a parent menu item. If this field specifies a plugin menu item, the name of the menu item must match the name using in the corresponding path in `dynamicRoutes`. For example, if `dynamicRoutes` defines `path: /my-plugin`, then `menu_item_name` must be defined as `my-plugin`. -<3> `icon`: (Optional) Enter the icon name. You can use the following icons: +<3> `icon`: (Optional) Enter the icon name if you do not want to use the default icon. You can use the following icons: * Default icons, such as `home`, `group`, `category`, `extension`, and `school` * An SVG icon, such as: `icon: ...` * An HTML image, such as: `icon: https://img.icons8.com/ios-glyphs/20/FFFFFF/shop.png` @@ -90,10 +90,10 @@ dynamicPlugins: <4> `priority`: (Optional) Enter the order of this menu item within its menu level. <5> `default.__`: Enter the menu item name for which you want to override the default value. Add the `default.` prefix to identify a main menu item. <6> `parent`: (Optional) Enter the parent menu item for this item. Required if is specified as the child of any menu items. - <7> `icon`: (Optional) Enter the menu icon. + <7> `icon`: (Optional) Enter the menu icon if you do not want to use the default icon. <8> `title`: Enter the menu group title. To hide the title from the sidebar, set the title as an (`" "`) empty string. // Update <8> for release 1.6 as this option (currently a workaround) would be added as a functionality. RHIDP-6333. - <9> `to`: (Optional) Enter the path that the menu item navigates to. If not set, it defaults to the home page. + <9> `to`: (Optional) Enter the path that the menu item navigates to. If it is not set, it defaults to the home page. <10> `priority`: (Optional) Enter the order of this menu item within its menu level. + @@ -104,33 +104,25 @@ dynamicPlugins: default.main-menu-items: menuItems: default.catalog: - icon: school - title: Catalog124 + icon: category # <1> + title: My Catalog priority: 5 - default.learning-path: - title: '' - default.list: - title: Home + default.learning-path: + title: '' # <2> to hide the learning path from default sidebar + default.parentlist: # <3> + title: Overview icon: bookmarks - default.home2: - parent: default.list - title: home2 - icon: bookmarks - priority: 105 - default.home1: - parent: default.list - title: home1 - icon: bookmarks - priority: 205 - default.home: # <1> - parent: default.home2 # <2> - default.list2: - title: References # <3> - icon: bookmarks # <4> - to: /create # <5> + default.home: + parent: default.parentlist # <4> + default.references: + title: References # <5> + icon: school # <6> + to: /references # <7> ---- - <1> `default.home`: Specifies the main item name. - <2> `parent`: Nests this plugin under the `favorites` parent menu item. - <3> `title`: Specifies the name of `default.list2` - <4> `icon`: Displays the `bookmarks` icon. - <5> `to`: Redirects `default.list2` to the `/create` page. \ No newline at end of file + <1> `icon`: Specify if you want to change the icon default menu item for the catalog. + <2> `title`: Specify an empty string `" "` to hide the learning path from the default sidebar. + <3> `default.parentlist`: Introduces the parent menu item. + <4> `parent`: Nests home menu under the `default.parentlist` parent menu item. + <5> `title`: Specifies a name for `default.references` + <6> `icon`: Displays the `school` icon. + <7> `to`: Redirects `default.references` to the `/references` page. \ No newline at end of file From 9976792b882b39286f1e94701b16862639bc8a26 Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Mon, 17 Mar 2025 16:46:36 +0530 Subject: [PATCH 16/25] Yi Cai's comments --- ...proc-customize-rhdh-sidebar-menuitems.adoc | 49 ++++++++++++++++++- 1 file changed, 47 insertions(+), 2 deletions(-) diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc index 1ee0326bb0..6107e6f257 100644 --- a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc @@ -6,6 +6,51 @@ The sidebar menu in {product} consists of two main parts that you can configure: Dynamic plugin menu items:: Your preferences and your active plugins define dynamically one part of the sidebar menu. Main menu items:: The core navigation structure of sidebar is static. +.Default static menu item configuration ++ +[source,yaml] +---- +export const DefaultMainMenuItems = { + menuItems: { + 'default.home': { + title: 'Home', + icon: 'home', + to: '/', + priority: 100, + }, + 'default.my-group': { + title: 'My Group', + icon: 'group', + priority: 90, + }, + 'default.catalog': { + title: 'Catalog', + icon: 'category', + to: 'catalog', + priority: 80, + }, + 'default.apis': { + title: 'APIs', + icon: 'extension', + to: 'api-docs', + priority: 70, + }, + 'default.learning-path': { + title: 'Learning Paths', + icon: 'school', + to: 'learning-paths', + priority: 60, + }, + 'default.create': { + title: 'Create...', + icon: 'add', + to: 'create', + priority: 50, + }, + }, +}; +---- + .Procedure . To configure a dynamic plugin menu item, add a `menuItems` section for your __ plugin to your `{my-app-config-file}` file: @@ -86,12 +131,12 @@ dynamicPlugins: ---- <1> `default.__`: Enter the menu group parent item name to configure static main menu items. <2> `icon`: Enter the menu icon. Required for parent menu items. - <3> `title`: Enter the menu group title. Required for parent menu items. To hide the title from the sidebar, set the title as an (`" "`) empty string. + <3> `title`: Enter the menu group title. Required for parent menu items. <4> `priority`: (Optional) Enter the order of this menu item within its menu level. <5> `default.__`: Enter the menu item name for which you want to override the default value. Add the `default.` prefix to identify a main menu item. <6> `parent`: (Optional) Enter the parent menu item for this item. Required if is specified as the child of any menu items. <7> `icon`: (Optional) Enter the menu icon if you do not want to use the default icon. - <8> `title`: Enter the menu group title. To hide the title from the sidebar, set the title as an (`" "`) empty string. + <8> `title`: (Optional) Enter the menu group title. Only required for adding a new custom main menu item. To hide a default main menu item title from the sidebar, set the title as an (`" "`) empty string. // Update <8> for release 1.6 as this option (currently a workaround) would be added as a functionality. RHIDP-6333. <9> `to`: (Optional) Enter the path that the menu item navigates to. If it is not set, it defaults to the home page. <10> `priority`: (Optional) Enter the order of this menu item within its menu level. From cb1923d44e01a448341d1d67346e6b60642ef0ae Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Mon, 17 Mar 2025 17:20:22 +0530 Subject: [PATCH 17/25] Removed ascii mistake --- .../proc-customize-rhdh-sidebar-menuitems.adoc | 1 - 1 file changed, 1 deletion(-) diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc index 6107e6f257..06c3f56620 100644 --- a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc @@ -7,7 +7,6 @@ Dynamic plugin menu items:: Your preferences and your active plugins define dyna Main menu items:: The core navigation structure of sidebar is static. .Default static menu item configuration -+ [source,yaml] ---- export const DefaultMainMenuItems = { From 9058dc9ca58cbfe4ba463782ea52a34df757cd9d Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Mon, 17 Mar 2025 17:32:14 +0530 Subject: [PATCH 18/25] comments --- .../proc-customize-rhdh-sidebar-menuitems.adoc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc index 06c3f56620..e7a37f37c0 100644 --- a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc @@ -7,7 +7,7 @@ Dynamic plugin menu items:: Your preferences and your active plugins define dyna Main menu items:: The core navigation structure of sidebar is static. .Default static menu item configuration -[source,yaml] +[source] ---- export const DefaultMainMenuItems = { menuItems: { @@ -142,7 +142,6 @@ dynamicPlugins: + .Example `mainItems` configuration - [source,yaml] ---- default.main-menu-items: From bad0c1e30a45341d2134beee6043a57c62a2f739 Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Mon, 17 Mar 2025 18:10:19 +0530 Subject: [PATCH 19/25] Fabrice's comments --- ...proc-customize-rhdh-sidebar-menuitems.adoc | 121 +++++++++--------- 1 file changed, 57 insertions(+), 64 deletions(-) diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc index e7a37f37c0..c4d9695fde 100644 --- a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc @@ -7,47 +7,40 @@ Dynamic plugin menu items:: Your preferences and your active plugins define dyna Main menu items:: The core navigation structure of sidebar is static. .Default static menu item configuration -[source] +[source,yaml] ---- -export const DefaultMainMenuItems = { - menuItems: { - 'default.home': { - title: 'Home', - icon: 'home', - to: '/', - priority: 100, - }, - 'default.my-group': { - title: 'My Group', - icon: 'group', - priority: 90, - }, - 'default.catalog': { - title: 'Catalog', - icon: 'category', - to: 'catalog', - priority: 80, - }, - 'default.apis': { - title: 'APIs', - icon: 'extension', - to: 'api-docs', - priority: 70, - }, - 'default.learning-path': { - title: 'Learning Paths', - icon: 'school', - to: 'learning-paths', - priority: 60, - }, - 'default.create': { - title: 'Create...', - icon: 'add', - to: 'create', - priority: 50, - }, - }, -}; +dynamicsPlugins: + frontend: + __: + menuItems: + default.home: + title: Home + icon: home + priority: 100 + default.my-group: + title: My Group + icon: group + priority: 90 + default.catalog: + title: Catalog + icon: category + to: catalog + priority: 80 + default.apis: + title: APIs + icon: extension + to: api-docs + priority: 70 + default.learning-path: + title: Learning Paths + icon: school, + to: learning-paths + priority: 60 + default.create: + title: Create + icon: add + to: create + priority: 50 ---- .Procedure @@ -100,13 +93,13 @@ dynamicPlugins: title: Favorites # <6> priority: 100 # <7> ---- - <1> `my-plugin`: Matches `path` in `dynamicRoutes` - <2> `priority`: Controls order of plugins under the parent menu item. - <3> `parent`: Nests this plugin under the `favorites` parent menu item. - <4> `favourites`: Configuration for the parent menu item. - <5> `icon`: Displays the `favorite` icon from the {product-very-short} system icons. - <6> `title`: Displays the title name for the parent menu item. - <7> `priority`: Order of the `favourites` menu item in the sidebar. +<1> `my-plugin`: Matches `path` in `dynamicRoutes` +<2> `priority`: Controls order of plugins under the parent menu item. +<3> `parent`: Nests this plugin under the `favorites` parent menu item. +<4> `favourites`: Configuration for the parent menu item. +<5> `icon`: Displays the `favorite` icon from the {product-very-short} system icons. +<6> `title`: Displays the title name for the parent menu item. +<7> `priority`: Order of the `favourites` menu item in the sidebar. . To modify a main menu item or add a custom menu item, add a section to the `default.main-menu-items` > `menuItems` section in your `{my-app-config-file}` file. Use the `default.` prefix to identify the key as a main menu item. @@ -128,17 +121,17 @@ dynamicPlugins: to: __ # <9> priority: 100 # <10> ---- - <1> `default.__`: Enter the menu group parent item name to configure static main menu items. - <2> `icon`: Enter the menu icon. Required for parent menu items. - <3> `title`: Enter the menu group title. Required for parent menu items. - <4> `priority`: (Optional) Enter the order of this menu item within its menu level. - <5> `default.__`: Enter the menu item name for which you want to override the default value. Add the `default.` prefix to identify a main menu item. - <6> `parent`: (Optional) Enter the parent menu item for this item. Required if is specified as the child of any menu items. - <7> `icon`: (Optional) Enter the menu icon if you do not want to use the default icon. - <8> `title`: (Optional) Enter the menu group title. Only required for adding a new custom main menu item. To hide a default main menu item title from the sidebar, set the title as an (`" "`) empty string. +<1> `default.__`: Enter the menu group parent item name to configure static main menu items. +<2> `icon`: Enter the menu icon. Required for parent menu items. +<3> `title`: Enter the menu group title. Required for parent menu items. +<4> `priority`: (Optional) Enter the order of this menu item within its menu level. +<5> `default.__`: Enter the menu item name for which you want to override the default value. Add the `default.` prefix to identify a main menu item. +<6> `parent`: (Optional) Enter the parent menu item for this item. Required if is specified as the child of any menu items. +<7> `icon`: (Optional) Enter the menu icon if you do not want to use the default icon. +<8> `title`: (Optional) Enter the menu group title. Only required for adding a new custom main menu item. To hide a default main menu item title from the sidebar, set the title as an (`" "`) empty string. // Update <8> for release 1.6 as this option (currently a workaround) would be added as a functionality. RHIDP-6333. - <9> `to`: (Optional) Enter the path that the menu item navigates to. If it is not set, it defaults to the home page. - <10> `priority`: (Optional) Enter the order of this menu item within its menu level. +<9> `to`: (Optional) Enter the path that the menu item navigates to. If it is not set, it defaults to the home page. +<10> `priority`: (Optional) Enter the order of this menu item within its menu level. + .Example `mainItems` configuration @@ -162,10 +155,10 @@ default.main-menu-items: icon: school # <6> to: /references # <7> ---- - <1> `icon`: Specify if you want to change the icon default menu item for the catalog. - <2> `title`: Specify an empty string `" "` to hide the learning path from the default sidebar. - <3> `default.parentlist`: Introduces the parent menu item. - <4> `parent`: Nests home menu under the `default.parentlist` parent menu item. - <5> `title`: Specifies a name for `default.references` - <6> `icon`: Displays the `school` icon. - <7> `to`: Redirects `default.references` to the `/references` page. \ No newline at end of file +<1> `icon`: Specify if you want to change the icon default menu item for the catalog. +<2> `title`: Specify an empty string `" "` to hide the learning path from the default sidebar. +<3> `default.parentlist`: Introduces the parent menu item. +<4> `parent`: Nests home menu under the `default.parentlist` parent menu item. +<5> `title`: Specifies a name for `default.references` +<6> `icon`: Displays the `school` icon. +<7> `to`: Redirects `default.references` to the `/references` page. \ No newline at end of file From 7ec49632c1d8cf2f77d54d3073a8d7307b5fe6ff Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Mon, 17 Mar 2025 19:28:43 +0530 Subject: [PATCH 20/25] Minor changes --- .../proc-customize-rhdh-sidebar-menuitems.adoc | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc index c4d9695fde..42ea06a71d 100644 --- a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc @@ -11,7 +11,8 @@ Main menu items:: The core navigation structure of sidebar is static. ---- dynamicsPlugins: frontend: - __: + __: + menuItems: default.home: title: Home @@ -51,7 +52,7 @@ dynamicsPlugins: ---- dynamicPlugins: frontend: - : # <1> + __: # <1> menuItems: : # <2> icon: # home | group | category | extension | school | __ # <3> @@ -76,7 +77,7 @@ dynamicPlugins: ---- dynamicPlugins: frontend: - : + __: dynamicRoutes: - path: /my-plugin module: CustomModule From 604a4b0c62bd93c61c306fe66ca69de87acdc5b7 Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Mon, 17 Mar 2025 19:52:15 +0530 Subject: [PATCH 21/25] Minor changes --- .../proc-customize-rhdh-sidebar-menuitems.adoc | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc index 42ea06a71d..b285c611ed 100644 --- a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc @@ -11,8 +11,7 @@ Main menu items:: The core navigation structure of sidebar is static. ---- dynamicsPlugins: frontend: - __: - + default.main-menu-items: menuItems: default.home: title: Home @@ -97,7 +96,7 @@ dynamicPlugins: <1> `my-plugin`: Matches `path` in `dynamicRoutes` <2> `priority`: Controls order of plugins under the parent menu item. <3> `parent`: Nests this plugin under the `favorites` parent menu item. -<4> `favourites`: Configuration for the parent menu item. +<4> `favorites`: Configuration for the parent menu item. <5> `icon`: Displays the `favorite` icon from the {product-very-short} system icons. <6> `title`: Displays the title name for the parent menu item. <7> `priority`: Order of the `favourites` menu item in the sidebar. @@ -122,7 +121,7 @@ dynamicPlugins: to: __ # <9> priority: 100 # <10> ---- -<1> `default.__`: Enter the menu group parent item name to configure static main menu items. +<1> `default.__`: (Optional) Enter the menu group parent item name to configure static main menu items. If no `default.__` has a `parent` value set, this field is not needed. <2> `icon`: Enter the menu icon. Required for parent menu items. <3> `title`: Enter the menu group title. Required for parent menu items. <4> `priority`: (Optional) Enter the order of this menu item within its menu level. From c87e42ececf0aa509dc807647eb4344e73f8e166 Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Tue, 18 Mar 2025 09:52:20 +0530 Subject: [PATCH 22/25] Incorporated Lindsey's comments --- .../proc-customize-rhdh-sidebar-menuitems.adoc | 13 +++++++------ ...efining-the-layout-of-the-product-home-page.adoc | 2 +- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc index b285c611ed..dc3b0969b4 100644 --- a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc @@ -45,7 +45,7 @@ dynamicsPlugins: .Procedure -. To configure a dynamic plugin menu item, add a `menuItems` section for your __ plugin to your `{my-app-config-file}` file: +. To configure a dynamic plugin menu item, update the `menuItems` section of your __ plugin to your `{my-app-config-file}` file. For example: + [source,yaml] ---- @@ -61,8 +61,9 @@ dynamicPlugins: ---- <1> `__`: Enter the plugin name. This name is the same as the `scalprum.name` key in the `package.json` file. <2> `__`: Enter a unique name in the main sidebar navigation for either a standalone menu item or a parent menu item. If this field specifies a plugin menu item, the name of the menu item must match the name using in the corresponding path in `dynamicRoutes`. For example, if `dynamicRoutes` defines `path: /my-plugin`, then `menu_item_name` must be defined as `my-plugin`. -<3> `icon`: (Optional) Enter the icon name if you do not want to use the default icon. You can use the following icons: - * Default icons, such as `home`, `group`, `category`, `extension`, and `school` +<3> `icon`: (Optional) Enter the icon name. You can use any of the following icons: + * Default icons, such as `home`, `group`, `category`, `extension`, and `school`. To use default icons, set the icon as an (`" "`) empty string. + * A custom icon, where __ specifies the name of your custom icon * An SVG icon, such as: `icon: ...` * An HTML image, such as: `icon: https://img.icons8.com/ios-glyphs/20/FFFFFF/shop.png` <4> `title`: (Optional) Enter the menu item title. Omit it when the title is already specified in the `dynamicRoutes` configuration under `menuItem.text`. To hide the title from the sidebar, set the title as an (`" "`) empty string. @@ -127,7 +128,7 @@ dynamicPlugins: <4> `priority`: (Optional) Enter the order of this menu item within its menu level. <5> `default.__`: Enter the menu item name for which you want to override the default value. Add the `default.` prefix to identify a main menu item. <6> `parent`: (Optional) Enter the parent menu item for this item. Required if is specified as the child of any menu items. -<7> `icon`: (Optional) Enter the menu icon if you do not want to use the default icon. +<7> `icon`: (Optional) Enter the menu icon. To use the default icon, set the icon as an (`" "`) empty string. <8> `title`: (Optional) Enter the menu group title. Only required for adding a new custom main menu item. To hide a default main menu item title from the sidebar, set the title as an (`" "`) empty string. // Update <8> for release 1.6 as this option (currently a workaround) would be added as a functionality. RHIDP-6333. <9> `to`: (Optional) Enter the path that the menu item navigates to. If it is not set, it defaults to the home page. @@ -155,8 +156,8 @@ default.main-menu-items: icon: school # <6> to: /references # <7> ---- -<1> `icon`: Specify if you want to change the icon default menu item for the catalog. -<2> `title`: Specify an empty string `" "` to hide the learning path from the default sidebar. +<1> `icon`: Specifies if you want to change the icon default menu item for the catalog. +<2> `title`: Specifies an empty string `" "` to hide the learning path from the default sidebar. <3> `default.parentlist`: Introduces the parent menu item. <4> `parent`: Nests home menu under the `default.parentlist` parent menu item. <5> `title`: Specifies a name for `default.references` diff --git a/modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc b/modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc index c0e8598d29..e3e6f70af4 100644 --- a/modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc +++ b/modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc @@ -73,7 +73,7 @@ dynamicPlugins: ---- However, you can see a second card below this card by default. -. Show the cards in three columns by defining the `x` parameter as shown in the following example: +* Show the cards in three columns by defining the `x` parameter as shown in the following example: [source,yaml] ---- From 03b618907e3b76a8bf99e458ffa4be840cb25a09 Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Thu, 20 Mar 2025 10:29:55 +0530 Subject: [PATCH 23/25] Minor changes --- .../proc-customize-rhdh-sidebar-menuitems.adoc | 2 +- .../proc-defining-the-layout-of-the-product-home-page.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc index dc3b0969b4..9a594bfa55 100644 --- a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc @@ -94,7 +94,7 @@ dynamicPlugins: title: Favorites # <6> priority: 100 # <7> ---- -<1> `my-plugin`: Matches `path` in `dynamicRoutes` +<1> `my-plugin`: Matches the value of the `path` field in `dynamicRoutes`. <2> `priority`: Controls order of plugins under the parent menu item. <3> `parent`: Nests this plugin under the `favorites` parent menu item. <4> `favorites`: Configuration for the parent menu item. diff --git a/modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc b/modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc index e3e6f70af4..ec0f1f3282 100644 --- a/modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc +++ b/modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc @@ -12,7 +12,7 @@ ** position (x and y) .Procedure -. Configure your {product-short} `app-config.yaml` configuration file by choosing one of the following options: +. Configure the layout of the cards on the home page by entering one of the following configurations in your {product-short} `{my-app-config-file}` file. * Use the full space on smaller windows and half of the space on larger windows as shown in the following example: [source,yaml] From d18b7dd47d8debac0a9ab0b049856b90048e5ffe Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Thu, 20 Mar 2025 17:03:10 +0530 Subject: [PATCH 24/25] Fixing typo --- .../proc-customize-rhdh-sidebar-menuitems.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc index 9a594bfa55..e43be19268 100644 --- a/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc +++ b/modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc @@ -9,7 +9,7 @@ Main menu items:: The core navigation structure of sidebar is static. .Default static menu item configuration [source,yaml] ---- -dynamicsPlugins: +dynamicPlugins: frontend: default.main-menu-items: menuItems: From a802e56d497172c44e7688d3841b1d8a9aa6fa76 Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Thu, 20 Mar 2025 17:33:58 +0530 Subject: [PATCH 25/25] Home page info --- .../proc-defining-the-layout-of-the-product-home-page.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc b/modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc index ec0f1f3282..e62c2919a7 100644 --- a/modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc +++ b/modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc @@ -5,6 +5,8 @@ [id="defining-the-layout-of-the-product-home-page_{context}"] = Defining the layout of the {product} Home page +The Home page uses a 12-column grid to position your cards. You can use the optimal parameters to define the layout of your {product-short} Home page. + .Prerequisites * Include the following optimal parameters in each of your breakpoints: ** width (w)