Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion artifacts/attributes.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:red-hat-developers-documentation:
:imagesdir:
:imagesdir: images
:idseparator: -

// Company names
Expand Down
11 changes: 11 additions & 0 deletions artifacts/docinfo.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<title>{title}</title>
<productname>{product}</productname>
<productnumber>{product-version}</productnumber>
<subtitle>{subtitle}</subtitle>
<abstract>
<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"/>
25 changes: 0 additions & 25 deletions assemblies/assembly-add-custom-app-file-openshift.adoc

This file was deleted.

12 changes: 12 additions & 0 deletions assemblies/assembly-adding-custom-configuration-files.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
:_mod-docs-content-type: ASSEMBLY
:context: adding-custom-configuration-files
[id="{context}"]
= Adding custom configuration files to {product}

To configure {product}, add custom configuration files to {ocp-brand-name} and register them in {product-short}.

include::modules/adding-custom-configuration-files/proc-adding-custom-configuration-files-by-using-the-operator.adoc[leveloffset=+1]


include::modules/adding-custom-configuration-files/proc-adding-custom-configuration-files-by-using-helm.adoc[leveloffset=+1]

Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
[id="assembly-configuring-external-postgresql-databases"]
:_mod-docs-content-type: ASSEMBLY
:context: configuring-external-postgresql-databases
[id="{context}"]
= Configuring external PostgreSQL databases

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


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

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

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


include::modules/external-databases/proc-migrating-databases-to-an-external-server.adoc[leveloffset=+1]

Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
:_mod-docs-content-type: ASSEMBLY
[id="assembly-techdocs-plugin_{context}"]
= Configuring the TechDocs plugin in {product}
:context: configuring-techdocs
[id="{context}"]
= Configuring TechDocs

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

Docs-like-code approach::
Write your technical documentation in Markdown files that are stored inside your project repository along with your code.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
:_mod-docs-content-type: ASSEMBLY
[id="assembly-admin-templates"]
= Managing templates
:context: assembly-admin-templates
:context: configuring-templates
[id="{context}"]
= Configuring templates

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

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.

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.

include::modules/templates/proc-creating-templates.adoc[leveloffset=+1]
include::modules/templates/ref-creating-templates.adoc[leveloffset=+1]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:_mod-docs-content-type: ASSEMBLY
[id="assembly-customize-rhdh-theme"]
= Customizing the appearance of your {product} instance
:context: assembly-customize-rhdh-theme
:context: customizing-appearance
[id="{context}"]
= Customizing {product} appearance

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

Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
:_mod-docs-content-type: ASSEMBLY

[id="customizing-the-quick-access-card-in-rhdh"]
= Customizing the Quick access card in {product}
:context: customizing-quick-access-card
[id="{context}"]
= Customizing {product} Quick access card

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:

* JSON files hosted on GitHub or GitLab.
* A dedicated service that provides the Home page data in JSON format using an API.

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


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

4 changes: 2 additions & 2 deletions assemblies/assembly-customizing-the-rhdh-homepage.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[id='proc-customize-rhdh-homepage_{context}']
[id='proc-customize-rhdh-homepage']
= Customizing the Home page in {product}

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

include::modules/getting-started/proc-customizing-the-home-page-cards.adoc[leveloffset=+1]
include::modules/getting-started/proc-defining-the-layout-of-the-product-home-page.adoc[leveloffset=+1]
include::modules/getting-started/proc-defining-the-layout-of-the-product-home-page.adoc[leveloffset=+1]
16 changes: 0 additions & 16 deletions assemblies/assembly-rhdh-integration-aws.adoc

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
[id="assembly-running-rhdh-behind-a-proxy"]
= Running the {product-very-short} application behind a corporate proxy
:_mod-docs-content-type: ASSEMBLY
:context: running-behind-a-proxy
[id="{context}"]
= Running {product} behind a corporate proxy

In a network restricted environment, configure {product} to use your proxy to access remote network resources.

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

Expand All @@ -8,6 +12,8 @@ You can run the {product-very-short} application behind a corporate proxy by set

Additionally, you can set the `NO_PROXY` environment variable to exclude certain domains from proxying. The variable value is a comma-separated list of hostnames that do not require a proxy to get reached, even if one is specified.

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


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

include::modules/admin/proc-configuring-proxy-in-helm-deployment.adoc[leveloffset=+1]
include::modules/admin/proc-configuring-proxy-in-operator-deployment.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id='proc-add-custom-app-file-openshift-helm_{context}']
= Adding a custom application configuration file to {ocp-short} using the Helm chart
= Adding custom {product} configuration files by using the Helm chart

You can use the {product} Helm chart to add a custom application configuration file to your {ocp-short} instance.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="proc-add-custom-app-config-file-ocp-operator_{context}"]
= Adding a custom application configuration file to {ocp-short} using the Operator
= Adding custom {product} configuration files by using the operator

A custom application configuration file is a `ConfigMap` object that you can use to change the configuration of your {product} instance. If you are deploying your {product-short} instance on {ocp-brand-name}, you can use the {product} Operator to add a custom application configuration file to your {ocp-short} instance by creating the `ConfigMap` object and referencing it in the {product-short} custom resource (CR).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
// Module included in:
// title-admin.adoc

[id="proc-rhdh-deployment-config_{context}"]
= Configuring {product} deployment
= Configuring {product} deployment by using the operator

The {product} operator exposes a `rhdh.redhat.com/v1alpha2` API Version of its Custom Resource Definition (CRD). This CRD exposes a generic `spec.deployment.patch` field, which gives you full control over the {product-short} Deployment resource. This field can be a fragment of the standard `apps.Deployment` Kubernetes object.

Expand Down Expand Up @@ -147,4 +144,4 @@ spec:
[role="_additional-resources"]
.Additional resources

* To learn more about merging, see link:https://github.com/kubernetes/community/blob/master/contributors/devel/sig-api-machinery/strategic-merge-patch.md#basic-patch-format[Strategic Merge Patch].
* To learn more about merging, see link:https://github.com/kubernetes/community/blob/master/contributors/devel/sig-api-machinery/strategic-merge-patch.md#basic-patch-format[Strategic Merge Patch].
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Module included in the following assemblies:
// assembly-customize-rhdh-theme.adoc
// assembly-customizing-rhdh-appearance.adoc
//restored module as per slack thread: https://redhat-internal.slack.com/archives/C04CUSD4JSG/p1726856912238529

[id="proc-customize-rhdh-branding-logo_{context}"]
Expand Down
2 changes: 1 addition & 1 deletion modules/customization/proc-customize-rhdh-font.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Module included in the following assemblies:
// assembly-customize-rhdh-theme.adoc
// assembly-customizing-rhdh-appearance.adoc

[id="proc-customize-rhdh-font_{context}"]
= Customizing the font for your {product-short} instance
Expand Down
2 changes: 1 addition & 1 deletion modules/customization/proc-customize-rhdh-page-theme.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Module included in the following assemblies:
// assembly-customize-rhdh-theme.adoc
// assembly-customizing-rhdh-appearance.adoc

[id="proc-customize-rhdh-page-theme_{context}"]
= Customizing the page theme header for your {product-short} instance
Expand Down
2 changes: 1 addition & 1 deletion modules/customization/proc-customize-rhdh-palette.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Module included in the following assemblies:
// assembly-customize-rhdh-theme.adoc
// assembly-customizing-rhdh-appearance.adoc

[id="proc-customize-rhdh-branding_{context}"]
= Customizing the theme mode color palettes for your {product-short} instance
Expand Down
2 changes: 1 addition & 1 deletion modules/customization/proc-customize-rhdh-tab-tooltip.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Module included in the following assemblies:
// assembly-customize-rhdh-theme.adoc
// assembly-customizing-rhdh-appearance.adoc

[id="proc-customizing-rhdh-tab-tooltip_{context}"]
= Customizing the application title for your {product-short} instance
Expand Down
2 changes: 1 addition & 1 deletion modules/customization/proc-customize-rhdh-theme-mode.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Module included in the following assemblies:
// assembly-customize-rhdh-theme.adoc
// assembly-customizing-rhdh-appearance.adoc

[id="proc-customizing-rhdh-theme-mode_{context}"]
= Customizing the theme mode for your {product-short} instance
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Module included in the following assemblies:
// assembly-customize-rhdh-theme.adoc
// assembly-customizing-rhdh-appearance.adoc

[id="ref-customize-rhdh-custom-components_{context}"]
= Custom component options for your {product-short} instance
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Module included in the following assemblies:
// assembly-customize-rhdh-theme.adoc
// assembly-customizing-rhdh-appearance.adoc

[id="ref-customize-rhdh-default-backstage_{context}"]
= Default Backstage theme
Expand Down
2 changes: 1 addition & 1 deletion modules/customization/ref-customize-rhdh-default-rhdh.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Module included in the following assemblies:
// assembly-customize-rhdh-theme.adoc
// assembly-customizing-rhdh-appearance.adoc

[id="ref-customize-rhdh-default-rhdh_{context}"]
= Default {product} theme
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ In {product}, you can configure Learning Paths by passing the data into the `app
====
Due to the use of overlapping `pathRewrites` for both the `learning-path` and `homepage` quick access proxies, you must create the `learning-paths` configuration (`^api/proxy/developer-hub/learning-paths`) before you create the `homepage` configuration (`^/api/proxy/developer-hub`).

For more information about customizing the Home page in {product}, see xref:proc-customize-rhdh-homepage_rhdh-getting-started[Customizing the Home page in {product}].
For more information about customizing the Home page in {product}, see xref:proc-customize-rhdh-homepage[Customizing the Home page in {product}].
====

You can provide data to the Learning Path from the following sources:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ In {product}, you can configure Learning Paths by passing the data into the `app
====
Due to the use of overlapping `pathRewrites` for both the `tech-radar` and `homepage` quick access proxies, you must create the `tech-radar` configuration (`^api/proxy/developer-hub/tech-radar`) before you create the `homepage` configuration (`^/api/proxy/developer-hub`).

For more information about customizing the Home page in {product}, see xref:proc-customize-rhdh-homepage_rhdh-getting-started[Customizing the Home page in {product}].
For more information about customizing the Home page in {product}, see xref:proc-customize-rhdh-homepage[Customizing the Home page in {product}].
====

You can provide data to the Tech Radar page from the following sources:
Expand Down
2 changes: 1 addition & 1 deletion modules/templates/proc-adding-templates.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module included in the following assemblies:
//
// * assemblies/assembly-admin-templates.adoc
// * assemblies/assembly-configuring-templates.adoc

:_mod-docs-content-type: PROCEDURE
[id="proc-adding-templates_{context}"]
Expand Down
2 changes: 1 addition & 1 deletion modules/templates/proc-creating-templates.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module included in the following assemblies:
//
// * assemblies/assembly-admin-templates.adoc
// * assemblies/assembly-configuring-templates.adoc

:_mod-docs-content-type: PROCEDURE
[id="proc-creating-templates_{context}"]
Expand Down
2 changes: 1 addition & 1 deletion modules/templates/ref-creating-templates.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module included in the following assemblies:
//
// * assemblies/assembly-admin-templates.adoc
// * assemblies/assembly-configuring-templates.adoc

:_mod-docs-content-type: REFERENCE
[id="ref-creating-templates_{context}"]
Expand Down
12 changes: 0 additions & 12 deletions titles/admin-rhdh/docinfo.xml

This file was deleted.

1 change: 0 additions & 1 deletion titles/admin-rhdh/master.adoc

This file was deleted.

47 changes: 0 additions & 47 deletions titles/admin-rhdh/title-admin.adoc

This file was deleted.

Loading
Loading