Skip to content

RHIDP-4929 /RHIDP-4930 Moving content to Configuring and Customizing … #798

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 16, 2024
Merged

RHIDP-4929 /RHIDP-4930 Moving content to Configuring and Customizing … #798

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 27 additions & 5 deletions artifacts/attributes.adoc
View file
Open in desktop
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 All @@ -14,10 +14,18 @@
:product-bundle-version: 1.4.0
:product-chart-version: 1.4.0
:product-backstage-version: 1.29.2
:product-custom-resource-type: Backstage
:rhdeveloper-name: Red Hat Developer
:rhel: Red Hat Enterprise Linux
:odf-name: OpenShift Data Foundation

:my-app-config-config-map: my-rhdh-app-config
:my-app-config-file: app-config.yaml
:my-product-cr-name: my-rhdh-custom-resource
:my-product-namespace: my-rhdh-project
:my-product-secrets: my-rhdh-secrets
:my-product-database-certificates-secrets: my-rhdh-database-certificates-secrets
:my-product-database-secrets: my-rhdh-database-secrets
:my-product-url: https://__<my_developer_hub_url>__

// Red Hat Platforms
Expand All @@ -29,8 +37,9 @@
:logging-brand-name: Red Hat OpenShift Logging
:logging-short: OpenShift Logging
// minimum and current latest supported versions
:ocp-version-min: 4.14
:ocp-version-min: 4.16
:ocp-version: 4.17
:kubernetes-version: 1.24
// First mention of OpenShift CLI or `oc` in a module
:openshift-cli: pass:quotes[OpenShift CLI (`oc`)]
:rhsso-brand-name: Red Hat Single-Sign On
Expand Down Expand Up @@ -71,10 +80,7 @@
:ug-product-title: Red Hat Developer Hub User Guide

// Links
:LinkAdminGuide: https://access.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/administration_guide_for_red_hat_developer_hub/index
:NameOfAdminGuide: Administration guide for {product}

:LinkGettingStartedGuide: https://access.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/getting_started_with_red_hat_developer_hub/index

:LinkPluginsGuide: https://access.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/configuring_plugins_in_red_hat_developer_hub/index
:NameOfPluginsGuide: Configuring plugins in {product}
Expand All @@ -91,6 +97,12 @@
:authorization-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/authorization/index
:authorization-book-title: Authorization

:configuring-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/configuring/index
:configuring-book-title: Configuring

:customizing-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/customizing/index
:customizing-book-title: Customizing

:installing-on-osd-on-gcp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_openshift_dedicated_on_google_cloud_platform/index
:installing-on-osd-on-gcp-book-title: Installing {product} on {gcp-brand-name} on {gcp-brand-name}

Expand All @@ -112,5 +124,15 @@
:upgrading-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/upgrading_red_hat_developer_hub/index
:upgrading-book-title: Upgrading {product}

:telemetry-data-collection-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/telemetry_data_collection/index
:telemetry-data-collection-book-title: Telemetry data collection

:audit-log-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/audit_log/index
:audit-log-book-title: Audit log

:monitoring-and-logging-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/monitoring_and_logging/index
:monitoring-and-logging-book-title: Monitoring and logging

:plugins-configure-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/configuring_dynamic_plugins/index
:plugins-configure-book-title: Configuring dynamic plugins

11 changes: 11 additions & 0 deletions artifacts/docinfo.xml
View file
Open in desktop
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
View file
Open in desktop

This file was deleted.

15 changes: 10 additions & 5 deletions ...assembly-running-rhdh-behind-a-proxy.adoc → assemblies/assembly-configuring-a-proxy.adoc
View file
Open in desktop
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,7 +12,8 @@ You can run the {product-very-short} application behind a corporate proxy by set

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.

include::modules/admin/procedure-understanding-no-proxy.adoc[leveloffset=+1]
include::modules/configuring-a-proxy/proc-configuring-proxy-in-operator-deployment.adoc[leveloffset=+1]


include::modules/configuring-a-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]
12 changes: 8 additions & 4 deletions assemblies/assembly-configuring-external-postgresql-databases.adoc
View file
Open in desktop
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/configuring-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/configuring-external-databases/proc-configuring-postgresql-instance-using-helm.adoc[leveloffset=+1]


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

39 changes: 24 additions & 15 deletions assemblies/assembly-techdocs-plugin.adoc → ...mblies/assembly-configuring-techdocs.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
:_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 Expand Up @@ -35,24 +36,32 @@ After you configure {odf-name} to store the files that TechDocs generates, you c

* For more information, see link:{LinkPluginsGuide}[Configuring plugins in {product}].

//Configuring storage
include::modules/getting-started/con-techdocs-configure-storage.adoc[leveloffset=+1]
include::modules/customizing-techdocs/con-techdocs-configure-storage.adoc[leveloffset=+1]

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

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

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

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

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

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

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

include::modules/getting-started/proc-techdocs-generate-site.adoc[leveloffset=+2]
include::modules/customizing-techdocs/proc-techdocs-configure-odf-operator.adoc[leveloffset=+2]


include::modules/customizing-techdocs/ref-techdocs-example-config-plugin-operator.adoc[leveloffset=+3]


include::modules/customizing-techdocs/con-techdocs-config-cicd.adoc[leveloffset=+1]


include::modules/customizing-techdocs/proc-techdocs-config-cicd-prep-repo.adoc[leveloffset=+2]


include::modules/customizing-techdocs/proc-techdocs-generate-site.adoc[leveloffset=+2]


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

include::modules/getting-started/proc-techdocs-publish-site.adoc[leveloffset=+2]
16 changes: 7 additions & 9 deletions assemblies/assembly-admin-templates.adoc → ...blies/assembly-configuring-templates.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,22 @@
:_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]
include::modules/customizing-templates/proc-creating-templates.adoc[leveloffset=+1]
include::modules/customizing-templates/ref-creating-templates.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
* link:https://backstage.io/docs/features/software-templates/writing-templates[Backstage documentation - Writing Templates]
* link:https://backstage.io/docs/features/software-templates/builtin-actions[Backstage documentation - Builtin actions]
* link:https://backstage.io/docs/features/software-templates/writing-custom-actions[Backstage documentation - Writing Custom Actions]

include::modules/templates/proc-adding-templates.adoc[leveloffset=+1]
include::modules/customizing-templates/proc-adding-templates.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
Expand Down
42 changes: 0 additions & 42 deletions assemblies/assembly-customize-rhdh-theme.adoc
View file
Open in desktop

This file was deleted.

47 changes: 47 additions & 0 deletions assemblies/assembly-customizing-the-appearance.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
:_mod-docs-content-type: ASSEMBLY
:context: customizing-appearance
[id="{context}"]
= Customizing {product} appearance

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

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}[]

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}[]

Check failure on line 10 in assemblies/assembly-customizing-the-appearance.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[DeveloperHub.Attributes] Use the AsciiDoc attribute '{product}' rather than 'Backstage'.

Raw Output:
{"message": "[DeveloperHub.Attributes] Use the AsciiDoc attribute '{product}' rather than 'Backstage'.", "location": {"path": "assemblies/assembly-customizing-the-appearance.adoc", "range": {"start": {"line": 10, "column": 5}}}, "severity": "ERROR"}

Check failure on line 10 in assemblies/assembly-customizing-the-appearance.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[DeveloperHub.Attributes] Use the AsciiDoc attribute '{product}' rather than 'Backstage'.

Raw Output:
{"message": "[DeveloperHub.Attributes] Use the AsciiDoc attribute '{product}' rather than 'Backstage'.", "location": {"path": "assemblies/assembly-customizing-the-appearance.adoc", "range": {"start": {"line": 10, "column": 103}}}, "severity": "ERROR"}

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 `app-config-rhdh.yaml` file, you can customize common theme components, including the following:

* Company name and logo
* Font color, size, and style of text in paragraphs, headings, headers, and buttons
* Header color, gradient, and shape
* Button color
* Navigation indicator color

You can also customize some components from the {product-short} GUI, such as the theme mode (*Light Theme*, *Dark Theme*, or *Auto*).

include::modules/customizing-the-appearance/proc-customize-rhdh-theme-mode.adoc[leveloffset=+1]


include::modules/customizing-the-appearance/proc-customize-rhdh-branding-logo.adoc[leveloffset=+1]


include::modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc[leveloffset=+1]


include::modules/customizing-the-appearance/proc-customize-rhdh-palette.adoc[leveloffset=+1]


include::modules/customizing-the-appearance/proc-customize-rhdh-page-theme.adoc[leveloffset=+1]


include::modules/customizing-the-appearance/proc-customize-rhdh-font.adoc[leveloffset=+1]


include::modules/customizing-the-appearance/ref-customize-rhdh-default-rhdh.adoc[leveloffset=+1]


include::modules/customizing-the-appearance/ref-customize-rhdh-default-backstage.adoc[leveloffset=+1]


include::modules/customizing-the-appearance/ref-customize-rhdh-custom-components.adoc[leveloffset=+1]

13 changes: 9 additions & 4 deletions ...sembly-customizing-the-rhdh-homepage.adoc → ...es/assembly-customizing-the-homepage.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
[id='proc-customize-rhdh-homepage_{context}']
= Customizing the Home page in {product}
:_mod-docs-content-type: ASSEMBLY
:context: customizing-the-home-page
[id="{context}"]
= Customizing the Home page

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

Expand All @@ -15,5 +17,8 @@ When using the `app-config`, you can do the following:
** Catalog starred entities
** 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/customizing-the-home-page/proc-customizing-the-home-page-cards.adoc[leveloffset=+1]


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

10 changes: 5 additions & 5 deletions ...mizing-the-quick-access-card-in-rhdh.adoc → ...ly-customizing-the-quick-access-card.adoc
View file
Open in desktop
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-the-quick-access-card
[id="{context}"]
= Customizing the 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/customizing-the-quick-access-card/proc-using-hosted-json-files-to-provide-data-to-the-quick-access-card.adoc[leveloffset=+1]


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

Loading
Loading