Skip to content

Commit 5409f96

Browse files
author
GitHub Actions
committed
Apply peer suggestions
1 parent ae3c632 commit 5409f96

File tree

3 files changed

+12
-17
lines changed

3 files changed

+12
-17
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
= Configuring the global header in {product}
55

66
As an administrator, you can configure the {product} global header to create a consistent and flexible navigation bar across your {product-short} instance.
7-
By default, the {product} global header includes the following components:
7+
By default, the {product-short} global header includes the following components:
88

99
* *Create* button provides quick access to a variety of templates, enabling users to efficiently set up services, backend and front-end plugins within {product-short}
1010
* *Support* button that can link an internal or external support page
1111
* *Notifications* button displays alerts and updates from plugins and external services
12-
* *Search* input field allows users to find services, components, documentation, and other resources within {product}
13-
* *Plugin extension capabilities* provide a pre-installed and enabled catalog of available plugins in {product}
12+
* *Search* input field allows users to find services, components, documentation, and other resources within {product-short}
13+
* *Plugin extension capabilities* provide a preinstalled and enabled catalog of available plugins in {product-short}
1414
* *User profile* drop-down menu provides access to profile settings, appearance customization, {product-short} metadata, and a logout button
1515
1616
include::modules/configuring-the-global-header/proc-customize-rhdh-global-header.adoc[leveloffset=+1]

modules/configuring-the-global-header/proc-customize-rhdh-global-header.adoc

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ You can use dynamic plugins to extend the global header with additional buttons
66
To extend the functionality of the default global header, include any the following attributes in your global header entry:
77

88
`mountPoint`::
9-
Specifies the location of the header. Use `application/header` to specify it as a global header.
9+
Specifies the location of the header. Use `application/header` to specify it as a global header. You can configure several global headers at different positions by adding entries to the `mountPoints` field.
1010

1111
`importName`::
1212
Specifies the component exported by the global header plugin.
1313
+
14-
Below is a list of available header components that you can configure using the `config` field:
14+
The following header components are possible values for the `config` field in the `dynamic-plugins.default.yaml` file:
1515

1616
- **`SearchComponent`**: Adds a search bar (enabled by default).
1717
- **`Spacer`**: Adds spacing in the header to position buttons at the end. Useful when you disable `SearchComponent`.
@@ -29,11 +29,6 @@ Below is a list of available header components that you can configure using the
2929
`config.position`::
3030
Specifies the position of the header. Supported values are `above-main-content` and `above-sidebar`.
3131

32-
[NOTE]
33-
====
34-
You can configure several global headers at different positions by adding entries to the `mountPoints` field.
35-
====
36-
3732
.Prerequisites
3833
* You have configured the support URL in the `{my-app-config-file}` file.
3934
* You have installed the notifications plugin.
@@ -44,15 +39,15 @@ You can configure several global headers at different positions by adding entrie
4439
+
4540
[source,yaml,subs="+attributes,+quotes"]
4641
----
47-
- package: `_<npm_or_oci_package-reference>_`
42+
- package: _<npm_or_oci_package-reference>_
4843
disabled: false
4944
pluginConfig:
5045
dynamicPlugins:
5146
frontend:
5247
<package_name>:
5348
mountPoints:
5449
- mountPoint: application/header
55-
importName: `_<Header_component_name>_`
50+
importName: _<Header_component_name>_
5651
config:
5752
position: above-main-content
5853
----

modules/configuring-the-global-header/proc-mount-points.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Controls the header position. Use `config.position` to set placement as either `
88

99
global.header/component::
1010
Configures header components. Use `config.priority` to set the order of components, and pass properties (including CSS styles) via `config.props`.
11-
11+
+
1212
.Example adding a *Self-service* button
1313
[source,yaml,subs="attributes,quotes"]
1414
----
@@ -21,7 +21,7 @@ Configures header components. Use `config.priority` to set the order of componen
2121
icon: add
2222
to: create
2323
----
24-
24+
+
2525
.Example adding a spacer element
2626
[source,yaml]
2727
----
@@ -32,7 +32,7 @@ Configures header components. Use `config.priority` to set the order of componen
3232
props:
3333
growFactor: 0
3434
----
35-
35+
+
3636
.Example adding a divider element
3737
[source,yaml]
3838
----
@@ -45,7 +45,7 @@ mountPoints:
4545

4646
global.header/profile::
4747
Configures the profile dropdown list when the `ProfileDropdown` component is enabled.
48-
48+
+
4949
.Example adding a settings link to the profile dropdown
5050
[source,yaml]
5151
----
@@ -61,7 +61,7 @@ Configures the profile dropdown list when the `ProfileDropdown` component is ena
6161

6262
global.header/create::
6363
Configures the create dropdown list when the `CreateDropdown` component is enabled.
64-
64+
+
6565
.Example adding a section for registering a component
6666
[source,yaml]
6767
----

0 commit comments

Comments
 (0)