Skip to content

Commit 313d99c

Browse files
themr0clinfraze
themr0c
and
linfraze
authored
RHIDP-5409 Consistent titles and subtitles (redhat-developer#832)
Co-authored-by: Lindsey Frazier <[email protected]>
1 parent b09c768 commit 313d99c

File tree

37 files changed

+79
-65
lines changed

37 files changed

+79
-65
lines changed

‎titles/about/docinfo.xml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
<title>About {product}</title>
1+
<title>{title}</title>
22
<productname>{product}</productname>
33
<productnumber>{product-version}</productnumber>
4-
<subtitle>Introduction to {product}</subtitle>
4+
<subtitle>{subtitle}</subtitle>
55
<abstract>
6-
<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>
6+
<para>{abstract}</para>
77
</abstract>
88
<authorgroup>
99
<orgname>{company-name} Customer Content Services</orgname>
1010
</authorgroup>
11-
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
11+
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />

‎titles/about/master.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
include::artifacts/attributes.adoc[]
33
:imagesdir: images
44
:title: About {product}
5-
:subtitle: Introduction to {product}
6-
: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.
5+
: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.
6+
: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.
77

88
include::assemblies/assembly-about-rhdh.adoc[]
99

‎titles/admin-rhdh/title-admin.adoc

Whitespace-only changes.

‎titles/audit-log/master.adoc

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
include::artifacts/attributes.adoc[]
22
:context: title-audit-log
33
:imagesdir: images
4-
:title: Audit log
4+
:title: Audit logs in {product}
55
:subtitle: Tracking user activities, system events, and data changes with {product} audit logs
66
:abstract: As a {product} administrator, you can track user activities, system events, and data changes with {product-short} audit logs.
7-
87
= {title}
98

109
// Audit logging

‎titles/authentication/master.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
include::artifacts/attributes.adoc[]
22
:context: title-authentication
33
:imagesdir: images
4-
:title: Authentication
4+
:title: Authentication in {product}
55
:subtitle: Configuring authentication to external services in {product}
66
:abstract: As a {product} platform engineer, you can manage authentication of other users to meet the specific needs of your organization.
77
//[id="{context}"]

‎titles/authorization/master.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
include::artifacts/attributes.adoc[]
22
:context: title-authorization
33
:imagesdir: images
4-
:title: Authorization
4+
:title: Authorization in {product}
55
:subtitle: Configuring authorization by using role based access control (RBAC) in {product}
66
: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.
77
//[id="{context}"]

‎titles/configuring/master.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
include::artifacts/attributes.adoc[]
2-
:title: Configuring
3-
:subtitle: Configuring {product}
2+
:title: Configuring {product}
3+
:subtitle: Add custom config maps and secrets to configure your {product} instance to work in your IT ecosystem.
44
:abstract: Learn how to configure {product} for production to work in your IT ecosystem by adding custom config maps and secrets.
55
:context: configuring-and-operating
66
[id="{context}"]

‎titles/customizing/master.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
include::artifacts/attributes.adoc[]
2-
:title: Customizing
3-
:subtitle: Customizing {product}
4-
:abstract: Learn to customize {product}, such as templates, learning paths, tech docs, tech radar, home page, quick access cards, and appearance.
2+
:title: Customizing {product}
3+
:subtitle: Customize {product} appearance and features, such as templates, Learning Paths, Tech Radar, Home page, and quick access cards.
4+
:abstract: Authorized users can customize {product} appearance and features, such as templates, Learning Paths, Tech Radar, Home page, and quick access cards.
55
:context: customizing-display
66
[id="{context}"]
77
= {title}

‎titles/install-rhdh-air-gapped/docinfo.xml

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
<title>Installing {product} in an air-gapped environment</title>
1+
<title>{title}</title>
22
<productname>{product}</productname>
33
<productnumber>{product-version}</productnumber>
4-
<subtitle>
5-
</subtitle>
4+
<subtitle>{subtitle}</subtitle>
65
<abstract>
7-
<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>
6+
<para>{abstract}</para>
87
</abstract>
98
<authorgroup>
109
<orgname>{company-name} Customer Content Services</orgname>

‎titles/install-rhdh-air-gapped/master.adoc

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
[id="title-install-rhdh-air-grapped"]
22
include::artifacts/attributes.adoc[]
3-
= Installing {product} in an air-gapped environment
3+
:title: Installing {product} in an air-gapped environment
4+
:subtitle: Running {product} on {ocp-brand-name} in a networik restricted environment by using either the Operator or Helm chart.
5+
: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.
6+
= {title}
47
:context: title-install-rhdh-air-grapped
58
:imagesdir: images
69

‎titles/install-rhdh-aks/docinfo.xml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
<title>Installing {product} on {aks-brand-name}</title>
1+
<title>{title}</title>
22
<productname>{product}</productname>
33
<productnumber>{product-version}</productnumber>
4-
<subtitle>
4+
<subtitle>{subtitle}
55
</subtitle>
66
<abstract>
7-
<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>
7+
<para>{abstract}</para>
88
</abstract>
99
<authorgroup>
1010
<orgname>{company-name} Customer Content Services</orgname>

‎titles/install-rhdh-aks/master.adoc

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
[id="title-install-rhdh-aks"]
22
include::artifacts/attributes.adoc[]
3-
= Installing {product} on {aks-brand-name}
3+
:title: Installing {product} on {aks-brand-name}
4+
:subtitle: Running {product} on {aks-brand-name} ({aks-short}) by using either the Operator or Helm chart.
5+
: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.
6+
= {title}
47
:context: title-install-rhdh-aks
58
:imagesdir: images
69

‎titles/install-rhdh-eks/docinfo.xml

+5-7
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
1-
<title>Installing {product} on {eks-brand-name}</title>
1+
<title>{title}</title>
22
<productname>{product}</productname>
33
<productnumber>{product-version}</productnumber>
4-
<subtitle>
5-
</subtitle>
4+
<subtitle>{subtitle}</subtitle>
65
<abstract>
7-
<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>
6+
<para>{abstract}</para>
87
</abstract>
98
<authorgroup>
10-
<orgname>{company-name} Customer Content Services</orgname>
9+
<orgname>{company-name} Customer Content Services</orgname>
1110
</authorgroup>
12-
<xi:include href="Common_Content/Legal_Notice.xml"
13-
xmlns:xi="http://www.w3.org/2001/XInclude" />
11+
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

‎titles/install-rhdh-eks/master.adoc

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
[id="title-install-rhdh-eks"]
22
include::artifacts/attributes.adoc[]
3-
= Installing {product} on {eks-brand-name}
3+
:title: Installing {product} on {eks-brand-name}
4+
:subtitle: Running {product} on {eks-brand-name} ({eks-short}) by using either the Operator or Helm chart
5+
: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.
6+
= {title}
47
:context: title-install-rhdh-eks
58
:imagesdir: images
69

‎titles/install-rhdh-gke/docinfo.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<title>Installing {product} on {gke-brand-name}</title>
22
<productname>{product}</productname>
33
<productnumber>{product-version}</productnumber>
4-
<subtitle>
4+
<subtitle>{subtitle}
55
</subtitle>
66
<abstract>
7-
<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>
7+
<para>{abstract}</para>
88
</abstract>
99
<authorgroup>
1010
<orgname>{company-name} Customer Content Services</orgname>

‎titles/install-rhdh-gke/master.adoc

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
[id="title-install-rhdh-gke"]
22
include::artifacts/attributes.adoc[]
3-
= Installing {product} on {gke-brand-name}
3+
:title: Installing {product} on {gke-brand-name}
4+
:subtitle: Running {product} on {gke-brand-name} ({gke-short}) by using either the Operator or Helm chart.
5+
: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.
6+
= {title}
47
:context: title-install-rhdh-gke
58
:imagesdir: images
69

‎titles/install-rhdh-ocp/docinfo.xml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
<title>Installing {product} on {ocp-short}</title>
1+
<title>{title}</title>
22
<productname>{product}</productname>
33
<productnumber>{product-version}</productnumber>
4-
<subtitle>
4+
<subtitle>{subtitle}
55
</subtitle>
66
<abstract>
7-
<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>
7+
<para>{abstract}</para>
88
</abstract>
99
<authorgroup>
1010
<orgname>{company-name} Customer Content Services</orgname>

‎titles/install-rhdh-ocp/master.adoc

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
[id="title-install-rhdh-ocp"]
22
include::artifacts/attributes.adoc[]
3-
= Installing {product} on {ocp-short}
3+
:title: Installing {product} on {ocp-short}
4+
:subtitle: Running {product} on {ocp-brand-name} by using either the Operator or Helm chart.
5+
: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.
6+
= {title}
47
:context: title-install-rhdh-ocp
58
:imagesdir: images
69

‎titles/install-rhdh-osd-gcp/docinfo.xml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
<title>Installing {product} on {osd-short} on {gcp-brand-name}</title>
1+
<title>{title}</title>
22
<productname>{product}</productname>
33
<productnumber>{product-version}</productnumber>
4-
<subtitle>
4+
<subtitle>{subtitle}
55
</subtitle>
66
<abstract>
7-
<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>
7+
<para>{abstract}</para>
88
</abstract>
99
<authorgroup>
1010
<orgname>{company-name} Customer Content Services</orgname>

‎titles/install-rhdh-osd-gcp/master.adoc

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
[id="title-install-rhdh-osd-gcp"]
22
include::artifacts/attributes.adoc[]
3-
= Installing {product} on {osd-short} on {gcp-brand-name}
3+
:title: Installing {product} on {osd-short} on {gcp-brand-name}
4+
:subtitle: Running {product} on {osd-brand-name} by using either the Operator or Helm chart.
5+
: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.
6+
= {title}
47
:context: title-install-rhdh-osd-gcp
58
:imagesdir: images
69

‎titles/installation-rhdh/artifacts

-1
This file was deleted.

‎titles/installation-rhdh/assemblies

-1
This file was deleted.

‎titles/installation-rhdh/images

-1
This file was deleted.

‎titles/installation-rhdh/modules

-1
This file was deleted.

‎titles/plugin-rhdh/docinfo.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
<title>Configuring plugins in {product}</title>
22
<productname>{product}</productname>
33
<productnumber>{product-version}</productnumber>
4-
<subtitle>
4+
<subtitle>{subtitle}
55
</subtitle>
66
<abstract>
77
<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>
88
</abstract>
99
<authorgroup>
1010
<orgname>Red Hat Customer Content Services </orgname>
1111
</authorgroup>
12-
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
12+
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />

‎titles/plugins-rhdh-about/docinfo.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<title>{title}</title>
22
<productname>{product}</productname>
33
<productnumber>{product-version}</productnumber>
4-
<subtitle>
4+
<subtitle>{subtitle}
55
</subtitle>
66
<abstract>
77
<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.

‎titles/plugins-rhdh-configure/docinfo.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<title>{title}</title>
22
<productname>{product}</productname>
33
<productnumber>{product-version}</productnumber>
4-
<subtitle>
4+
<subtitle>{subtitle}
55
</subtitle>
66
<abstract>
77
<para>{abstract}</para>

‎titles/plugins-rhdh-configure/master.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ include::artifacts/attributes.adoc[]
33
:imagesdir: images
44

55
:title: Configuring dynamic plugins
6-
:subtitle: Configuring dynamic plugins in {product-very-short} as a platform engineer.
6+
:subtitle: Configuring dynamic plugins in {product}
77
:abstract: As a platform engineer, you can configure dynamic plugins in {product-very-short} to access your development infrastructure or software development tools.
88

99
include::assemblies/dynamic-plugins/assembly-configuring-rhdh-plugins.adoc[]

‎titles/plugins-rhdh-install/docinfo.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<title>{title}</title>
22
<productname>{product}</productname>
33
<productnumber>{product-version}</productnumber>
4-
<subtitle>
4+
<subtitle>{subtitle}
55
</subtitle>
66
<abstract>
77
<para>{abstract}</para>

‎titles/plugins-rhdh-reference/docinfo.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<title>{title}</title>
22
<productname>{product}</productname>
33
<productnumber>{product-version}</productnumber>
4-
<subtitle>
4+
<subtitle>{subtitle}
55
</subtitle>
66
<abstract>
77
<para>{abstract}</para>

‎titles/plugins-rhdh-reference/master.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ include::artifacts/attributes.adoc[]
33
:imagesdir: images
44

55
:title: Dynamic plugins reference
6-
:subtitle: Working with plugins in {product-very-short}
6+
:subtitle: {product} is preinstalled with a selection of dynamic plugins that you can enable and configure to extend {product-short} functionality
77
:abstract: {product} is preinstalled with a selection of dynamic plugins that users can enable and configure to extend {product-very-short} functionality.
88

99
include::assemblies/dynamic-plugins/assembly-rhdh-installing-dynamic-plugins.adoc[]

‎titles/plugins-rhdh-using/docinfo.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<title>{title}</title>
22
<productname>{product}</productname>
33
<productnumber>{product-version}</productnumber>
4-
<subtitle>
4+
<subtitle>{subtitle}
55
</subtitle>
66
<abstract>
77
<para>{abstract}</para>

‎titles/plugins-rhdh-using/master.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
include::artifacts/attributes.adoc[]
22
:context: title-plugins-rhdh-using
33
:imagesdir: images
4-
:title: Using dynamic plugins
5-
:subtitle: Using {product-very-short} plugins as an end-user
4+
:title: Using dynamic plugins in {product}
5+
:subtitle: Using {product} plugins to access your development infrastructure and software development tools.
66
:abstract: The following sections provide information about how you can use {product-very-short} dynamic plugins.
77
//[id="{context}"]
88
//= {title}

‎titles/rel-notes-rhdh/docinfo.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<productnumber>{product-version}</productnumber>
44
<subtitle>{subtitle}</subtitle>
55
<abstract>
6-
<para>Red Hat Developer Hub is a developer platform for building developer portals. This document contains release notes for the {product} {product-version}.</para>
6+
<para>{abstract}</para>
77
</abstract>
88
<authorgroup>
9-
<orgname>Red Hat Customer Content Services </orgname>
9+
<orgname>{company-name} Customer Content Services </orgname>
1010
</authorgroup>
1111
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />

‎titles/rel-notes-rhdh/title-rhdh-release-notes.adoc

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
[id='title-rhdh-release-notes']
22
include::artifacts/attributes.adoc[]
3-
:title: Release notes
3+
:title: {product} release notes
44
:subtitle: Release notes for {product} {product-version}
5+
: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}.
56
= {title}: {subtitle}
67
:context: release-notes-rhdh
78
:imagesdir: images

‎titles/upgrade-rhdh/docinfo.xml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
<title>Upgrading {product}</title>
1+
<title>{title}</title>
22
<productname>{product}</productname>
33
<productnumber>{product-version}</productnumber>
4-
<subtitle>
4+
<subtitle>{subtitle}
55
</subtitle>
66
<abstract>
7-
<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>
7+
<para>{abstract}</para>
88
</abstract>
99
<authorgroup>
1010
<orgname>{company-name} Customer Content Services</orgname>

‎titles/upgrade-rhdh/master.adoc

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
[id="title-upgrade-rhdh"]
22
include::artifacts/attributes.adoc[]
3-
= Upgrading {product}
3+
:title: Upgrading {product}
4+
:subtitle: Upgrading a {product} instance to a later version by using either the Operator or the Helm chart
5+
: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.
46
:context: title-upgrade-rhdh
57
:imagesdir: images
8+
= {title}
69

710
include::modules/upgrade/proc-upgrade-rhdh-operator.adoc[leveloffset=+1]
811

0 commit comments

Comments
 (0)