Skip to content

Commit 8285ebe

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

File tree

2 files changed

+68
-0
lines changed

2 files changed

+68
-0
lines changed
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
[id="customizing-your-product-global-header_{context}"]
2+
= Customizing your {product} global header
3+
4+
<<<<<<< HEAD
5+
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.
6+
7+
.Prerequisites
8+
* You have configured your {product-custom-resource-type} instance.
9+
* You have configured the support url in the `app-config.yaml` file.
10+
* You have installed the notification plugin.
11+
12+
.Procedure
13+
14+
* To disable the global header, disable the right plugin. For example:
15+
16+
[source,yaml,subs="+attributes,+quotes"]
17+
----
18+
# Disabling global header
19+
- package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-global-header
20+
disabled: true
21+
----
22+
23+
.Procedure
24+
25+
* To replace the {product} global header with a custom header of your choice, first disable the default header.
26+
27+
* Install your own header as a dynamic plugin as shown in the following example:
28+
29+
[source,yaml,subs="+attributes,+quotes"]
30+
----
31+
# Custom header implementation
32+
- package: <npm or oci package-reference>
33+
disabled: false
34+
pluginConfig:
35+
dynamicPlugins:
36+
frontend:
37+
<package_name>:
38+
mountPoints:
39+
- mountPoint: application/header
40+
importName: <Header component name>
41+
config:
42+
position: above-main-content
43+
----
44+
=======
45+
As an administrator, you can add a global header to your {product-custom-resource-type} instance. You can enable the global header by default.
46+
You can do the following:
47+
48+
* Add a logo, search, notifications, users settings, help, and more.
49+
* Customize the order and position of icons and features by placing them on either the left or right side of the header.
50+
51+
.Prerequisites
52+
* You have configured your {product-custom-resource-type} instance.
53+
* You have administrative access and can modify a global header.
54+
55+
.Procedure
56+
57+
* Set the enabled property to `true`. For example:
58+
59+
[source,yaml]
60+
----
61+
globalHeader:
62+
enabled: true
63+
----
64+
* To disable this feature, update the configuration file by setting the property to `false`.
65+
>>>>>>> 79e110bb2 (Update the configure global header)

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)