RHIDP-5409 Consistent titles and subtitles

Signed-off-by: Fabrice Flore-Thébault <ffloreth@redhat.com>
redhat-developer · Jan 7, 2025 · 6f9e867 · 6f9e867
1 parent c712fc1
commit 6f9e867
Show file tree

Hide file tree

Showing 37 changed files with 80 additions and 64 deletions.
diff --git a/titles/about/docinfo.xml b/titles/about/docinfo.xml
@@ -1,11 +1,11 @@
-<title>About {product}</title>
+<title>{title}</title>
 <productname>{product}</productname>
 <productnumber>{product-version}</productnumber>
-<subtitle>Introduction to {product}</subtitle>
+<subtitle>{subtitle}</subtitle>
 <abstract>
-  <para>{product} is a developer platform designed to build developer portals. Use {product} to provide a streamlined development environment with a centralized software catalog to build high-quality software efficiently.</para>
+  <para>{abstract}</para>
 </abstract>
 <authorgroup>
   <orgname>{company-name} Customer Content Services</orgname>
 </authorgroup>
-<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
diff --git a/titles/about/master.adoc b/titles/about/master.adoc
@@ -2,7 +2,7 @@
 include::artifacts/attributes.adoc[]
 :imagesdir: images
 :title: About {product}
-:subtitle: Introduction to {product}
+:subtitle: Building your developer portal with {product} to provide a streamlined development environment with a centralized software catalog to build high-quality software efficiently
 :abstract: {product} is a developer platform designed to build developer portals. Use {product} to provide a streamlined development environment with a centralized software catalog to build high-quality software efficiently.
 
 include::assemblies/assembly-about-rhdh.adoc[]
diff --git a/titles/admin-rhdh/title-admin.adoc b/titles/admin-rhdh/title-admin.adoc
diff --git a/titles/audit-log/master.adoc b/titles/audit-log/master.adoc
@@ -1,10 +1,9 @@
 include::artifacts/attributes.adoc[]
 :context: title-audit-log
 :imagesdir: images
-:title: Audit log
+:title: Audit logs in {product}
 :subtitle: Tracking user activities, system events, and data changes with {product} audit logs
 :abstract: As a {product} administrator, you can track user activities, system events, and data changes with {product-short} audit logs.
-
 = {title}
 
 // Audit logging

diff --git a/titles/authentication/master.adoc b/titles/authentication/master.adoc
@@ -1,7 +1,7 @@
 include::artifacts/attributes.adoc[]
 :context: title-authentication
 :imagesdir: images
-:title: Authentication
+:title: Authentication in {product}
 :subtitle: Configuring authentication to external services in {product}
 :abstract: As a {product} platform engineer, you can manage authentication of other users to meet the specific needs of your organization.
 //[id="{context}"]

diff --git a/titles/authorization/master.adoc b/titles/authorization/master.adoc
@@ -1,7 +1,7 @@
 include::artifacts/attributes.adoc[]
 :context: title-authorization
 :imagesdir: images
-:title: Authorization
+:title: Authorization in {product}
 :subtitle: Configuring authorization by using role based access control (RBAC) in {product}
 :abstract: As a {product} platform engineer, you can manage authorizations of other users by using role based access control (RBAC) to meet the specific needs of your organization.
 //[id="{context}"]

diff --git a/titles/configuring/master.adoc b/titles/configuring/master.adoc
@@ -1,6 +1,6 @@
 include::artifacts/attributes.adoc[]
-:title: Configuring
-:subtitle: Configuring {product}
+:title: Configuring {product}
+:subtitle: Configuring {product} for production to work in your IT ecosystem by adding custom config maps and secrets
 :abstract: Learn how to configure {product} for production to work in your IT ecosystem by adding custom config maps and secrets.
 :context: configuring-and-operating
 [id="{context}"]

diff --git a/titles/customizing/master.adoc b/titles/customizing/master.adoc
@@ -1,7 +1,7 @@
 include::artifacts/attributes.adoc[]
-:title: Customizing
-:subtitle: Customizing {product}
-:abstract: Learn to customize {product}, such as templates, learning paths, tech docs, tech radar, home page, quick access cards, and appearance.
+:title: Customizing {product}
+:subtitle: Customizing {product} features, such as templates, Learning Paths, TechDocs, Tech Radar, home page, quick access cards, and appearance.
+:abstract: Learn to customize {product} features, such as templates, Learning Paths, TechDocs, Tech Radar, home page, quick access cards, and appearance.
 :context: customizing-display
 [id="{context}"]
 = {title}

diff --git a/titles/install-rhdh-air-gapped/docinfo.xml b/titles/install-rhdh-air-gapped/docinfo.xml
@@ -1,10 +1,9 @@
-<title>Installing {product} in an air-gapped environment</title>
+<title>{title}</title>
 <productname>{product}</productname>
 <productnumber>{product-version}</productnumber>
-<subtitle>
-</subtitle>
+<subtitle>{subtitle}</subtitle>
 <abstract>
-    <para>{product} is an enterprise-grade platform for building developer portals. Administrative users can configure roles, permissions, and other settings to enable other authorized users to deploy an air-gapped {product-short} instance on any supported platform using either the Operator or Helm chart.</para>
+    <para>{abstract}</para>
 </abstract>
 <authorgroup>
     <orgname>{company-name} Customer Content Services</orgname>

diff --git a/titles/install-rhdh-air-gapped/master.adoc b/titles/install-rhdh-air-gapped/master.adoc
@@ -1,6 +1,9 @@
 [id="title-install-rhdh-air-grapped"]
 include::artifacts/attributes.adoc[]
-= Installing {product} in an air-gapped environment
+:title: Installing {product} in an air-gapped environment
+:subtitle: Running {product} on {ocp-brand-name} in a networik restricted environment by using either the Operator or Helm chart.
+:abstract: Platform administrators can configure roles, permissions, and other settings to enable other authorized users to deploy an air-gapped {product-short} instance on any supported platform using either the Operator or Helm chart.
+= {title}
 :context: title-install-rhdh-air-grapped
 :imagesdir: images
 

diff --git a/titles/install-rhdh-aks/docinfo.xml b/titles/install-rhdh-aks/docinfo.xml
@@ -1,10 +1,10 @@
-<title>Installing {product} on {aks-brand-name}</title>
+<title>{title}</title>
 <productname>{product}</productname>
 <productnumber>{product-version}</productnumber>
-<subtitle>
+<subtitle>{subtitle}
 </subtitle>
 <abstract>
-    <para>{product} is an enterprise-grade platform for building developer portals. Administrative users can configure roles, permissions, and other settings to enable other authorized users to deploy a {product-short} instance on {aks-brand-name} ({aks-short}) using either the Operator or Helm chart.</para>
+    <para>{abstract}</para>
 </abstract>
 <authorgroup>
     <orgname>{company-name} Customer Content Services</orgname>

diff --git a/titles/install-rhdh-aks/master.adoc b/titles/install-rhdh-aks/master.adoc
@@ -1,6 +1,9 @@
 [id="title-install-rhdh-aks"]
 include::artifacts/attributes.adoc[]
-= Installing {product} on {aks-brand-name}
+:title: Installing {product} on {aks-brand-name}
+:subtitle: Running {product} on {aks-brand-name} ({aks-short}) by using either the Operator or Helm chart.
+:abstract: {product} is an enterprise-grade platform for building developer portals. Administrative users can configure roles, permissions, and other settings to enable other authorized users to deploy a {product-short} instance on {aks-brand-name} ({aks-short}) using either the Operator or Helm chart.
+= {title}
 :context: title-install-rhdh-aks
 :imagesdir: images
 

diff --git a/titles/install-rhdh-eks/docinfo.xml b/titles/install-rhdh-eks/docinfo.xml
@@ -1,13 +1,13 @@
-<title>Installing {product} on {eks-brand-name}</title>
+<title>{title}</title>
 <productname>{product}</productname>
 <productnumber>{product-version}</productnumber>
-<subtitle>
+<subtitle>{subtitle}
 </subtitle>
-<abstract>
-    <para>{product} is an enterprise-grade platform for building developer portals. Administrative users can configure roles, permissions, and other settings to enable other authorized users to deploy a {product-short} instance on {eks-brand-name} ({eks-short}) using either the Operator or Helm chart.</para>
-</abstract>
+<para>{abstract}</para>
+  </abstract>
 <authorgroup>
-    <orgname>{company-name} Customer Content Services</orgname>
+<orgname>{company-name} Customer Content Services</orgname>
 </authorgroup>
 <xi:include href="Common_Content/Legal_Notice.xml"
-    xmlns:xi="http://www.w3.org/2001/XInclude" />
+            xmlns:xi="http://www.w3.org/2001/XInclude"/>
+<abstract>
diff --git a/titles/install-rhdh-eks/master.adoc b/titles/install-rhdh-eks/master.adoc
@@ -1,6 +1,9 @@
 [id="title-install-rhdh-eks"]
 include::artifacts/attributes.adoc[]
-= Installing {product} on {eks-brand-name}
+:title: Installing {product} on {eks-brand-name}
+:subtitle: Running {product} on {eks-brand-name} ({eks-short}) by using either the Operator or Helm chart
+:abstract: Platform administrators can configure roles, permissions, and other settings to enable other authorized users to deploy a {product-short} instance on {eks-brand-name} ({eks-short}) using either the Operator or Helm chart.
+= {title}
 :context: title-install-rhdh-eks
 :imagesdir: images
 

diff --git a/titles/install-rhdh-gke/docinfo.xml b/titles/install-rhdh-gke/docinfo.xml
@@ -1,10 +1,10 @@
 <title>Installing {product} on {gke-brand-name}</title>
 <productname>{product}</productname>
 <productnumber>{product-version}</productnumber>
-<subtitle>
+<subtitle>{subtitle}
 </subtitle>
 <abstract>
-    <para>{product} is an enterprise-grade platform for building developer portals. Administrative users can configure roles, permissions, and other settings to enable other authorized users to deploy a {product-short} instance on {gke-brand-name} ({gke-short}) using either the Operator or Helm chart.</para>
+    <para>{abstract}</para>
 </abstract>
 <authorgroup>
     <orgname>{company-name} Customer Content Services</orgname>

diff --git a/titles/install-rhdh-gke/master.adoc b/titles/install-rhdh-gke/master.adoc
@@ -1,6 +1,9 @@
 [id="title-install-rhdh-gke"]
 include::artifacts/attributes.adoc[]
-= Installing {product} on {gke-brand-name}
+:title: Installing {product} on {gke-brand-name}
+:subtitle: Running {product} on {gke-brand-name} ({gke-short}) by using either the Operator or Helm chart.
+:abstract: Platform administrators can configure roles, permissions, and other settings to enable other authorized users to deploy a {product-short} instance on {gke-brand-name} ({gke-short}) using either the Operator or Helm chart.
+= {title}
 :context: title-install-rhdh-gke
 :imagesdir: images
 

diff --git a/titles/install-rhdh-ocp/docinfo.xml b/titles/install-rhdh-ocp/docinfo.xml
@@ -1,10 +1,10 @@
-<title>Installing {product} on {ocp-short}</title>
+<title>{title}</title>
 <productname>{product}</productname>
 <productnumber>{product-version}</productnumber>
-<subtitle>
+<subtitle>{subtitle}
 </subtitle>
 <abstract>
-    <para>{product} is an enterprise-grade platform for building developer portals. Administrative users can configure roles, permissions, and other settings to enable other authorized users to deploy a {product-short} instance on {ocp-brand-name} using either the Operator or Helm chart.</para>
+    <para>{abstract}</para>
 </abstract>
 <authorgroup>
     <orgname>{company-name} Customer Content Services</orgname>

diff --git a/titles/install-rhdh-ocp/master.adoc b/titles/install-rhdh-ocp/master.adoc
@@ -1,6 +1,9 @@
 [id="title-install-rhdh-ocp"]
 include::artifacts/attributes.adoc[]
-= Installing {product} on {ocp-short}
+:title: Installing {product} on {ocp-short}
+:subtitle: Running {product} on {ocp-brand-name} by using either the Operator or Helm chart.
+:abstract: Platform administrators can configure roles, permissions, and other settings to enable other authorized users to deploy a {product-short} instance on {ocp-brand-name} using either the Operator or Helm chart.
+= {title}
 :context: title-install-rhdh-ocp
 :imagesdir: images
 

diff --git a/titles/install-rhdh-osd-gcp/docinfo.xml b/titles/install-rhdh-osd-gcp/docinfo.xml
@@ -1,10 +1,10 @@
-<title>Installing {product} on {osd-short} on {gcp-brand-name}</title>
+<title>{title}</title>
 <productname>{product}</productname>
 <productnumber>{product-version}</productnumber>
-<subtitle>
+<subtitle>{subtitle}
 </subtitle>
 <abstract>
-    <para>{product} is an enterprise-grade platform for building developer portals. Administrative users can configure roles, permissions, and other settings to enable other authorized users to deploy a {product-short} instance on {osd-brand-name} on {gcp-brand-name} ({gcp-short}) using either the Operator or Helm chart.</para>
+    <para>{abstract}</para>
 </abstract>
 <authorgroup>
     <orgname>{company-name} Customer Content Services</orgname>

diff --git a/titles/install-rhdh-osd-gcp/master.adoc b/titles/install-rhdh-osd-gcp/master.adoc
@@ -1,6 +1,9 @@
 [id="title-install-rhdh-osd-gcp"]
 include::artifacts/attributes.adoc[]
-= Installing {product} on {osd-short} on {gcp-brand-name}
+:title: Installing {product} on {osd-short} on {gcp-brand-name}
+:subtitle: Running {product} on {osd-brand-name} by using either the Operator or Helm chart.
+:abstract: Platform administrators can configure roles, permissions, and other settings to enable other authorized users to deploy a {product-short} instance on {osd-brand-name} on {gcp-brand-name} ({gcp-short}) using either the Operator or Helm chart.
+= {title}
 :context: title-install-rhdh-osd-gcp
 :imagesdir: images
 

diff --git a/titles/installation-rhdh/artifacts b/titles/installation-rhdh/artifacts
diff --git a/titles/installation-rhdh/assemblies b/titles/installation-rhdh/assemblies
diff --git a/titles/installation-rhdh/images b/titles/installation-rhdh/images
diff --git a/titles/installation-rhdh/modules b/titles/installation-rhdh/modules
diff --git a/titles/plugin-rhdh/docinfo.xml b/titles/plugin-rhdh/docinfo.xml
@@ -1,12 +1,12 @@
 <title>Configuring plugins in {product}</title>
 <productname>{product}</productname>
 <productnumber>{product-version}</productnumber>
-<subtitle>
+<subtitle>{subtitle}
 </subtitle>
 <abstract>
     <para>Red Hat Developer Hub is a developer platform for building developer portals. You can add and configure plugins in {product-short} to access various software development tools.</para>
 </abstract>
 <authorgroup>
     <orgname>Red Hat Customer Content Services </orgname>
 </authorgroup>
-<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
diff --git a/titles/plugins-rhdh-about/docinfo.xml b/titles/plugins-rhdh-about/docinfo.xml
@@ -1,7 +1,7 @@
 <title>{title}</title>
 <productname>{product}</productname>
 <productnumber>{product-version}</productnumber>
-<subtitle>
+<subtitle>{subtitle}
 </subtitle>
 <abstract>
     <para>The {product} ({product-very-short}) application offers a unified platform with various plugins. Using the plugin ecosystem within the {product-short} application, you can access your development infrastructure and software development tools.

diff --git a/titles/plugins-rhdh-configure/docinfo.xml b/titles/plugins-rhdh-configure/docinfo.xml
@@ -1,7 +1,7 @@
 <title>{title}</title>
 <productname>{product}</productname>
 <productnumber>{product-version}</productnumber>
-<subtitle>
+<subtitle>{subtitle}
 </subtitle>
 <abstract>
     <para>{abstract}</para>

diff --git a/titles/plugins-rhdh-configure/master.adoc b/titles/plugins-rhdh-configure/master.adoc
@@ -3,7 +3,7 @@ include::artifacts/attributes.adoc[]
 :imagesdir: images
 
 :title: Configuring dynamic plugins
-:subtitle: Configuring dynamic plugins in {product-very-short} as a platform engineer.
+:subtitle: Configuring dynamic plugins in {product} as a platform engineer
 :abstract: As a platform engineer, you can configure dynamic plugins in {product-very-short} to access your development infrastructure or software development tools.
 
 include::assemblies/dynamic-plugins/assembly-configuring-rhdh-plugins.adoc[]
diff --git a/titles/plugins-rhdh-install/docinfo.xml b/titles/plugins-rhdh-install/docinfo.xml
@@ -1,7 +1,7 @@
 <title>{title}</title>
 <productname>{product}</productname>
 <productnumber>{product-version}</productnumber>
-<subtitle>
+<subtitle>{subtitle}
 </subtitle>
 <abstract>
     <para>{abstract}</para>

diff --git a/titles/plugins-rhdh-reference/docinfo.xml b/titles/plugins-rhdh-reference/docinfo.xml
@@ -1,7 +1,7 @@
 <title>{title}</title>
 <productname>{product}</productname>
 <productnumber>{product-version}</productnumber>
-<subtitle>
+<subtitle>{subtitle}
 </subtitle>
 <abstract>
     <para>{abstract}</para>

diff --git a/titles/plugins-rhdh-reference/master.adoc b/titles/plugins-rhdh-reference/master.adoc
@@ -3,7 +3,7 @@ include::artifacts/attributes.adoc[]
 :imagesdir: images
 
 :title: Dynamic plugins reference
-:subtitle: Working with plugins in {product-very-short}
+:subtitle: {product} is preinstalled with a selection of dynamic plugins that you can enable and configure to extend {product-short} functionality
 :abstract: {product} is preinstalled with a selection of dynamic plugins that users can enable and configure to extend {product-very-short} functionality.
 
 include::assemblies/dynamic-plugins/assembly-rhdh-installing-dynamic-plugins.adoc[]
diff --git a/titles/plugins-rhdh-using/docinfo.xml b/titles/plugins-rhdh-using/docinfo.xml
@@ -1,7 +1,7 @@
 <title>{title}</title>
 <productname>{product}</productname>
 <productnumber>{product-version}</productnumber>
-<subtitle>
+<subtitle>{subtitle}
 </subtitle>
 <abstract>
     <para>{abstract}</para>

diff --git a/titles/plugins-rhdh-using/master.adoc b/titles/plugins-rhdh-using/master.adoc
@@ -1,8 +1,8 @@
 include::artifacts/attributes.adoc[]
 :context: title-plugins-rhdh-using
 :imagesdir: images
-:title: Using dynamic plugins
-:subtitle: Using {product-very-short} plugins as an end-user
+:title: Using dynamic plugins in {product}
+:subtitle: Using {product} plugins to access your development infrastructure and software development tools.
 :abstract: The following sections provide information about how you can use {product-very-short} dynamic plugins.
 //[id="{context}"]
 //= {title}

diff --git a/titles/rel-notes-rhdh/docinfo.xml b/titles/rel-notes-rhdh/docinfo.xml
@@ -3,9 +3,9 @@
 <productnumber>{product-version}</productnumber>
 <subtitle>{subtitle}</subtitle>
 <abstract>
-    <para>Red Hat Developer Hub is a developer platform for building developer portals. This document contains release notes for the {product} {product-version}.</para>
+    <para>{abstract}</para>
 </abstract>
 <authorgroup>
-    <orgname>Red Hat Customer Content Services </orgname>
+    <orgname>{company-name} Customer Content Services </orgname>
 </authorgroup>
 <xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
diff --git a/titles/rel-notes-rhdh/title-rhdh-release-notes.adoc b/titles/rel-notes-rhdh/title-rhdh-release-notes.adoc
@@ -1,7 +1,8 @@
 [id='title-rhdh-release-notes']
 include::artifacts/attributes.adoc[]
-:title: Release notes
+:title: {product} release notes
 :subtitle: Release notes for {product} {product-version}
+:abstract: {product} ({product-short}) {product-version} is now generally available. {product-short} is a fully supported, enterprise-grade productized version of upstream Backstage v{product-backstage-version}. This document contains release notes for the {product} {product-version}.
 = {title}: {subtitle}
 :context: release-notes-rhdh
 :imagesdir: images

diff --git a/titles/upgrade-rhdh/docinfo.xml b/titles/upgrade-rhdh/docinfo.xml
@@ -1,10 +1,10 @@
-<title>Upgrading {product}</title>
+<title>{title}</title>
 <productname>{product}</productname>
 <productnumber>{product-version}</productnumber>
-<subtitle>
+<subtitle>{subtitle}
 </subtitle>
 <abstract>
-    <para>You can upgrade a {product} instance to a later version from the {ocp-short} web console using either the Operator or the Helm chart.</para>
+    <para>{abstract}</para>
 </abstract>
 <authorgroup>
     <orgname>{company-name} Customer Content Services</orgname>

diff --git a/titles/upgrade-rhdh/master.adoc b/titles/upgrade-rhdh/master.adoc
@@ -1,8 +1,11 @@
 [id="title-upgrade-rhdh"]
 include::artifacts/attributes.adoc[]
-= Upgrading {product}
+:title: Upgrading {product}
+:subtitle: Upgrading a {product} instance to a later version by using either the Operator or the Helm chart
+:abstract: You can upgrade a {product} instance to a later version from the {ocp-short} web console using either the Operator or the Helm chart.
 :context: title-upgrade-rhdh
 :imagesdir: images
+= {title}
 
 include::modules/upgrade/proc-upgrade-rhdh-operator.adoc[leveloffset=+1]