From 6f9e86799b6398326d24d7522c0b10ccd87800ce Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= <ffloreth@redhat.com>
Date: Tue, 7 Jan 2025 15:13:06 +0100
Subject: [PATCH 01/10] RHIDP-5409 Consistent titles and subtitles
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Fabrice Flore-Thébault <ffloreth@redhat.com>
---
titles/about/docinfo.xml | 8 ++++----
titles/about/master.adoc | 2 +-
titles/admin-rhdh/title-admin.adoc | 0
titles/audit-log/master.adoc | 3 +--
titles/authentication/master.adoc | 2 +-
titles/authorization/master.adoc | 2 +-
titles/configuring/master.adoc | 4 ++--
titles/customizing/master.adoc | 6 +++---
titles/install-rhdh-air-gapped/docinfo.xml | 7 +++----
titles/install-rhdh-air-gapped/master.adoc | 5 ++++-
titles/install-rhdh-aks/docinfo.xml | 6 +++---
titles/install-rhdh-aks/master.adoc | 5 ++++-
titles/install-rhdh-eks/docinfo.xml | 14 +++++++-------
titles/install-rhdh-eks/master.adoc | 5 ++++-
titles/install-rhdh-gke/docinfo.xml | 4 ++--
titles/install-rhdh-gke/master.adoc | 5 ++++-
titles/install-rhdh-ocp/docinfo.xml | 6 +++---
titles/install-rhdh-ocp/master.adoc | 5 ++++-
titles/install-rhdh-osd-gcp/docinfo.xml | 6 +++---
titles/install-rhdh-osd-gcp/master.adoc | 5 ++++-
titles/installation-rhdh/artifacts | 1 -
titles/installation-rhdh/assemblies | 1 -
titles/installation-rhdh/images | 1 -
titles/installation-rhdh/modules | 1 -
titles/plugin-rhdh/docinfo.xml | 4 ++--
titles/plugins-rhdh-about/docinfo.xml | 2 +-
titles/plugins-rhdh-configure/docinfo.xml | 2 +-
titles/plugins-rhdh-configure/master.adoc | 2 +-
titles/plugins-rhdh-install/docinfo.xml | 2 +-
titles/plugins-rhdh-reference/docinfo.xml | 2 +-
titles/plugins-rhdh-reference/master.adoc | 2 +-
titles/plugins-rhdh-using/docinfo.xml | 2 +-
titles/plugins-rhdh-using/master.adoc | 4 ++--
titles/rel-notes-rhdh/docinfo.xml | 4 ++--
.../rel-notes-rhdh/title-rhdh-release-notes.adoc | 3 ++-
titles/upgrade-rhdh/docinfo.xml | 6 +++---
titles/upgrade-rhdh/master.adoc | 5 ++++-
37 files changed, 80 insertions(+), 64 deletions(-)
delete mode 100644 titles/admin-rhdh/title-admin.adoc
delete mode 120000 titles/installation-rhdh/artifacts
delete mode 120000 titles/installation-rhdh/assemblies
delete mode 120000 titles/installation-rhdh/images
delete mode 120000 titles/installation-rhdh/modules
diff --git a/titles/about/docinfo.xml b/titles/about/docinfo.xml
index 3dceb13718..5f7fe2ebac 100644
--- 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" />
\ No newline at end of file
+<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
index 501f4e120a..f794c66171 100644
--- 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
deleted file mode 100644
index e69de29bb2..0000000000
diff --git a/titles/audit-log/master.adoc b/titles/audit-log/master.adoc
index 066a02fe15..b836359233 100644
--- 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
index 9c4afeb354..0db027bd0c 100644
--- 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
index f864dbbf0d..1ac9860e0d 100644
--- 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
index 82b772f476..213f98acf9 100644
--- 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
index 869c0b6da2..a92300055f 100644
--- 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
index f86cb562a6..0d03200f03 100644
--- 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
index fe3c12095a..7ef00cf127 100644
--- 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
index 563695acbe..e7fae0f66e 100644
--- 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
index f04de833c2..f8a00fc926 100644
--- 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
index b1a2c5d42f..f3720f6310 100644
--- 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
index cb37cf1613..bc93f42610 100644
--- 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
index 40f0701c84..f2a7a08a87 100644
--- 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
index 94eb52f952..aa80c53583 100644
--- 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
index 329d70fca5..e7fae0f66e 100644
--- 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
index a3c4500b5a..929755a1ed 100644
--- 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
index f56612be77..e7fae0f66e 100644
--- 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
index e90cb661a8..975f2138f0 100644
--- 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
deleted file mode 120000
index f30b6dea60..0000000000
--- a/titles/installation-rhdh/artifacts
+++ /dev/null
@@ -1 +0,0 @@
-../../artifacts
\ No newline at end of file
diff --git a/titles/installation-rhdh/assemblies b/titles/installation-rhdh/assemblies
deleted file mode 120000
index 91646274db..0000000000
--- a/titles/installation-rhdh/assemblies
+++ /dev/null
@@ -1 +0,0 @@
-../../assemblies
\ No newline at end of file
diff --git a/titles/installation-rhdh/images b/titles/installation-rhdh/images
deleted file mode 120000
index 5fa6987088..0000000000
--- a/titles/installation-rhdh/images
+++ /dev/null
@@ -1 +0,0 @@
-../../images
\ No newline at end of file
diff --git a/titles/installation-rhdh/modules b/titles/installation-rhdh/modules
deleted file mode 120000
index 8b0e854007..0000000000
--- a/titles/installation-rhdh/modules
+++ /dev/null
@@ -1 +0,0 @@
-../../modules
\ No newline at end of file
diff --git a/titles/plugin-rhdh/docinfo.xml b/titles/plugin-rhdh/docinfo.xml
index e8bc68e50b..80df65a36a 100644
--- a/titles/plugin-rhdh/docinfo.xml
+++ b/titles/plugin-rhdh/docinfo.xml
@@ -1,7 +1,7 @@
<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>
@@ -9,4 +9,4 @@
<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" />
\ No newline at end of file
+<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
index 5fc51a0f23..8383a9fef4 100644
--- 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
index e4b171f26e..e7fae0f66e 100644
--- 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
index 1974eabe8f..9c02fdfbac 100644
--- 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
index e4b171f26e..e7fae0f66e 100644
--- 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
index e4b171f26e..e7fae0f66e 100644
--- 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
index bcd22f4c9b..2902e446dd 100644
--- 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
index e4b171f26e..e7fae0f66e 100644
--- 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
index e104b5c88e..7493b761d7 100644
--- 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
index 4c6026ca94..bc4f3ba6aa 100644
--- 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
index defd37350a..acc10437ca 100644
--- 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
index 7ad28a1c63..e7fae0f66e 100644
--- 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
index 139e770ecf..f8a4f25138 100644
--- 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]
From a1a45e40f67a47ea9e31a3f0d56b6180a1dddcc1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= <ffloreth@redhat.com>
Date: Tue, 14 Jan 2025 07:58:43 +0100
Subject: [PATCH 02/10] Update titles/install-rhdh-eks/docinfo.xml
---
titles/install-rhdh-eks/docinfo.xml | 1 +
1 file changed, 1 insertion(+)
diff --git a/titles/install-rhdh-eks/docinfo.xml b/titles/install-rhdh-eks/docinfo.xml
index f3720f6310..4d4a07356c 100644
--- a/titles/install-rhdh-eks/docinfo.xml
+++ b/titles/install-rhdh-eks/docinfo.xml
@@ -3,6 +3,7 @@
<productnumber>{product-version}</productnumber>
<subtitle>{subtitle}
</subtitle>
+<abstract>
<para>{abstract}</para>
</abstract>
<authorgroup>
From cfadb44d911702c455adf09c7369b671cd577849 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= <ffloreth@redhat.com>
Date: Tue, 14 Jan 2025 08:02:51 +0100
Subject: [PATCH 03/10] fix typo
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Fabrice Flore-Thébault <ffloreth@redhat.com>
---
titles/install-rhdh-eks/docinfo.xml | 9 +++------
1 file changed, 3 insertions(+), 6 deletions(-)
diff --git a/titles/install-rhdh-eks/docinfo.xml b/titles/install-rhdh-eks/docinfo.xml
index 4d4a07356c..35491c93fe 100644
--- a/titles/install-rhdh-eks/docinfo.xml
+++ b/titles/install-rhdh-eks/docinfo.xml
@@ -1,14 +1,11 @@
<title>{title}</title>
<productname>{product}</productname>
<productnumber>{product-version}</productnumber>
-<subtitle>{subtitle}
-</subtitle>
+<subtitle>{subtitle}</subtitle>
<abstract>
<para>{abstract}</para>
- </abstract>
+</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"/>
-<abstract>
+<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
From ea095b1ec3f10c4fb8d75ca3c62fa3c367824a7a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= <ffloreth@redhat.com>
Date: Mon, 27 Jan 2025 17:04:22 +0100
Subject: [PATCH 04/10] Update
titles/rel-notes-rhdh/title-rhdh-release-notes.adoc
---
titles/rel-notes-rhdh/title-rhdh-release-notes.adoc | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/titles/rel-notes-rhdh/title-rhdh-release-notes.adoc b/titles/rel-notes-rhdh/title-rhdh-release-notes.adoc
index acc10437ca..5cdd60e777 100644
--- a/titles/rel-notes-rhdh/title-rhdh-release-notes.adoc
+++ b/titles/rel-notes-rhdh/title-rhdh-release-notes.adoc
@@ -2,7 +2,7 @@
include::artifacts/attributes.adoc[]
: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}.
+:abstract: {product} ({product-short}) {product-version} is now generally available. {product-short} is a fully supported, enterprise-grade productized version of upstream Backstage {product-backstage-version}. This document contains release notes for the {product} {product-version}.
= {title}: {subtitle}
:context: release-notes-rhdh
:imagesdir: images
From 4bb8e1a84a5ce7a65d721a6ed720bc7b1b00ba42 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= <ffloreth@redhat.com>
Date: Wed, 29 Jan 2025 11:10:12 +0100
Subject: [PATCH 05/10] Update titles/about/master.adoc
Co-authored-by: Lindsey Frazier <lfrazier@redhat.com>
---
titles/about/master.adoc | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/titles/about/master.adoc b/titles/about/master.adoc
index 7add52424d..9c04d0a825 100644
--- a/titles/about/master.adoc
+++ b/titles/about/master.adoc
@@ -2,7 +2,7 @@
include::artifacts/attributes.adoc[]
:imagesdir: images
:title: About {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
+:subtitle: {product} is a customizable developer portal with enterprise-level support and a centralized software catalog that you can use to build high-quality software efficiently in a streamlined development environment.
: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[]
From c28ffd77dc67cbb4d8943aead311be82348ba3b3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= <ffloreth@redhat.com>
Date: Wed, 29 Jan 2025 11:11:58 +0100
Subject: [PATCH 06/10] Update titles/about/master.adoc
---
titles/about/master.adoc | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/titles/about/master.adoc b/titles/about/master.adoc
index 9c04d0a825..0d00cfa9d1 100644
--- a/titles/about/master.adoc
+++ b/titles/about/master.adoc
@@ -3,7 +3,7 @@ include::artifacts/attributes.adoc[]
:imagesdir: images
:title: About {product}
:subtitle: {product} is a customizable developer portal with enterprise-level support and a centralized software catalog that you can use to build high-quality software efficiently in a streamlined development environment.
-: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.
+:abstract: {product} is a customizable developer portal with enterprise-level support and a centralized software catalog that you can use to build high-quality software efficiently in a streamlined development environment.
include::assemblies/assembly-about-rhdh.adoc[]
From 913b164478fda52383002a05443667faae0f09fe Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= <ffloreth@redhat.com>
Date: Wed, 29 Jan 2025 11:13:23 +0100
Subject: [PATCH 07/10] Update titles/configuring/master.adoc
---
titles/configuring/master.adoc | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/titles/configuring/master.adoc b/titles/configuring/master.adoc
index 213f98acf9..edce24bba2 100644
--- a/titles/configuring/master.adoc
+++ b/titles/configuring/master.adoc
@@ -1,6 +1,6 @@
include::artifacts/attributes.adoc[]
:title: Configuring {product}
-:subtitle: Configuring {product} for production to work in your IT ecosystem by adding custom config maps and secrets
+:subtitle: Add custom config maps and secrets to configure your {product} instance to work in your IT ecosystem.
: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}"]
From 7c694c2544887e2ed1365361608d7eb92729812b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= <ffloreth@redhat.com>
Date: Wed, 29 Jan 2025 11:13:37 +0100
Subject: [PATCH 08/10] Update titles/customizing/master.adoc
Co-authored-by: Lindsey Frazier <lfrazier@redhat.com>
---
titles/customizing/master.adoc | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/titles/customizing/master.adoc b/titles/customizing/master.adoc
index a92300055f..57004b7a5e 100644
--- a/titles/customizing/master.adoc
+++ b/titles/customizing/master.adoc
@@ -1,6 +1,6 @@
include::artifacts/attributes.adoc[]
:title: Customizing {product}
-:subtitle: Customizing {product} features, such as templates, Learning Paths, TechDocs, Tech Radar, home page, quick access cards, and appearance.
+:subtitle: Customize {product} appearance and features, such as templates, Learning Paths, Tech Radar, Home page, and quick access cards.
: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}"]
From 2bce89e55be957946ac5fedc3f79ef01dc5ec88f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= <ffloreth@redhat.com>
Date: Wed, 29 Jan 2025 11:13:47 +0100
Subject: [PATCH 09/10] Update titles/customizing/master.adoc
Co-authored-by: Lindsey Frazier <lfrazier@redhat.com>
---
titles/customizing/master.adoc | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/titles/customizing/master.adoc b/titles/customizing/master.adoc
index 57004b7a5e..838b8d5b2d 100644
--- a/titles/customizing/master.adoc
+++ b/titles/customizing/master.adoc
@@ -1,7 +1,7 @@
include::artifacts/attributes.adoc[]
:title: Customizing {product}
:subtitle: Customize {product} appearance and features, such as templates, Learning Paths, Tech Radar, Home page, and quick access cards.
-:abstract: Learn to customize {product} features, such as templates, Learning Paths, TechDocs, Tech Radar, home page, quick access cards, and appearance.
+:abstract: Authorized users can customize {product} appearance and features, such as templates, Learning Paths, Tech Radar, Home page, and quick access cards.
:context: customizing-display
[id="{context}"]
= {title}
From 1d4fbf348915390f46d451f607199ca3f9fe0644 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= <ffloreth@redhat.com>
Date: Wed, 29 Jan 2025 11:14:47 +0100
Subject: [PATCH 10/10] Update titles/plugins-rhdh-configure/master.adoc
---
titles/plugins-rhdh-configure/master.adoc | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/titles/plugins-rhdh-configure/master.adoc b/titles/plugins-rhdh-configure/master.adoc
index 9c02fdfbac..2977e9c01f 100644
--- 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} as a platform engineer
+:subtitle: Configuring dynamic plugins in {product}
: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[]