Skip to content

Commit a452899

Browse files
author
GitHub Actions
committed
Update the configure global header
Update the configure global header Update the configure global header Update the configure global header
1 parent 1f1ccc2 commit a452899

File tree

2 files changed

+45
-0
lines changed

2 files changed

+45
-0
lines changed
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
[id="customizing-your-product-global-header_{context}"]
2+
= Customizing your {product} global header
3+
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.
5+
6+
.Prerequisites
7+
* You have configured your {product-custom-resource-type} instance.
8+
* You have configured the support URL in the `app-config.yaml` file.
9+
* You have installed the notification plugin.
10+
11+
.Procedure
12+
13+
* To disable the global header, disable the right plugin. For example:
14+
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
20+
----
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"]
29+
----
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+
----

titles/customizing/master.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ include::artifacts/attributes.adoc[]
1111
include::modules/customizing/proc-customizing-your-product-title.adoc[leveloffset=+1]
1212

1313

14+
include::modules/customizing/proc-customizing-your-product-global-header.adoc[leveloffset=+1]
15+
16+
1417
include::modules/customizing/proc-customizing-your-product-base-url.adoc[leveloffset=+1]
1518

1619

0 commit comments

Comments
 (0)