Enable Quicklinks and Starred Items by default in the global header

Author: GitHub Actions

assemblies/assembly-configuring-the-global-header.adoc

@@ -20,4 +20,4 @@ include::modules/configuring-the-global-header/proc-mount-points.adoc[leveloffse
 
 include::modules/configuring-the-global-header/con-quicklinks-and-starred-items-in-global-header.adoc[leveloffset=+1]
 
-include::modules/configuring-the-global-header/proc-enabling-quicklinks-starred-items-upgrade.adoc[leveloffset=+1]
+include::modules/configuring-the-global-header/proc-enabling-quicklinks-starred-items-after-upgrade.adoc[leveloffset=+1]

modules/configuring-the-global-header/con-quicklinks-and-starred-items-in-global-header.adoc

@@ -1,13 +1,13 @@
 [id="quicklinks-and-starred-items-in-global-header_{context}"]
-= Enable *Quicklinks* and *Starred Items* by default in the global header
+= Quicklinks and Starred Items in the global header
 
-The *Quicklinks* matrix and *Starred Items* drop-down are enabled by default and are visible without any additional configuration when you deploy a new {product} instance.
+The *Quicklinks* matrix and *Starred Items* drop-down are enabled by default and appear in the global header without requiring additional configuration.
 
 The *Quicklinks* matrix, organized by sections (for example, Documentation or Developer Tools), allows users to quickly access internal or external resources. The *Starred Items* drop-down contains entities and pages that the user has starred.
 
 The default configuration includes the following components:
 
-*StarredDropdown*: Ensures that the `Starred Items` menu appears by default, as shown in the following configuration:
+*StarredDropdown*: Displays the *Starred Items* menu in the global header by default, as shown in the following configuration:
 
 [source,yaml]
 ----
@@ -19,7 +19,7 @@ The default configuration includes the following components:
       priority: 85
 ----
 
-*ApplicationLauncherDropdown*: Provides the `Quicklinks` matrix (application launcher), as shown in the following configuration:
+*ApplicationLauncherDropdown*: Provides the *Quicklinks* matrix (application launcher) by default, as shown in the following configuration:
 
 [source,yaml]
 ----
@@ -31,7 +31,7 @@ The default configuration includes the following components:
       priority: 82
 ----
 
-*MenuItemLink entries*: Define a section, title, icon, and link. The default configuration includes links to the {product-short} documentation and an {product-very-short} Local instance, as shown in the following configurations:
+*MenuItemLink entries*: Define sections, titles, icons, and links within the *Quicklinks* matrix. The default configuration includes links to the {product-short} documentation and an {product-very-short} Local, as shown in the following configurations:
 
 [source,yaml]
 ----
@@ -58,7 +58,7 @@ The default configuration includes the following components:
 
 [NOTE]
 ====
-When upgrading from previous versions, the installer does not overwrite your existing `dynamic-plugins.yaml` configuration. If you had not configured *Starred Items* or *Quicklinks* previously, they remain disabled after the upgrade.
+When upgrading from previous versions, the installer does not overwrite your existing `dynamic-plugins.yaml` configuration. If you had not configured *Starred Items* or *Quicklinks* previously, they remain disabled after the upgrade and must be manually enabled.
 ====
 
 

modules/configuring-the-global-header/proc-enabling-quicklinks-starred-items-after-upgrade.adoc

@@ -0,0 +1,72 @@
+[id="enabling-quicklinks-starred-items-upgrade_{context}"]
+= Enabling Quicklinks and Starred Items after an upgrade
+
+If you upgrade from {product} `1.6` or earlier, {product} does not automatically enable the *Quicklinks* and *Starred Items* features. You must manually configure these features to display them in the global header.
+
+.Prerequisites
+
+. You have access to your {product} configuration files.
+. You have administrative permissions to modify ConfigMaps (if using the Operator).
+
+.Procedure
+
+. Locate your dynamic-plugin configuration.
+
+* Operator deployment: The configuration is stored in a ConfigMap referenced by your Backstage custom resource (CR).
+* Helm deployment: The configuration is in your `values.yaml` file or separate configuration files.
+
+. Enable the global-header plugin. Ensure that the `red-hat-developer-hub-backstage-plugin-global-header` entry exists under the `plugins: list` and that `disabled: false` is set.
+
+. Verify that you enabled the global header plugin.
+Confirm that you listed the `red-hat-developer-hub-backstage-plugin-global-header` plugin under `plugins:` with `disabled: false` (or without a `disabled` property):
++
+[source,yaml]
+----
+  - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-global-header
+    disabled: false
+----
+
+. Add the required components. Under the plugin's `mountPoints`, add the components as shown in the following example:
++
+[source,yaml]
+----
+  mountPoints:
+    - mountPoint: application/header
+      importName: GlobalHeader
+      config:
+        position: above-sidebar
+    - mountPoint: global.header/component
+      importName: StarredDropdown
+      config:
+        priority: 85
+    - mountPoint: global.header/component
+      importName: ApplicationLauncherDropdown
+      config:
+        priority: 82
+    - mountPoint: global.header/component
+      importName: MenuItemLink
+      config:
+        section: Documentation
+      priority: 150
+      props:
+          title: Developer Hub
+          icon: developerHub
+          link: https://docs.redhat.com/en/documentation/red_hat_developer_hub
+    - mountPoint: global.header/application-launcher
+    importName: MenuItemLink
+    config:
+      section: Developer Tools
+      priority: 100
+      props:
+          title: RHDH Local
+          icon: developerHub
+          link: https://github.com/redhat-developer/rhdh-local
+----
+
+. Apply the configuration.
+
+* Operator deployment: Update the ConfigMap and allow the Operator to reconcile the changes.
+* Helm deployment: Apply your updated configuration using `helm upgrade`.
+
+. Verify the features are enabled.
+After the {product} instance restarts, confirm that the star icon and *Quicklinks* matrix appear in the global header.