Skip to content

Commit 8f7a7ef

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

File tree

89 files changed

+725
-446
lines changed

Some content is hidden

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

89 files changed

+725
-446
lines changed

‎artifacts/attributes.adoc‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
:red-hat-developers-documentation:
2-
:imagesdir:
2+
:doctype: article
3+
:imagesdir: images
34
:idseparator: -
45

56
// Company names
@@ -19,6 +20,8 @@
1920
:odf-name: OpenShift Data Foundation
2021

2122
:my-product-url: https://__<my_developer_hub_url>__
23+
:my-product-namespace: rhdh
24+
:my-product-cr-name: developer-hub
2225

2326
// Red Hat Platforms
2427
:ocp-brand-name: Red Hat OpenShift Container Platform
@@ -88,6 +91,12 @@
8891
:authorization-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/authorization/index
8992
:authorization-book-title: Authorization
9093

94+
:configuring-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/configuring/index
95+
:configuring-book-title: Configuring
96+
97+
:customizing-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/customizing/index
98+
:customizing-book-title: Customizing
99+
91100
:installing-on-ocp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_openshift_container_platform/index
92101
:installing-on-ocp-book-title: Installing {product} on {ocp-short}
93102

‎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.

‎assemblies/assembly-running-rhdh-behind-a-proxy.adoc‎ renamed to ‎assemblies/assembly-configuring-a-proxy.adoc‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1-
[id="assembly-running-rhdh-behind-a-proxy"]
2-
= Running the {product-very-short} application behind a corporate proxy
1+
:_mod-docs-content-type: ASSEMBLY
2+
:context: running-behind-a-proxy
3+
[id="{context}"]
4+
= Running {product} behind a corporate proxy
5+
6+
In a network restricted environment, configure {product} to use your proxy to access remote network resources.
37

48
You can run the {product-very-short} application behind a corporate proxy by setting any of the following environment variables before starting the application:
59

@@ -8,7 +12,8 @@ You can run the {product-very-short} application behind a corporate proxy by set
812
913
Additionally, set the `NO_PROXY` environment variable to bypass the proxy for certain domains. The variable value is a comma-separated list of hostnames or IP addresses that can be accessed without the proxy, even if one is specified.
1014

11-
include::modules/admin/procedure-understanding-no-proxy.adoc[leveloffset=+1]
15+
include::modules/configuring-a-proxy/proc-configuring-proxy-in-operator-deployment.adoc[leveloffset=+1]
16+
17+
18+
include::modules/configuring-a-proxy/proc-configuring-proxy-in-helm-deployment.adoc[leveloffset=+1]
1219

13-
include::modules/admin/proc-configuring-proxy-in-helm-deployment.adoc[leveloffset=+1]
14-
include::modules/admin/proc-configuring-proxy-in-operator-deployment.adoc[leveloffset=+1]

‎assemblies/assembly-configuring-external-postgresql-databases.adoc‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
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

46
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.
@@ -11,9 +13,11 @@ By default, the {product} operator or Helm Chart creates a local PostgreSQL data
1113
====
1214

1315

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

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

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

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

Lines changed: 25 additions & 15 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,
7+
and use documentation in a central location and in a standardized way. 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.
@@ -35,24 +37,32 @@ After you configure {odf-name} to store the files that TechDocs generates, you c
3537

3638
* For more information, see link:{LinkPluginsGuide}[Configuring plugins in {product}].
3739
38-
//Configuring storage
39-
include::modules/getting-started/con-techdocs-configure-storage.adoc[leveloffset=+1]
40+
include::modules/customizing-techdocs/con-techdocs-configure-storage.adoc[leveloffset=+1]
4041

41-
include::modules/getting-started/proc-techdocs-using-odf-storage.adoc[leveloffset=+2]
4242

43-
include::modules/getting-started/proc-techdocs-configure-odf-helm.adoc[leveloffset=+2]
43+
include::modules/customizing-techdocs/proc-techdocs-using-odf-storage.adoc[leveloffset=+2]
4444

45-
include::modules/getting-started/ref-techdocs-example-config-plugin-helm.adoc[leveloffset=+3]
4645

47-
include::modules/getting-started/proc-techdocs-configure-odf-operator.adoc[leveloffset=+2]
46+
include::modules/customizing-techdocs/proc-techdocs-configure-odf-helm.adoc[leveloffset=+2]
4847

49-
include::modules/getting-started/ref-techdocs-example-config-plugin-operator.adoc[leveloffset=+3]
5048

51-
//Configuring CI/CD
52-
include::modules/getting-started/con-techdocs-config-cicd.adoc[leveloffset=+1]
49+
include::modules/customizing-techdocs/ref-techdocs-example-config-plugin-helm.adoc[leveloffset=+3]
5350

54-
include::modules/getting-started/proc-techdocs-config-cicd-prep-repo.adoc[leveloffset=+2]
5551

56-
include::modules/getting-started/proc-techdocs-generate-site.adoc[leveloffset=+2]
52+
include::modules/customizing-techdocs/proc-techdocs-configure-odf-operator.adoc[leveloffset=+2]
53+
54+
55+
include::modules/customizing-techdocs/ref-techdocs-example-config-plugin-operator.adoc[leveloffset=+3]
56+
57+
58+
include::modules/customizing-techdocs/con-techdocs-config-cicd.adoc[leveloffset=+1]
59+
60+
61+
include::modules/customizing-techdocs/proc-techdocs-config-cicd-prep-repo.adoc[leveloffset=+2]
62+
63+
64+
include::modules/customizing-techdocs/proc-techdocs-generate-site.adoc[leveloffset=+2]
65+
66+
67+
include::modules/customizing-techdocs/proc-techdocs-publish-site.adoc[leveloffset=+2]
5768

58-
include::modules/getting-started/proc-techdocs-publish-site.adoc[leveloffset=+2]

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

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,22 @@
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-
12-
include::modules/templates/proc-creating-templates.adoc[leveloffset=+1]
13-
include::modules/templates/ref-creating-templates.adoc[leveloffset=+1]
10+
include::modules/customizing-templates/proc-creating-templates.adoc[leveloffset=+1]
11+
include::modules/customizing-templates/ref-creating-templates.adoc[leveloffset=+1]
1412

1513
[role="_additional-resources"]
1614
.Additional resources
1715
* link:https://backstage.io/docs/features/software-templates/writing-templates[Backstage documentation - Writing Templates]
1816
* link:https://backstage.io/docs/features/software-templates/builtin-actions[Backstage documentation - Builtin actions]
1917
* link:https://backstage.io/docs/features/software-templates/writing-custom-actions[Backstage documentation - Writing Custom Actions]
2018
21-
include::modules/templates/proc-adding-templates.adoc[leveloffset=+1]
19+
include::modules/customizing-templates/proc-adding-templates.adoc[leveloffset=+1]
2220

2321
[role="_additional-resources"]
2422
.Additional resources

‎assemblies/assembly-customize-rhdh-theme.adoc‎

Lines changed: 0 additions & 42 deletions
This file was deleted.

‎assemblies/assembly-customizing-the-appearance.adoc‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
:context: customizing-appearance
3+
[id="{context}"]
4+
= Customizing {product} appearance
5+
6+
The following default theme configurations are available for {product}:
7+
8+
The {product} theme:: Default theme configurations to make your developer portal look like a standard {product} instance. For more information, see xref:ref-customize-rhdh-default-rhdh_{context}[]
9+
10+
The Backstage theme:: Default theme configurations to make your developer portal look like a standard Backstage instance. For more information, see xref:ref-customize-rhdh-default-backstage_{context}[]
11+
12+
You can change or disable particular parameters in a default theme or create a fully customized theme by modifying the `app-config-rhdh.yaml` file. From the the `app-config-rhdh.yaml` file, you can customize common theme components, including the following:
13+
14+
* Company name and logo
15+
* Font color, size, and style of text in paragraphs, headings, headers, and buttons
16+
* Header color, gradient, and shape
17+
* Button color
18+
* Navigation indicator color
19+
20+
You can also customize some components from the {product-short} GUI, such as the theme mode (*Light Theme*, *Dark Theme*, or *Auto*).
21+
22+
include::modules/customizing-the-appearance/proc-customize-rhdh-theme-mode.adoc[leveloffset=+1]
23+
24+
25+
include::modules/customizing-the-appearance/proc-customize-rhdh-branding-logo.adoc[leveloffset=+1]
26+
27+
28+
include::modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc[leveloffset=+1]
29+
30+
31+
include::modules/customizing-the-appearance/proc-customize-rhdh-tab-tooltip.adoc[leveloffset=+1]
32+
33+
34+
include::modules/customizing-the-appearance/proc-customize-rhdh-palette.adoc[leveloffset=+1]
35+
36+
37+
include::modules/customizing-the-appearance/proc-customize-rhdh-page-theme.adoc[leveloffset=+1]
38+
39+
40+
include::modules/customizing-the-appearance/proc-customize-rhdh-font.adoc[leveloffset=+1]
41+
42+
43+
include::modules/customizing-the-appearance/ref-customize-rhdh-default-rhdh.adoc[leveloffset=+1]
44+
45+
46+
include::modules/customizing-the-appearance/ref-customize-rhdh-default-backstage.adoc[leveloffset=+1]
47+
48+
49+
include::modules/customizing-the-appearance/ref-customize-rhdh-custom-components.adoc[leveloffset=+1]
50+

‎assemblies/assembly-customizing-the-rhdh-homepage.adoc‎ renamed to ‎assemblies/assembly-customizing-the-homepage.adoc‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
[id='proc-customize-rhdh-homepage_{context}']
2-
= Customizing the Home page in {product}
1+
:_mod-docs-content-type: ASSEMBLY
2+
:context: customizing-the-home-page
3+
[id="{context}"]
4+
= Customizing the Home page
35

46
When using the `app-config`, you can do the following:
57

@@ -15,5 +17,8 @@ When using the `app-config`, you can do the following:
1517
** Catalog starred entities
1618
** Featured docs
1719
18-
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]
20+
include::modules/customizing-the-home-page/proc-customizing-the-home-page-cards.adoc[leveloffset=+1]
21+
22+
23+
include::modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc[leveloffset=+1]
24+

0 commit comments

Comments
 (0)