Enable Quicklinks and Starred Items by default in the global header

Author: GitHub Actions

.vscode/settings.json

@@ -1,5 +1,6 @@
 {
     "cSpell.words": [
-        "preconfigured"
+        "preconfigured",
+        "quicklinks"
     ]
 }

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

@@ -16,4 +16,8 @@ By default, the {product-short} global header includes the following components:
 include::modules/configuring-the-global-header/proc-customize-rhdh-global-header.adoc[leveloffset=+1]
 
 
-include::modules/configuring-the-global-header/proc-mount-points.adoc[leveloffset=+1]
+include::modules/configuring-the-global-header/proc-mount-points.adoc[leveloffset=+1]
+
+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]

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

@@ -0,0 +1,66 @@
+[id="quicklinks-and-starred-items-in-global-header_{context}"]
+= Enable *Quicklinks* and *Starred Items* by default 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, 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:
+
+[source,yaml]
+----
+# Group: Global Header
+- package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-global-header
+  - mountPoint: global.header/component
+    importName: StarredDropdown
+    config:
+      priority: 85
+----
+
+*ApplicationLauncherDropdown*: Provides the `Quicklinks` matrix (application launcher), as shown in the following configuration:
+
+[source,yaml]
+----
+# Group: Global Header
+- package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-global-header
+  - mountPoint: global.header/component
+    importName: ApplicationLauncherDropdown
+    config:
+      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:
+
+[source,yaml]
+----
+- mountPoint: global.header/application-launcher
+  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
+----
+
+[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.
+====
+
+
+
+

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

@@ -0,0 +1,35 @@
+[id="enabling-quicklinks-starred-items-upgrade_{context}"]
+= Enabling Quicklinks and Starred Items after an upgrade
+
+You can enable the *Quicklinks* and *Starred Items* features after upgrading from {product} `1.6` or earlier. By default, these features are not automatically enabled in upgraded environments.
+
+.Procedure
+
+. Locate your dynamic-plugin configuration. If you are using the Operator, this configuration is stored in a ConfigMap referenced by your Backstage custom resource (CR).
+
+. 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.
+
+. Add the *StarredDropdown*, *ApplicationLauncherDropdown*, and *MenuItemLink* 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:
+        priority: 80
+----
+
+. Apply the configuration and restart the pod. After updating the ConfigMap file, restart your {product} instance so that the global header displays the star icon, *Quicklinks* matrix, and *menu item* link.