Displaying the preferred username and Company Logo

Author: GitHub Actions

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

@@ -16,4 +16,10 @@ By default, the {product-short} global header includes the following components:
 include::modules/configuring-the-global-header/proc-customize-rhdh-global-header.adoc[leveloffset=+1]
 
 
-include::modules/configuring-the-global-header/proc-mount-points.adoc[leveloffset=+1]
+include::modules/configuring-the-global-header/proc-mount-points.adoc[leveloffset=+1]
+
+
+include::modules/configuring-the-global-header/proc-displaying-company-logo-in-the-global-header.adoc[leveloffset=+1]
+
+
+include::modules/configuring-the-global-header/proc-displaying-preferred-username-in-profile-dropdown.adoc[leveloffset=+1]

modules/configuring-the-global-header/proc-displaying-company-logo-in-the-global-header.adoc

@@ -0,0 +1,54 @@
+[id="displaying-company-logo-in-the-global-header.adoc_{context}"]
+= Displaying company logo in the global header
+
+You can configure a company logo in the *Global Header* of the {product} ({product-very-short}) to reflect your company's branding.
+
+The `CompanyLogo` supports strict display constraints to ensure visual consistency:
+
+* Maximum dimensions: 150px wide, 40px high.
+* The logo must retain its original proportions.
+* The component layout remains fixed and cannot be moved from its mount point.
+* Supports the following props:
+** `logo`: Encoded logo image.
+** `to`: The redirect path where the logo is clicked.
+
+.Procedure
+
+To display a custom company logo in the *Global Header*, update the configuration with a mount point for `CompanyLogo`:
+
+.Example: Configuring company logo
+
+[source,yaml,subs="+attributes,+quotes"]
+----
+red-hat-developer-hub.backstage-plugin-global-header:
+      mountPoints:
+        - mountPoint: global.header/component
+          importName: CompanyLogo
+          config:
+            priority: 200  # <1>
+            props:
+            logo:
+            fullLogo:
+              to: '/' # <2>
+#...Rest of the Global Header Configuration
+----
+<1> Specify the position of the company logo in the global header.
+<2> The redirect path. The logo should display the custom image or icon.
+
+To ensure the logo appears in the correct location, configure the Global Header’s `position` value as shown in the example below:
+
+[source,yaml]
+----
+red-hat-developer-hub.backstage-plugin-global-header:
+  mountPoints:
+    - mountPoint: application/header
+      importName: GlobalHeader
+      config:
+        position: above-sidebar
+----
+
+By default, `position` is set to `above-main-content`.
+
+.Verification
+. The logo appears correctly in the Global Header.
+. Click the logo to confirm it redirects to the path you defined in `props.to`.

modules/configuring-the-global-header/proc-displaying-preferred-username-in-profile-dropdown.adoc

@@ -0,0 +1,56 @@
+[id="displaying-preferred-username-in-global-header-profile-dropdown_{context}"]
+= Displaying the preferred username in the profile dropdown
+
+You can display the preferred username in the global header's profile dropdown by configuring `spec.profile.displayName` in the user entity. When not configured, the application falls back to a `metadata.title`. If neither is configured, it defaults to a user-friendly name generated by the `useProfileInfo` hook.
+
+.Procedure
+.Example when you configure `spec.profile.displayName`
+
+[source,yaml,subs="+attributes,+quotes"]
+----
+apiVersion: backstage.io/v1alpha1
+kind: User
+metadata:
+  name: _<my_display_name>_ # <1>
+  title: _<display_name_title>_ # <2>
+spec:
+  profile:
+    displayName: _<my_display_name>_ # <3>
+  memberOf: [janus-authors]
+----
+<1> Required: Specify the unique username (`metadata.name`).
+<2> Optional: Specify the preferred title (`metadata.title`).
+<3> Optional: Specify the preferred display name (`spec.profile.displayName`). This takes the highest priority.
+
+.Example when you do not configure `spec.profile.displayname` but configure `metadata.title`
+
+[source,yaml,subs="+attributes,+quotes"]
+----
+apiVersion: backstage.io/v1alpha1
+kind: User
+metadata:
+  name: _<my_display_name>_ # <1>
+  title: _<display_name_title>_ # <2>
+spec:
+  memberOf: [janus-authors]
+----
+<1> Required: Specify the unique username (`metadata.name`).
+<2> Optional: Specify the preferred title (`metadata.title`).
+
+.Example when you do not configure the `spec.profile.displayname` and the `title`
+
+[source,yaml,subs="+attributes,+quotes"]
+----
+apiVersion: backstage.io/v1alpha1
+kind: User
+metadata:
+  name: _<my_display_name>_ # <1>
+spec:
+  memberOf: [janus-authors]
+----
+<1> Required: Specify the unique username (`metadata.name`).
+
+[NOTE]
+====
+The application falls back to `metadata.name` when you do not register the user entity.
+====