Skip to content
Merged
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
1 change: 0 additions & 1 deletion .asciidoctorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ include::{asciidoctorconfigdir}/artifacts/attributes.adoc[]
:chapter-signifier: Chapter
:docinfo: shared
:docinfodir: {asciidoctorconfigdir}/.asciidoctor
:doctype: book
:sectnumlevels: 5
:sectnums:
:source-highlighter: coderay
Expand Down
1 change: 1 addition & 0 deletions artifacts/attributes.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
:red-hat-developers-documentation:
:imagesdir:
:idseparator: -
:doctype: article

// Company names
:company-name: Red Hat
Expand Down
1 change: 1 addition & 0 deletions assemblies/assembly-about-rhdh.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,4 @@ Use {product} to simplify decision-making through a selection of internally appr
include::modules/about/con-benefits-of-rhdh.adoc[leveloffset=+1]
include::modules/about/ref-supported-platforms.adoc[leveloffset=+1]
include::modules/about/ref-rhdh-sizing.adoc[leveloffset=+1]
include::modules/about/ref-customer-support-info.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
[preface]
[id='snip-customer-support-info_{context}']
[id="ref-customer-support-info_{context}"]
= Red Hat Developer Hub support

If you experience difficulty with a procedure described in this documentation, visit the http://access.redhat.com[Red Hat Customer Portal]. You can use the Red Hat Customer Portal for the following purposes:

* To search or browse through the Red Hat Knowledgebase of technical support articles about Red Hat products.
* To create a https://access.redhat.com/support/cases/#/case/new/get-support?caseCreate=true[support case] for {company-name} Global Support Services (GSS). For support case creation, select *{product}* as the product and select the appropriate product version. For detailed information about supported platforms, see link:{release-notes-url}#con-release-notes-overview.adoc[Supported Platforms] and the link:https://access.redhat.com/support/policy/updates/developerhub[{product} Life Cycle].
* To search or browse through the Red Hat Knowledgebase of technical support articles about Red Hat products.
* To create a https://access.redhat.com/support/cases/#/case/new/get-support?caseCreate=true[support case] for {company-name} Global Support Services (GSS). For support case creation, select *{product}* as the product and select the appropriate product version. For detailed information about supported platforms, see link:{release-notes-url}#con-release-notes-overview.adoc[Supported Platforms] and the link:https://access.redhat.com/support/policy/updates/developerhub[{product} Life Cycle].
3 changes: 1 addition & 2 deletions titles/about/master.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
[id="title-about_red_hat_developer_hub"]
include::artifacts/attributes.adoc[]
= About {product}
:doctype: book
:imagesdir: images
:title: About {product}
:subtitle: Introduction to {product}
Expand All @@ -13,4 +12,4 @@ include::artifacts/attributes.adoc[]
//{abstract}


include::assemblies/assembly-about-rhdh.adoc[]
include::assemblies/assembly-about-rhdh.adoc[]
6 changes: 1 addition & 5 deletions titles/admin-rhdh/title-admin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,10 @@
include::artifacts/attributes.adoc[]
= Administration guide for {product}
:context: admin-rhdh
:doctype: book
:imagesdir: images

{product} is an enterprise-grade, open developer platform that you can use to build developer portals. This platform contains a supported and opinionated framework that helps reduce the friction and frustration of developers while boosting their productivity.

//customer support links
include::artifacts/snip-customer-support-info.adoc[]

//add a custom application config file to OCP
include::assemblies/assembly-add-custom-app-file-openshift.adoc[leveloffset=+1]

Expand Down Expand Up @@ -44,4 +40,4 @@ include::assemblies/assembly-admin-templates.adoc[leveloffset=+1]
include::assemblies/assembly-techdocs-plugin.adoc[leveloffset=+1]

// RHDH Operator deployment
include::modules//admin/proc-rhdh-deployment-config.adoc[leveloffset=+1]
include::modules//admin/proc-rhdh-deployment-config.adoc[leveloffset=+1]
3 changes: 1 addition & 2 deletions titles/audit-log/master.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
include::artifacts/attributes.adoc[]
:context: title-audit-log
:doctype: book
:imagesdir: images
:title: Audit log
:subtitle: Tracking user activities, system events, and data changes with {product} audit logs
Expand All @@ -9,4 +8,4 @@ include::artifacts/attributes.adoc[]
= {title}

// Audit logging
include::assemblies/assembly-audit-log.adoc[leveloffset=+1]
include::assemblies/assembly-audit-log.adoc[leveloffset=+1]
1 change: 0 additions & 1 deletion titles/authentication/master.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
include::artifacts/attributes.adoc[]
:context: title-authentication
:doctype: book
:imagesdir: images
:title: Authentication
:subtitle: Configuring authentication to external services in {product}
Expand Down
1 change: 0 additions & 1 deletion titles/authorization/master.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
include::artifacts/attributes.adoc[]
:context: title-authorization
:doctype: book
:imagesdir: images
:title: Authorization
:subtitle: Configuring authorization by using role based access control (RBAC) in {product}
Expand Down
4 changes: 0 additions & 4 deletions titles/getting-started-rhdh/title-getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,10 @@
include::artifacts/attributes.adoc[]
= Getting started with {product}
:context: rhdh-getting-started
:doctype: book
:imagesdir: images

As a developer, you can use {product} to experience a streamlined development environment. {product} is driven by a centralized software catalog, providing efficiency to your microservices and infrastructure. It enables your product team to deliver quality code without any compromises.

//customer support links
include::artifacts/snip-customer-support-info.adoc[]

// supported configs and customization
include::modules/getting-started/ref-rhdh-supported-configs.adoc[leveloffset=+1]
include::assemblies/assembly-add-custom-app-file-openshift.adoc[leveloffset=+2]
Expand Down
1 change: 0 additions & 1 deletion titles/install-rhdh-air-gapped/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
include::artifacts/attributes.adoc[]
= Installing {product} in an air-gapped environment
:context: title-install-rhdh-air-grapped
:doctype: book
:imagesdir: images

include::modules/installation/con-airgapped-environment.adoc[leveloffset=+1]
Expand Down
1 change: 0 additions & 1 deletion titles/install-rhdh-aks/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
include::artifacts/attributes.adoc[]
= Installing {product} on {aks-brand-name}
:context: title-install-rhdh-aks
:doctype: book
:imagesdir: images

// aks deployment
Expand Down
1 change: 0 additions & 1 deletion titles/install-rhdh-eks/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
include::artifacts/attributes.adoc[]
= Installing {product} on {eks-brand-name}
:context: title-install-rhdh-eks
:doctype: book
:imagesdir: images

// aws eks deployment
Expand Down
3 changes: 1 addition & 2 deletions titles/install-rhdh-gke/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
include::artifacts/attributes.adoc[]
= Installing {product} on {gke-brand-name}
:context: title-install-rhdh-gke
:doctype: book
:imagesdir: images

// Google gke deployment - is this required for 1.4 release [TBC]
Expand All @@ -19,4 +18,4 @@ include::modules/installation/proc-rhdh-deploy-gke-operator.adoc[leveloffset=+1]
include::modules/installation/proc-deploy-rhdh-instance-gke.adoc[leveloffset=+2]

// Helm chart method
include::modules/installation/proc-rhdh-deploy-gke-helm.adoc[leveloffset=+1]
include::modules/installation/proc-rhdh-deploy-gke-helm.adoc[leveloffset=+1]
3 changes: 1 addition & 2 deletions titles/install-rhdh-ocp/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
include::artifacts/attributes.adoc[]
= Installing {product} on {ocp-short}
:context: title-install-rhdh-ocp
:doctype: book
:imagesdir: images

// ocp deployment
Expand Down Expand Up @@ -36,4 +35,4 @@ Use the installation method that best meets your needs and preferences.
include::assemblies/assembly-install-rhdh-ocp-operator.adoc[leveloffset=+1]

// Helm chart method
include::assemblies/assembly-install-rhdh-ocp-helm.adoc[leveloffset=+1]
include::assemblies/assembly-install-rhdh-ocp-helm.adoc[leveloffset=+1]
1 change: 0 additions & 1 deletion titles/install-rhdh-osd-gcp/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
include::artifacts/attributes.adoc[]
= Installing {product} on {osd-short} on {gcp-brand-name}
:context: title-install-rhdh-osd-gcp
:doctype: book
:imagesdir: images

You can install {product-short} on {osd-short} on {gcp-brand-name} ({gcp-short}) using one of the following methods:
Expand Down
1 change: 0 additions & 1 deletion titles/monitoring-and-logging/master.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
include::artifacts/attributes.adoc[]
:context: title-monitoring-logging
:doctype: book
:imagesdir: images
:title: Monitoring and logging
:subtitle: Tracking performance and capturing insights with monitoring and logging tools in {product}
Expand Down
4 changes: 0 additions & 4 deletions titles/plugin-rhdh/title-plugin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,10 @@
include::artifacts/attributes.adoc[]
= Configuring plugins in {product}
:context: plugin-rhdh
:doctype: book
:imagesdir: images

The {product} is an enterprise-grade, integrated developer platform, extended through plugins, that helps reduce the friction and frustration of developers while boosting their productivity.

//customer support links
include::artifacts/snip-customer-support-info.adoc[]

//overview
include::modules/con-rhdh-plugins.adoc[leveloffset=+1]

Expand Down
3 changes: 1 addition & 2 deletions titles/plugins-rhdh-about/master.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
[id="title-plugins-rhdh-about"]
include::artifacts/attributes.adoc[]
:context: title-plugins-rhdh-about
:doctype: book
:imagesdir: images
:title: Introduction to plugins
:subtitle: Introduction to {product-very-short} plugins
:abstract: As a {product} user, you can learn about {product} plugins.

= Introduction to plugins
include::modules/dynamic-plugins/con-rhdh-plugins.adoc[leveloffset=+1]
include::modules/dynamic-plugins/con-rhdh-plugins.adoc[leveloffset=+1]
3 changes: 1 addition & 2 deletions titles/plugins-rhdh-configure/master.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
include::artifacts/attributes.adoc[]
:context: title-plugins-rhdh-configure
:doctype: book
:imagesdir: images

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

include::assemblies/dynamic-plugins/assembly-configuring-rhdh-plugins.adoc[]
include::assemblies/dynamic-plugins/assembly-configuring-rhdh-plugins.adoc[]
3 changes: 1 addition & 2 deletions titles/plugins-rhdh-install/master.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
include::artifacts/attributes.adoc[]
:context: title-plugins-rhdh-about
:doctype: book
:imagesdir: images

:title: Installing and viewing dynamic plugins
:subtitle: Installing dynamic plugins
:abstract: Administrative users can install and configure plugins to enable other users to use plugins to extend {product-very-short} functionality.

include::assemblies/dynamic-plugins/assembly-installing-rhdh-plugins.adoc[]
include::assemblies/dynamic-plugins/assembly-installing-rhdh-plugins.adoc[]
3 changes: 1 addition & 2 deletions titles/plugins-rhdh-reference/master.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
include::artifacts/attributes.adoc[]
:context: title-plugins-rhdh-about
:doctype: book
:imagesdir: images

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

include::assemblies/dynamic-plugins/assembly-rhdh-installing-dynamic-plugins.adoc[]
include::assemblies/dynamic-plugins/assembly-rhdh-installing-dynamic-plugins.adoc[]
3 changes: 1 addition & 2 deletions titles/plugins-rhdh-troubleshooting/master.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
include::artifacts/attributes.adoc[]
:context: title-plugins-rhdh-about
:doctype: book
:imagesdir: images
:title: Troubleshooting {product} plugins
:subtitle: Troubleshooting {product-very-short} plugins
Expand All @@ -10,4 +9,4 @@ include::artifacts/attributes.adoc[]

//{abstract}

include::assemblies/dynamic-plugins/assembly-troubleshooting-rhdh-plugins.adoc[]
include::assemblies/dynamic-plugins/assembly-troubleshooting-rhdh-plugins.adoc[]
3 changes: 1 addition & 2 deletions titles/plugins-rhdh-using/master.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
include::artifacts/attributes.adoc[]
:context: title-plugins-rhdh-using
:doctype: book
:imagesdir: images
:title: Using dynamic plugins
:subtitle: Using {product-very-short} plugins as an end-user
Expand All @@ -10,4 +9,4 @@ include::artifacts/attributes.adoc[]

//{abstract}

include::assemblies/dynamic-plugins/assembly-using-rhdh-plugins.adoc[]
include::assemblies/dynamic-plugins/assembly-using-rhdh-plugins.adoc[]
4 changes: 0 additions & 4 deletions titles/rel-notes-rhdh/title-rhdh-release-notes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,10 @@ include::artifacts/attributes.adoc[]
:subtitle: Release notes for {product} {product-version}
= {title}: {subtitle}
:context: release-notes-rhdh
:doctype: book
:imagesdir: images

{product} ({product-short}) {product-version} is now generally available. {product-short} is a fully supported, enterprise-grade productized version of upstream Backstage v{product-backstage-version}. You can access and download the {product} application from the {company-name} https://access.redhat.com/downloads[Customer Portal] or from the https://catalog.redhat.com/search?gs&q=rhdh&searchType=containers[Ecosystem Catalog].

//customer support links
include::artifacts/snip-customer-support-info.adoc[]

include::assemblies/assembly-release-notes-new-features.adoc[leveloffset=+1]


Expand Down
3 changes: 1 addition & 2 deletions titles/telemetry/master.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
include::artifacts/attributes.adoc[]
:context: title-telemetry
:doctype: book
:imagesdir: images
:title: Telemetry data collection
:subtitle: Collecting and analyzing telemetry data to enhance {product} experience
Expand All @@ -9,4 +8,4 @@ include::artifacts/attributes.adoc[]
= {title}

//Telemetry data collection
include::assemblies/assembly-rhdh-telemetry.adoc[leveloffset=+1]
include::assemblies/assembly-rhdh-telemetry.adoc[leveloffset=+1]
1 change: 0 additions & 1 deletion titles/upgrade-rhdh/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
include::artifacts/attributes.adoc[]
= Upgrading {product}
:context: title-upgrade-rhdh
:doctype: book
:imagesdir: images

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