Skip to content

Commit 65dc09e

Browse files
jmagakGitHub Actions
jmagak
and
GitHub Actions
authored
RHIDP-8313: Global Header - Enable Quicklinks and Starred Items by default (#1284)
* Enable Quicklinks and Starred Items by default in the global header * Enable Quicklinks and Starred Items by default in the global header * Enable Quicklinks and Starred Items by default in the global header --------- Co-authored-by: GitHub Actions <[email protected]>
1 parent f86260e commit 65dc09e

File tree

4 files changed

+145
-2
lines changed

4 files changed

+145
-2
lines changed

‎.vscode/settings.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"cSpell.words": [
3-
"preconfigured"
3+
"preconfigured",
4+
"quicklinks"
45
]
56
}

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,8 @@ By default, the {product-short} global header includes the following components:
1616
include::modules/configuring-the-global-header/proc-customize-rhdh-global-header.adoc[leveloffset=+1]
1717

1818

19-
include::modules/configuring-the-global-header/proc-mount-points.adoc[leveloffset=+1]
19+
include::modules/configuring-the-global-header/proc-mount-points.adoc[leveloffset=+1]
20+
21+
include::modules/configuring-the-global-header/con-quicklinks-and-starred-items-in-global-header.adoc[leveloffset=+1]
22+
23+
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

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
[id="quicklinks-and-starred-items-in-global-header_{context}"]
2+
= Quicklinks and Starred Items in the global header
3+
4+
The *Quicklinks* matrix and *Starred Items* drop-down list are enabled by default and appear in the global header without requiring additional configuration.
5+
6+
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 list contains entities and pages that the user has starred.
7+
8+
The default configuration includes the following components:
9+
10+
*StarredDropdown*: Displays the *Starred Items* menu in the global header by default, as shown in the following configuration:
11+
12+
[source,yaml]
13+
----
14+
# Group: Global Header
15+
- package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-global-header
16+
- mountPoint: global.header/component
17+
importName: StarredDropdown
18+
config:
19+
priority: 85
20+
----
21+
22+
*ApplicationLauncherDropdown*: Provides the *Quicklinks* matrix (application launcher) by default, as shown in the following configuration:
23+
24+
[source,yaml]
25+
----
26+
# Group: Global Header
27+
- package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-global-header
28+
- mountPoint: global.header/component
29+
importName: ApplicationLauncherDropdown
30+
config:
31+
priority: 82
32+
----
33+
34+
*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:
35+
36+
[source,yaml]
37+
----
38+
- mountPoint: global.header/application-launcher
39+
importName: MenuItemLink
40+
config:
41+
section: Documentation
42+
priority: 150
43+
props:
44+
title: Developer Hub
45+
icon: developerHub
46+
link: https://docs.redhat.com/en/documentation/red_hat_developer_hub
47+
48+
- mountPoint: global.header/application-launcher
49+
importName: MenuItemLink
50+
config:
51+
section: Developer Tools
52+
priority: 100
53+
props:
54+
title: RHDH Local
55+
icon: developerHub
56+
link: https://github.com/redhat-developer/rhdh-local
57+
----
58+
59+
[NOTE]
60+
====
61+
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.
62+
====
63+
64+
65+
66+

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

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
[id="enabling-quicklinks-starred-items-upgrade_{context}"]
2+
= Enabling Quicklinks and Starred Items after an upgrade
3+
4+
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.
5+
6+
.Prerequisites
7+
8+
. You have access to your {product} configuration files.
9+
. You have administrative permissions to modify ConfigMaps (if using the Operator).
10+
11+
.Procedure
12+
13+
. Locate your `dynamic-plugin` configuration.
14+
15+
* Operator deployment: The configuration is stored in a ConfigMap referenced by your Backstage custom resource (CR).
16+
* Helm deployment: The configuration is in your `values.yaml` file or separate configuration files.
17+
18+
. 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` is set to `false`.
19+
20+
. Verify that you enabled the global header plugin.
21+
Confirm that you listed the `red-hat-developer-hub-backstage-plugin-global-header` plugin under `plugins:` with `disabled: false` (or without a `disabled` property):
22+
+
23+
[source,yaml]
24+
----
25+
- package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-global-header
26+
disabled: false
27+
----
28+
29+
. Add the required components. Under the `mountPoints` section of the plugin, add the components as shown in the following example:
30+
+
31+
[source,yaml]
32+
----
33+
mountPoints:
34+
- mountPoint: application/header
35+
importName: GlobalHeader
36+
config:
37+
position: above-sidebar
38+
- mountPoint: global.header/component
39+
importName: StarredDropdown
40+
config:
41+
priority: 85
42+
- mountPoint: global.header/component
43+
importName: ApplicationLauncherDropdown
44+
config:
45+
priority: 82
46+
- mountPoint: global.header/component
47+
importName: MenuItemLink
48+
config:
49+
section: Documentation
50+
priority: 150
51+
props:
52+
title: Developer Hub
53+
icon: developerHub
54+
link: https://docs.redhat.com/en/documentation/red_hat_developer_hub
55+
- mountPoint: global.header/application-launcher
56+
importName: MenuItemLink
57+
config:
58+
section: Developer Tools
59+
priority: 100
60+
props:
61+
title: RHDH Local
62+
icon: developerHub
63+
link: https://github.com/redhat-developer/rhdh-local
64+
----
65+
66+
. Apply the configuration.
67+
68+
* Operator deployment: Update the ConfigMap and allow the Operator to reconcile the changes.
69+
* Helm deployment: Apply your updated configuration using `helm upgrade`.
70+
71+
. Verify the features are enabled.
72+
After the {product} instance restarts, confirm that the star icon and *Quicklinks* matrix appear in the global header.

0 commit comments

Comments
 (0)