Skip to content

Commit f77c390

Browse files
author
GitHub Actions
committed
Update the configure global header
1 parent 79e110b commit f77c390

File tree

1 file changed

+30
-11
lines changed

1 file changed

+30
-11
lines changed
Lines changed: 30 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,42 @@
11
[id="customizing-your-product-global-header_{context}"]
22
= Customizing your {product} global header
33

4-
As an administrator, you can add a global header to your {product-custom-resource-type} instance. You can enable the global header by default.
5-
You can do the following:
6-
7-
* Add a logo, search, notifications, users settings, help, and more.
8-
* Customize the order and position of icons and features by placing them on either the left or right side of the header.
4+
As an administrator, you can add a global header to create a consistent and flexible navigation bar across your {product-custom-resource-type} instance. By default, the global header includes a search field, create, support and notification buttons, and a user profile drop-down. You can customize the order and position of icons and features.
95

106
.Prerequisites
117
* You have configured your {product-custom-resource-type} instance.
12-
* You have administrative access and can modify a global header.
8+
* You have configured the support url in the `app-config.yaml` file.
9+
* You have installed the notification plugin.
1310

1411
.Procedure
1512

16-
* Set the enabled property to `true`. For example:
13+
* To disable the global header, disable the right plugin. For example:
1714

18-
[source,yaml]
15+
[source,yaml,subs="+attributes,+quotes"]
16+
----
17+
# Disabling global header
18+
- package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-global-header
19+
disabled: true
1920
----
20-
globalHeader:
21-
enabled: true
21+
22+
.Procedure
23+
24+
* To replace the {product} global header with a custom header of your choice, first disable the default header.
25+
26+
* Install your own header as a dynamic plugin as shown in the following example:
27+
28+
[source,yaml,subs="+attributes,+quotes"]
2229
----
23-
* To disable this feature, update the configuration file by setting the property to `false`.
30+
# Custom header implementation
31+
- package: <npm or oci package-reference>
32+
disabled: false
33+
pluginConfig:
34+
dynamicPlugins:
35+
frontend:
36+
<package_name>:
37+
mountPoints:
38+
- mountPoint: application/header
39+
importName: <Header component name>
40+
config:
41+
position: above-main-content
42+
----

0 commit comments

Comments
 (0)