Skip to content

Commit d493c1a

Browse files
committed
RHIDP-4929 Moving content to dedicated titles for the Configure category
Signed-off-by: Fabrice Flore-Thébault <[email protected]>
1 parent 2e353e8 commit d493c1a

File tree

56 files changed

+153
-172
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+153
-172
lines changed

artifacts/attributes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
:red-hat-developers-documentation:
2-
:imagesdir:
2+
:imagesdir: images
33
:idseparator: -
44

55
// Company names

artifacts/docinfo.xml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<title>{title}</title>
2+
<productname>{product}</productname>
3+
<productnumber>{product-version}</productnumber>
4+
<subtitle>{subtitle}</subtitle>
5+
<abstract>
6+
<para>{abstract}</para>
7+
</abstract>
8+
<authorgroup>
9+
<orgname>{company-name} Customer Content Services</orgname>
10+
</authorgroup>
11+
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

assemblies/assembly-add-custom-app-file-openshift.adoc

Lines changed: 0 additions & 25 deletions
This file was deleted.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
:context: adding-custom-configuration-files
3+
[id="{context}"]
4+
= Adding custom configuration files to {product}
5+
6+
To configure {product}, add custom configuration files to {ocp-brand-name} and register them in {product-short}.
7+
8+
include::modules/adding-custom-configuration-files/proc-adding-custom-configuration-files-by-using-the-operator.adoc[leveloffset=+1]
9+
10+
11+
include::modules/adding-custom-configuration-files/proc-adding-custom-configuration-files-by-using-helm.adoc[leveloffset=+1]
Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
1-
[id="assembly-configuring-external-postgresql-databases"]
1+
:_mod-docs-content-type: ASSEMBLY
2+
:context: configuring-external-postgresql-databases
3+
[id="{context}"]
24
= Configuring external PostgreSQL databases
35

4-
As an administrator, you can configure and use external PostgreSQL databases in {product}. You can use a PostgreSQL certificate file to configure an external PostgreSQL instance using the Operator or Helm Chart.
6+
As an administrator, you can configure and use external PostgreSQL databases in {product}.
7+
You can use a PostgreSQL certificate file to configure an external PostgreSQL instance using the Operator or Helm Chart.
58

69
[NOTE]
710
====
@@ -11,9 +14,11 @@ By default, the {product} operator or Helm Chart creates a local PostgreSQL data
1114
====
1215

1316

14-
include::modules/admin/proc-configuring-postgresql-instance-using-operator.adoc[leveloffset=+1]
17+
include::modules/external-databases/proc-configuring-postgresql-instance-using-operator.adoc[leveloffset=+1]
1518

16-
include::modules/admin/proc-configuring-postgresql-instance-using-helm.adoc[leveloffset=+1]
1719

18-
include::modules/admin/proc-migrating-databases-to-an-external-server.adoc[leveloffset=+1]
20+
include::modules/external-databases/proc-configuring-postgresql-instance-using-helm.adoc[leveloffset=+1]
21+
22+
23+
include::modules/external-databases/proc-migrating-databases-to-an-external-server.adoc[leveloffset=+1]
1924

assemblies/assembly-techdocs-plugin.adoc renamed to assemblies/assembly-configuring-techdocs.adoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
:_mod-docs-content-type: ASSEMBLY
2-
[id="assembly-techdocs-plugin_{context}"]
3-
= Configuring the TechDocs plugin in {product}
2+
:context: configuring-techdocs
3+
[id="{context}"]
4+
= Configuring TechDocs
45

5-
The {product} TechDocs plugin helps your organization create, find, and use documentation in a central location and in a standardized way. For example:
6+
Configure the {product} TechDocs plugin to create, find, and use documentation in a central location and in a standardized way.
7+
For example:
68

79
Docs-like-code approach::
810
Write your technical documentation in Markdown files that are stored inside your project repository along with your code.

assemblies/assembly-admin-templates.adoc renamed to assemblies/assembly-configuring-templates.adoc

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
:_mod-docs-content-type: ASSEMBLY
2-
[id="assembly-admin-templates"]
3-
= Managing templates
4-
:context: assembly-admin-templates
2+
:context: configuring-templates
3+
[id="{context}"]
4+
= Configuring templates
55

6-
toc::[]
6+
Configure templates to create software components, and publish these components to different locations, such as the {product} software catalog, or Git repositories.
77

88
A template is a form composed of different UI fields that is defined in a YAML file. Templates include _actions_, which are steps that are executed in sequential order and can be executed conditionally.
99

10-
You can use templates to easily create {product} components, and then publish these components to different locations, such as the {product} software catalog, or repositories in GitHub or GitLab.
11-
1210
include::modules/templates/proc-creating-templates.adoc[leveloffset=+1]
1311
include::modules/templates/ref-creating-templates.adoc[leveloffset=+1]
1412

assemblies/assembly-customize-rhdh-theme.adoc renamed to assemblies/assembly-customizing-rhdh-appearance.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
:_mod-docs-content-type: ASSEMBLY
2-
[id="assembly-customize-rhdh-theme"]
3-
= Customizing the appearance of your {product} instance
4-
:context: assembly-customize-rhdh-theme
2+
:context: customizing-appearance
3+
[id="{context}"]
4+
= Customizing {product} appearance
55

66
The following default theme configurations are available for {product}:
77

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
:_mod-docs-content-type: ASSEMBLY
2-
3-
[id="customizing-the-quick-access-card-in-rhdh"]
4-
= Customizing the Quick access card in {product}
2+
:context: customizing-quick-access-card
3+
[id="{context}"]
4+
= Customizing {product} Quick access card
55

66
To access the Home page in {product}, the base URL must include the `/developer-hub` proxy. You can configure the Home page by passing the data into the `app-config.yaml` file as a proxy. You can provide data to the Home page from the following sources:
77

88
* JSON files hosted on GitHub or GitLab.
99
* A dedicated service that provides the Home page data in JSON format using an API.
1010
1111
include::modules/getting-started/proc-using-hosted-json-files-to-provide-data-to-the-quick-access-card.adoc[leveloffset=+1]
12-
include::modules/getting-started/proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc[leveloffset=+1]
1312

1413

14+
include::modules/getting-started/proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc[leveloffset=+1]
1515

assemblies/assembly-customizing-the-rhdh-homepage.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[id='proc-customize-rhdh-homepage_{context}']
1+
[id='proc-customize-rhdh-homepage']
22
= Customizing the Home page in {product}
33

44
When using the `app-config`, you can do the following:
@@ -16,4 +16,4 @@ When using the `app-config`, you can do the following:
1616
** Featured docs
1717

1818
include::modules/getting-started/proc-customizing-the-home-page-cards.adoc[leveloffset=+1]
19-
include::modules/getting-started/proc-defining-the-layout-of-the-product-home-page.adoc[leveloffset=+1]
19+
include::modules/getting-started/proc-defining-the-layout-of-the-product-home-page.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)