diff --git a/artifacts/attributes.adoc b/artifacts/attributes.adoc index 689ba1f013..7a181750f0 100644 --- a/artifacts/attributes.adoc +++ b/artifacts/attributes.adoc @@ -1,5 +1,5 @@ :red-hat-developers-documentation: -:imagesdir: +:imagesdir: images :idseparator: - // Company names diff --git a/artifacts/docinfo.xml b/artifacts/docinfo.xml new file mode 100644 index 0000000000..35491c93fe --- /dev/null +++ b/artifacts/docinfo.xml @@ -0,0 +1,11 @@ +{title} +{product} +{product-version} +{subtitle} + +{abstract} + + +{company-name} Customer Content Services + + diff --git a/assemblies/assembly-add-custom-app-file-openshift.adoc b/assemblies/assembly-add-custom-app-file-openshift.adoc deleted file mode 100644 index 21978f413c..0000000000 --- a/assemblies/assembly-add-custom-app-file-openshift.adoc +++ /dev/null @@ -1,25 +0,0 @@ -[id='assembly-add-custom-app-file-openshift_{context}'] -= Adding a custom application configuration file to {ocp-brand-name} - -To access the {product}, you must add a custom application configuration file to {ocp-brand-name}. In {ocp-short}, you can use the following content as a base template to create a ConfigMap named `app-config-rhdh`: - -[source,yaml,subs="attributes+"] ----- -kind: ConfigMap -apiVersion: v1 -metadata: - name: app-config-rhdh -data: - app-config-rhdh.yaml: | - app: - title: {product} ----- - -You can add the custom application configuration file to {ocp-short} in one of the following ways: - -* The {product} Operator -* The {product} Helm chart - -include::modules/getting-started/proc-add-custom-app-file-openshift-helm.adoc[leveloffset=+1] - -include::modules/installation/proc-add-custom-app-config-file-ocp-operator.adoc[leveloffset=+1] diff --git a/assemblies/assembly-adding-custom-configuration-files.adoc b/assemblies/assembly-adding-custom-configuration-files.adoc new file mode 100644 index 0000000000..a030264b6e --- /dev/null +++ b/assemblies/assembly-adding-custom-configuration-files.adoc @@ -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] + diff --git a/assemblies/assembly-configuring-external-postgresql-databases.adoc b/assemblies/assembly-configuring-external-postgresql-databases.adoc index 031c46efc9..77bd6cef10 100644 --- a/assemblies/assembly-configuring-external-postgresql-databases.adoc +++ b/assemblies/assembly-configuring-external-postgresql-databases.adoc @@ -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. @@ -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] diff --git a/assemblies/assembly-techdocs-plugin.adoc b/assemblies/assembly-configuring-techdocs.adoc similarity index 92% rename from assemblies/assembly-techdocs-plugin.adoc rename to assemblies/assembly-configuring-techdocs.adoc index bf2122abdd..b3df50a9e9 100644 --- a/assemblies/assembly-techdocs-plugin.adoc +++ b/assemblies/assembly-configuring-techdocs.adoc @@ -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. diff --git a/assemblies/assembly-admin-templates.adoc b/assemblies/assembly-configuring-templates.adoc similarity index 78% rename from assemblies/assembly-admin-templates.adoc rename to assemblies/assembly-configuring-templates.adoc index e200a047a5..2365c13a7f 100644 --- a/assemblies/assembly-admin-templates.adoc +++ b/assemblies/assembly-configuring-templates.adoc @@ -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] diff --git a/assemblies/assembly-customize-rhdh-theme.adoc b/assemblies/assembly-customizing-rhdh-appearance.adoc similarity index 94% rename from assemblies/assembly-customize-rhdh-theme.adoc rename to assemblies/assembly-customizing-rhdh-appearance.adoc index 37c87a0669..b94165c5a7 100644 --- a/assemblies/assembly-customize-rhdh-theme.adoc +++ b/assemblies/assembly-customizing-rhdh-appearance.adoc @@ -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}: diff --git a/assemblies/assembly-customizing-the-quick-access-card-in-rhdh.adoc b/assemblies/assembly-customizing-the-quick-access-card-in-rhdh.adoc index b94046361b..625b992011 100644 --- a/assemblies/assembly-customizing-the-quick-access-card-in-rhdh.adoc +++ b/assemblies/assembly-customizing-the-quick-access-card-in-rhdh.adoc @@ -1,7 +1,7 @@ :_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: @@ -9,7 +9,7 @@ To access the Home page in {product}, the base URL must include the `/developer- * 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] diff --git a/assemblies/assembly-customizing-the-rhdh-homepage.adoc b/assemblies/assembly-customizing-the-rhdh-homepage.adoc index 9c760feec2..2a5cf86bec 100644 --- a/assemblies/assembly-customizing-the-rhdh-homepage.adoc +++ b/assemblies/assembly-customizing-the-rhdh-homepage.adoc @@ -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: @@ -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] \ No newline at end of file +include::modules/getting-started/proc-defining-the-layout-of-the-product-home-page.adoc[leveloffset=+1] diff --git a/assemblies/assembly-rhdh-integration-aws.adoc b/assemblies/assembly-rhdh-integration-aws.adoc deleted file mode 100644 index 4177ff7010..0000000000 --- a/assemblies/assembly-rhdh-integration-aws.adoc +++ /dev/null @@ -1,16 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -[id="assembly-rhdh-integration-aws"] -= {product} integration with {aws-brand-name} ({aws-short}) -:context: assembly-rhdh-integration-aws - -toc::[] - -You can integrate your {product} application with {aws-brand-name} ({aws-short}), which can help you streamline your workflows within the {aws-short} ecosystem. Integrating the {product-short} resources with {aws-short} provides access to a comprehensive suite of tools, services, and solutions. - -The integration with {aws-short} requires the deployment of {product-short} in {eks-name} (EKS) using one of the following methods: - -* The Helm chart -* The {product} Operator - -//include::modules/admin/proc-rhdh-monitoring-logging-aws.adoc[leveloffset=+1]// moving observe category related content to new titles: RHIDP-4814 - diff --git a/assemblies/assembly-running-rhdh-behind-a-proxy.adoc b/assemblies/assembly-running-behind-a-proxy.adoc similarity index 60% rename from assemblies/assembly-running-rhdh-behind-a-proxy.adoc rename to assemblies/assembly-running-behind-a-proxy.adoc index d6a895a280..3dc5882bad 100644 --- a/assemblies/assembly-running-rhdh-behind-a-proxy.adoc +++ b/assemblies/assembly-running-behind-a-proxy.adoc @@ -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: @@ -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] diff --git a/modules/getting-started/proc-add-custom-app-file-openshift-helm.adoc b/modules/adding-custom-configuration-files/proc-adding-custom-configuration-files-by-using-helm.adoc similarity index 94% rename from modules/getting-started/proc-add-custom-app-file-openshift-helm.adoc rename to modules/adding-custom-configuration-files/proc-adding-custom-configuration-files-by-using-helm.adoc index 6fbed3a951..421d49c56e 100644 --- a/modules/getting-started/proc-add-custom-app-file-openshift-helm.adoc +++ b/modules/adding-custom-configuration-files/proc-adding-custom-configuration-files-by-using-helm.adoc @@ -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. diff --git a/modules/installation/proc-add-custom-app-config-file-ocp-operator.adoc b/modules/adding-custom-configuration-files/proc-adding-custom-configuration-files-by-using-the-operator.adoc similarity index 98% rename from modules/installation/proc-add-custom-app-config-file-ocp-operator.adoc rename to modules/adding-custom-configuration-files/proc-adding-custom-configuration-files-by-using-the-operator.adoc index a4b4c92bf0..e2d9d295ca 100644 --- a/modules/installation/proc-add-custom-app-config-file-ocp-operator.adoc +++ b/modules/adding-custom-configuration-files/proc-adding-custom-configuration-files-by-using-the-operator.adoc @@ -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). diff --git a/modules/admin/proc-rhdh-deployment-config.adoc b/modules/configuring-deployment/proc-configuring-deployment-by-using-the-operator.adoc similarity index 97% rename from modules/admin/proc-rhdh-deployment-config.adoc rename to modules/configuring-deployment/proc-configuring-deployment-by-using-the-operator.adoc index 47b44e98b0..697df9a2bc 100644 --- a/modules/admin/proc-rhdh-deployment-config.adoc +++ b/modules/configuring-deployment/proc-configuring-deployment-by-using-the-operator.adoc @@ -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. @@ -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]. \ No newline at end of file +* 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]. diff --git a/modules/customization/proc-customize-rhdh-branding-logo.adoc b/modules/customization/proc-customize-rhdh-branding-logo.adoc index 3f7fff0073..ead10d956f 100644 --- a/modules/customization/proc-customize-rhdh-branding-logo.adoc +++ b/modules/customization/proc-customize-rhdh-branding-logo.adoc @@ -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}"] diff --git a/modules/customization/proc-customize-rhdh-font.adoc b/modules/customization/proc-customize-rhdh-font.adoc index 9ba0c69e82..eff5e66032 100644 --- a/modules/customization/proc-customize-rhdh-font.adoc +++ b/modules/customization/proc-customize-rhdh-font.adoc @@ -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 diff --git a/modules/customization/proc-customize-rhdh-page-theme.adoc b/modules/customization/proc-customize-rhdh-page-theme.adoc index 45e17866d5..46698a2134 100644 --- a/modules/customization/proc-customize-rhdh-page-theme.adoc +++ b/modules/customization/proc-customize-rhdh-page-theme.adoc @@ -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 diff --git a/modules/customization/proc-customize-rhdh-palette.adoc b/modules/customization/proc-customize-rhdh-palette.adoc index 20f3b418d7..80221db1e0 100644 --- a/modules/customization/proc-customize-rhdh-palette.adoc +++ b/modules/customization/proc-customize-rhdh-palette.adoc @@ -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 diff --git a/modules/customization/proc-customize-rhdh-tab-tooltip.adoc b/modules/customization/proc-customize-rhdh-tab-tooltip.adoc index 66de517a91..630edf24e9 100644 --- a/modules/customization/proc-customize-rhdh-tab-tooltip.adoc +++ b/modules/customization/proc-customize-rhdh-tab-tooltip.adoc @@ -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 diff --git a/modules/customization/proc-customize-rhdh-theme-mode.adoc b/modules/customization/proc-customize-rhdh-theme-mode.adoc index 72c638017c..7138ca6834 100644 --- a/modules/customization/proc-customize-rhdh-theme-mode.adoc +++ b/modules/customization/proc-customize-rhdh-theme-mode.adoc @@ -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 diff --git a/modules/customization/ref-customize-rhdh-custom-components.adoc b/modules/customization/ref-customize-rhdh-custom-components.adoc index d7305ff86f..805f21c1cd 100644 --- a/modules/customization/ref-customize-rhdh-custom-components.adoc +++ b/modules/customization/ref-customize-rhdh-custom-components.adoc @@ -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 diff --git a/modules/customization/ref-customize-rhdh-default-backstage.adoc b/modules/customization/ref-customize-rhdh-default-backstage.adoc index ecd6a48205..e13a09d0b6 100644 --- a/modules/customization/ref-customize-rhdh-default-backstage.adoc +++ b/modules/customization/ref-customize-rhdh-default-backstage.adoc @@ -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 diff --git a/modules/customization/ref-customize-rhdh-default-rhdh.adoc b/modules/customization/ref-customize-rhdh-default-rhdh.adoc index df5d7029d3..c04f7534a2 100644 --- a/modules/customization/ref-customize-rhdh-default-rhdh.adoc +++ b/modules/customization/ref-customize-rhdh-default-rhdh.adoc @@ -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 diff --git a/modules/admin/proc-configuring-postgresql-instance-using-helm.adoc b/modules/external-databases/proc-configuring-postgresql-instance-using-helm.adoc similarity index 100% rename from modules/admin/proc-configuring-postgresql-instance-using-helm.adoc rename to modules/external-databases/proc-configuring-postgresql-instance-using-helm.adoc diff --git a/modules/admin/proc-configuring-postgresql-instance-using-operator.adoc b/modules/external-databases/proc-configuring-postgresql-instance-using-the-operator.adoc similarity index 100% rename from modules/admin/proc-configuring-postgresql-instance-using-operator.adoc rename to modules/external-databases/proc-configuring-postgresql-instance-using-the-operator.adoc diff --git a/modules/admin/proc-migrating-databases-to-an-external-server.adoc b/modules/external-databases/proc-migrating-databases-to-an-external-server.adoc similarity index 100% rename from modules/admin/proc-migrating-databases-to-an-external-server.adoc rename to modules/external-databases/proc-migrating-databases-to-an-external-server.adoc diff --git a/modules/getting-started/proc-customize-rhdh-learning-paths.adoc b/modules/getting-started/proc-customize-rhdh-learning-paths.adoc index 2f99273054..499bbcf64a 100644 --- a/modules/getting-started/proc-customize-rhdh-learning-paths.adoc +++ b/modules/getting-started/proc-customize-rhdh-learning-paths.adoc @@ -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: diff --git a/modules/getting-started/proc-customize-rhdh-tech-radar-page.adoc b/modules/getting-started/proc-customize-rhdh-tech-radar-page.adoc index 20764cbe68..ca67da7dcb 100644 --- a/modules/getting-started/proc-customize-rhdh-tech-radar-page.adoc +++ b/modules/getting-started/proc-customize-rhdh-tech-radar-page.adoc @@ -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: diff --git a/modules/admin/proc-configuring-proxy-in-helm-deployment.adoc b/modules/proxy/proc-configuring-proxy-in-helm-deployment.adoc similarity index 100% rename from modules/admin/proc-configuring-proxy-in-helm-deployment.adoc rename to modules/proxy/proc-configuring-proxy-in-helm-deployment.adoc diff --git a/modules/admin/proc-configuring-proxy-in-operator-deployment.adoc b/modules/proxy/proc-configuring-proxy-in-operator-deployment.adoc similarity index 100% rename from modules/admin/proc-configuring-proxy-in-operator-deployment.adoc rename to modules/proxy/proc-configuring-proxy-in-operator-deployment.adoc diff --git a/modules/templates/proc-adding-templates.adoc b/modules/templates/proc-adding-templates.adoc index 5f421cc8de..91ff78ec9b 100644 --- a/modules/templates/proc-adding-templates.adoc +++ b/modules/templates/proc-adding-templates.adoc @@ -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}"] diff --git a/modules/templates/proc-creating-templates.adoc b/modules/templates/proc-creating-templates.adoc index 56f0f6dccb..8113d724ea 100644 --- a/modules/templates/proc-creating-templates.adoc +++ b/modules/templates/proc-creating-templates.adoc @@ -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}"] diff --git a/modules/templates/ref-creating-templates.adoc b/modules/templates/ref-creating-templates.adoc index 943a880e95..d894a74ace 100644 --- a/modules/templates/ref-creating-templates.adoc +++ b/modules/templates/ref-creating-templates.adoc @@ -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}"] diff --git a/titles/admin-rhdh/docinfo.xml b/titles/admin-rhdh/docinfo.xml deleted file mode 100644 index f86bb2f376..0000000000 --- a/titles/admin-rhdh/docinfo.xml +++ /dev/null @@ -1,12 +0,0 @@ -Administration guide for {product} -{product} -{product-version} - - - - {product} is an enterprise-grade platform for building developer portals. As an administrative user, you can manage roles and permissions of other users and configure {product-short} to meet the specific needs of your organization. - - - {company-name} Customer Content Services - - diff --git a/titles/admin-rhdh/master.adoc b/titles/admin-rhdh/master.adoc deleted file mode 100644 index e9369eb549..0000000000 --- a/titles/admin-rhdh/master.adoc +++ /dev/null @@ -1 +0,0 @@ -include::title-admin.adoc[] \ No newline at end of file diff --git a/titles/admin-rhdh/title-admin.adoc b/titles/admin-rhdh/title-admin.adoc deleted file mode 100644 index 4e70d669f1..0000000000 --- a/titles/admin-rhdh/title-admin.adoc +++ /dev/null @@ -1,47 +0,0 @@ -[id="title-admin"] -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] - -// configure PostgreSQL database -include::assemblies/assembly-configuring-external-postgresql-databases.adoc[leveloffset=+1] - -// configure RHDH with TLS in kubernetes -include::modules/installation/proc-configuring-an-rhdh-instance-with-tls-in-kubernetes.adoc[leveloffset=+1] - -//configure dynamic plugins - moved to configuring plugins guide -// include::modules/installation/proc-config-dynamic-plugins-rhdh-operator.adoc[leveloffset=+1] - -//Telemetry data collection -//include::assemblies/assembly-rhdh-telemetry.adoc[leveloffset=+1] // moving observe category related content to new titles: RHIDP-4814 - -// Observability -//include::assemblies/assembly-rhdh-observability.adoc[leveloffset=+1] // moving observe category related content to new titles: RHIDP-4814 - -// Running RHDH behind a proxy -include::assemblies/assembly-running-rhdh-behind-a-proxy.adoc[leveloffset=+1] - -//aws integration -include::assemblies/assembly-rhdh-integration-aws.adoc[leveloffset=+1] - -//aks integration -//include::assemblies/assembly-rhdh-integration-aks.adoc[leveloffset=+1] // Removing assembly since the all of the content does not exist in admin guide - -// Managing templates -include::assemblies/assembly-admin-templates.adoc[leveloffset=+1] - -// techdocs plugin -include::assemblies/assembly-techdocs-plugin.adoc[leveloffset=+1] - -// RHDH Operator deployment -include::modules//admin/proc-rhdh-deployment-config.adoc[leveloffset=+1] \ No newline at end of file diff --git a/titles/configuring/artifacts b/titles/configuring/artifacts new file mode 120000 index 0000000000..04f3a24af5 --- /dev/null +++ b/titles/configuring/artifacts @@ -0,0 +1 @@ +../../artifacts/ \ No newline at end of file diff --git a/titles/configuring/assemblies b/titles/configuring/assemblies new file mode 120000 index 0000000000..51bb510220 --- /dev/null +++ b/titles/configuring/assemblies @@ -0,0 +1 @@ +../../assemblies/ \ No newline at end of file diff --git a/titles/configuring/docinfo.xml b/titles/configuring/docinfo.xml new file mode 120000 index 0000000000..fecb543b13 --- /dev/null +++ b/titles/configuring/docinfo.xml @@ -0,0 +1 @@ +../../artifacts/docinfo.xml \ No newline at end of file diff --git a/titles/admin-rhdh/images b/titles/configuring/images similarity index 100% rename from titles/admin-rhdh/images rename to titles/configuring/images diff --git a/titles/configuring/master.adoc b/titles/configuring/master.adoc new file mode 100644 index 0000000000..a956d35755 --- /dev/null +++ b/titles/configuring/master.adoc @@ -0,0 +1,24 @@ +include::artifacts/attributes.adoc[] +:title: Configuring +:subtitle: Configuring {product} +:abstract: Learn how to configure {product}. +:context: configuring-and-operating +[id="{context}"] += {title} + +{abstract} + + +include::assemblies/assembly-adding-custom-configuration-files.adoc[leveloffset=+1] + + +include::assemblies/assembly-configuring-external-postgresql-databases.adoc[leveloffset=+1] + + +include::assemblies/assembly-running-behind-a-proxy.adoc[leveloffset=+1] + + +include::modules/installation/proc-configuring-an-rhdh-instance-with-tls-in-kubernetes.adoc[leveloffset=+1] + + +include::modules/configuring-deployment/proc-configuring-deployment-by-using-the-operator.adoc[leveloffset=+1] diff --git a/titles/admin-rhdh/modules b/titles/configuring/modules similarity index 100% rename from titles/admin-rhdh/modules rename to titles/configuring/modules diff --git a/titles/customizing/artifacts b/titles/customizing/artifacts new file mode 120000 index 0000000000..04f3a24af5 --- /dev/null +++ b/titles/customizing/artifacts @@ -0,0 +1 @@ +../../artifacts/ \ No newline at end of file diff --git a/titles/customizing/assemblies b/titles/customizing/assemblies new file mode 120000 index 0000000000..51bb510220 --- /dev/null +++ b/titles/customizing/assemblies @@ -0,0 +1 @@ +../../assemblies/ \ No newline at end of file diff --git a/titles/customizing/docinfo.xml b/titles/customizing/docinfo.xml new file mode 120000 index 0000000000..fecb543b13 --- /dev/null +++ b/titles/customizing/docinfo.xml @@ -0,0 +1 @@ +../../artifacts/docinfo.xml \ No newline at end of file diff --git a/titles/customizing/images b/titles/customizing/images new file mode 120000 index 0000000000..5fa6987088 --- /dev/null +++ b/titles/customizing/images @@ -0,0 +1 @@ +../../images \ No newline at end of file diff --git a/titles/customizing/master.adoc b/titles/customizing/master.adoc new file mode 100644 index 0000000000..5be76e4e59 --- /dev/null +++ b/titles/customizing/master.adoc @@ -0,0 +1,38 @@ +include::artifacts/attributes.adoc[] +:title: Customizing display +:subtitle: Configuring {product} display +:abstract: Learn to customize {product} appearance, such as Home, Quick access cards and Tech Radar pages. +:context: customizing-display +[id="{context}"] += {title} + +{abstract} + + + +include::assemblies/assembly-configuring-templates.adoc[leveloffset=+1] + + +include::modules/getting-started/proc-customize-rhdh-learning-paths.adoc[leveloffset=+1] + + +include::assemblies/assembly-configuring-techdocs.adoc[leveloffset=+1] + + +include::modules/getting-started/proc-customize-rhdh-tech-radar-page.adoc[leveloffset=+1] + + +include::assemblies/assembly-customize-rhdh-theme.adoc[leveloffset=+1] + + +include::assemblies/assembly-customizing-the-rhdh-homepage.adoc[leveloffset=+1] + + +include::assemblies/assembly-customizing-the-quick-access-card-in-rhdh.adoc[leveloffset=+1] + + + + + + + diff --git a/titles/customizing/modules b/titles/customizing/modules new file mode 120000 index 0000000000..36719b9de7 --- /dev/null +++ b/titles/customizing/modules @@ -0,0 +1 @@ +../../modules/ \ No newline at end of file diff --git a/titles/discover/master.adoc b/titles/discover/master.adoc index a05b7298b1..4e0a2c26dd 100644 --- a/titles/discover/master.adoc +++ b/titles/discover/master.adoc @@ -1,16 +1,9 @@ [id="title-about_red_hat_developer_hub"] include::artifacts/attributes.adoc[] -= About {product} :doctype: book :imagesdir: images :title: About {product} :subtitle: Introduction to {product} :abstract: {product} is a developer platform designed to build developer portals. Use {product} to provide a streamlined development environment with a centralized software catalog to build high-quality software efficiently. -//[id="{context}"] -//= {title} - -//{abstract} - - -include::assemblies/assembly-about-rhdh.adoc[leveloffset=+1] \ No newline at end of file +include::assemblies/assembly-about-rhdh.adoc[] diff --git a/titles/getting-started-rhdh/title-getting-started.adoc b/titles/getting-started-rhdh/title-getting-started.adoc index 2dd9520f55..071cc1b1c6 100644 --- a/titles/getting-started-rhdh/title-getting-started.adoc +++ b/titles/getting-started-rhdh/title-getting-started.adoc @@ -7,9 +7,6 @@ include::artifacts/attributes.adoc[] 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[] - // rhdh overview include::modules/installation/con-rhdh-overview.adoc[leveloffset=+1] @@ -18,20 +15,9 @@ include::modules/getting-started/ref-rhdh-sizing.adoc[leveloffset=+1] // 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] include::assemblies/assembly-bulk-importing-from-github.adoc[leveloffset=+1] -include::assemblies/assembly-customizing-the-rhdh-homepage.adoc[leveloffset=+1] -include::assemblies/assembly-customizing-the-quick-access-card-in-rhdh.adoc[leveloffset=+1] -include::modules/getting-started/proc-customize-rhdh-tech-radar-page.adoc[leveloffset=+1] -include::modules/getting-started/proc-customize-rhdh-learning-paths.adoc[leveloffset=+1] - -include::assemblies/assembly-customize-rhdh-theme.adoc[leveloffset=+1] - include::modules/getting-started/con-servicenow-custom-actions.adoc[leveloffset=+1] include::modules/getting-started/proc-enable-servicenow-custom-actions-plugin.adoc[leveloffset=+2] include::modules/getting-started/ref-supported-servicenow-custom-actions.adoc[leveloffset=+2] - -// Audit logging -//include::assemblies/assembly-audit-log.adoc[leveloffset=+1] // moving observe category related content to new titles: RHIDP-4814 diff --git a/titles/install-rhdh-aks/master.adoc b/titles/install-rhdh-aks/master.adoc index 948c7ef8ff..9108f55294 100644 --- a/titles/install-rhdh-aks/master.adoc +++ b/titles/install-rhdh-aks/master.adoc @@ -18,3 +18,4 @@ include::modules/installation/proc-rhdh-deploy-aks-operator.adoc[leveloffset=+1] // Helm chart method include::modules/installation/proc-rhdh-deploy-aks-helm.adoc[leveloffset=+1] + diff --git a/titles/admin-rhdh/artifacts b/titles/installation-rhdh/artifacts similarity index 100% rename from titles/admin-rhdh/artifacts rename to titles/installation-rhdh/artifacts diff --git a/titles/admin-rhdh/assemblies b/titles/installation-rhdh/assemblies similarity index 100% rename from titles/admin-rhdh/assemblies rename to titles/installation-rhdh/assemblies diff --git a/titles/installation-rhdh/images b/titles/installation-rhdh/images new file mode 120000 index 0000000000..5fa6987088 --- /dev/null +++ b/titles/installation-rhdh/images @@ -0,0 +1 @@ +../../images \ No newline at end of file diff --git a/titles/installation-rhdh/modules b/titles/installation-rhdh/modules new file mode 120000 index 0000000000..8b0e854007 --- /dev/null +++ b/titles/installation-rhdh/modules @@ -0,0 +1 @@ +../../modules \ No newline at end of file