diff --git a/artifacts/rhdh-plugins-reference/nexus-repository-manager/nexus-repository-manager-plugin-readme.adoc b/artifacts/rhdh-plugins-reference/nexus-repository-manager/nexus-repository-manager-plugin-readme.adoc index 5a82cfb7fc..6333488ad6 100644 --- a/artifacts/rhdh-plugins-reference/nexus-repository-manager/nexus-repository-manager-plugin-readme.adoc +++ b/artifacts/rhdh-plugins-reference/nexus-repository-manager/nexus-repository-manager-plugin-readme.adoc @@ -88,7 +88,7 @@ The Nexus Repository Manager is a front-end plugin that enables you to view the .Prerequisites - Your {product-short} application is installed and running. -- You have installed the Nexus Repository Manager plugin. For the installation process, see <>. +- You have installed the Nexus Repository Manager plugin. For the installation process, see documentation on Installing and configuring the Nexus Repository Manager plugin. .Procedure @@ -100,3 +100,8 @@ The *BUILD ARTIFACTS* tab contains a list of build artifacts and related informa image::rhdh-plugins-reference/nexus-repository-manager.png[nexus-repository-manager-tab] -- + +[role="_additional-resources"] +.Additional resources + +* <> \ No newline at end of file diff --git a/artifacts/rhdh-plugins-reference/nexus-repository-manager/nexus-repository-manager-plugin-user.adoc b/artifacts/rhdh-plugins-reference/nexus-repository-manager/nexus-repository-manager-plugin-user.adoc index 6c27f14dc4..91bf27065e 100644 --- a/artifacts/rhdh-plugins-reference/nexus-repository-manager/nexus-repository-manager-plugin-user.adoc +++ b/artifacts/rhdh-plugins-reference/nexus-repository-manager/nexus-repository-manager-plugin-user.adoc @@ -18,8 +18,7 @@ The Nexus Repository Manager is a front-end plugin that enables you to view the .Prerequisites - Your {product-short} application is installed and running. -- You have installed the Nexus Repository Manager plugin. -//For the installation process, see xref:installing-configuring-nexus-plugin[Installing and configuring the Nexus Repository Manager plugin]. +- You have installed the Nexus Repository Manager plugin. .Procedure @@ -31,3 +30,8 @@ The *BUILD ARTIFACTS* tab contains a list of build artifacts and related informa image::rhdh-plugins-reference/nexus-repository-manager.png[nexus-repository-manager-tab] -- + +//[role="_additional-resources"] +//.Additional resources + +//* xref:installing-configuring-nexus-plugin[Installing and configuring the Nexus Repository Manager plugin] \ No newline at end of file diff --git a/artifacts/rhdh-plugins-reference/ocm/ocm-plugin-readme.adoc b/artifacts/rhdh-plugins-reference/ocm/ocm-plugin-readme.adoc index 504259a992..810b84dc79 100644 --- a/artifacts/rhdh-plugins-reference/ocm/ocm-plugin-readme.adoc +++ b/artifacts/rhdh-plugins-reference/ocm/ocm-plugin-readme.adoc @@ -25,7 +25,7 @@ The Red Hat Plug-ins for Backstage (RHPIB) packages are hosted in a separate NPM ---- # update your .npmrc or .yarnrc file yarn config set "@redhat:registry" https://npm.registry.redhat.com -# then pull a package +# then pull a package yarn add @redhat/backstage-plugin-quay ---- @@ -49,7 +49,7 @@ If you are interested in Resource discovery and do not want any of the front-end ==== Prerequisites * OCM is deployed and configured on a Kubernetes cluster. -* https://backstage.io/docs/features/kubernetes[Kubernetes plugin for Backstage] is installed. +* Kubernetes plugin for Backstage is installed. * A `ClusterRole` is granted to `ServiceAccount` accessing the hub cluster as follows: + -- @@ -410,7 +410,7 @@ The OCM plugin integrates your Backstage instance with multi-cluster engines and ==== Prerequisites * Your Backstage application is installed and running. -* You have installed the OCM plugin. For the installation process, see <>. +* You have installed the OCM plugin. ==== Procedure @@ -437,3 +437,9 @@ You are redirected to the cluster-specific page, which consists of: image::ocm-plugin-user2.png[ocm-plugin-ui] -- + +[role="_additional-resources"] +.Additional resources + +* <> +* link:https://backstage.io/docs/features/kubernetes[Installing Kubernetes plugin for Backstage] \ No newline at end of file diff --git a/artifacts/rhdh-plugins-reference/quay/quay-plugin-readme.adoc b/artifacts/rhdh-plugins-reference/quay/quay-plugin-readme.adoc index c0dd3f9b2a..a86de8575d 100644 --- a/artifacts/rhdh-plugins-reference/quay/quay-plugin-readme.adoc +++ b/artifacts/rhdh-plugins-reference/quay/quay-plugin-readme.adoc @@ -18,7 +18,7 @@ The Red Hat Plug-ins for Backstage (RHPIB) packages are hosted in a separate NPM ---- # update your .npmrc or .yarnrc file yarn config set "@redhat:registry" https://npm.registry.redhat.com -# then pull a package +# then pull a package yarn add @redhat/backstage-plugin-quay ---- @@ -105,7 +105,7 @@ Quay is a front-end plugin that enables you to view the information about the co .Prerequisites * Your {product-short} application is installed and running. -* You have installed the Quay plugin. For installation process, see <>. +* You have installed the Quay plugin. .Procedure @@ -125,3 +125,8 @@ The vulnerabilities page displays the associated advisory with a link, severity, image::quay-plugin-backstage3.png[quay-tab-vulnerabilities] + The advisory link redirects to the Red Hat Security Advisory page that contains detailed information about the advisory, including the solution. + +[role="_additional-resources"] +.Additional resources + +* <> diff --git a/artifacts/rhdh-plugins-reference/tekton/tekton-plugin-admin.adoc b/artifacts/rhdh-plugins-reference/tekton/tekton-plugin-admin.adoc index 1bdaa85be9..79f4c580b3 100644 --- a/artifacts/rhdh-plugins-reference/tekton/tekton-plugin-admin.adoc +++ b/artifacts/rhdh-plugins-reference/tekton/tekton-plugin-admin.adoc @@ -8,8 +8,6 @@ You can use the Tekton plugin to visualize the results of CI/CD pipeline runs on .Prerequisites * You have installed and configured the `@backstage/plugin-kubernetes` and `@backstage/plugin-kubernetes-backend` dynamic plugins. -//For more information about installing dynamic plugins, see xref:rhdh-installing-dynamic-plugins[]. -//Cannot xref across titles. Convert xref to a link. * You have configured the Kubernetes plugin to connect to the cluster using a `ServiceAccount`. @@ -141,3 +139,8 @@ global: disabled: false ---- -- + +//[role="_additional-resources"] +//.Additional resources + +//* xref:rhdh-installing-dynamic-plugins[Installing dynamic plugins] \ No newline at end of file diff --git a/artifacts/rhdh-plugins-reference/tekton/tekton-plugin-readme.adoc b/artifacts/rhdh-plugins-reference/tekton/tekton-plugin-readme.adoc index 8f5562c94e..b94f4864ca 100644 --- a/artifacts/rhdh-plugins-reference/tekton/tekton-plugin-readme.adoc +++ b/artifacts/rhdh-plugins-reference/tekton/tekton-plugin-readme.adoc @@ -10,8 +10,6 @@ You can use the Tekton plugin to visualize the results of CI/CD pipeline runs on .Prerequisites * You have installed and configured the `@backstage/plugin-kubernetes` and `@backstage/plugin-kubernetes-backend` dynamic plugins. -//For more information about installing dynamic plugins, see xref:rhdh-installing-dynamic-plugins[]. -//Cannot xref across titles. Convert xref to a link. * You have configured the Kubernetes plugin to connect to the cluster using a `ServiceAccount`. @@ -152,7 +150,7 @@ You can use the Tekton front-end plugin to view `PipelineRun` resources. .Prerequisites * You have installed the Red Hat Developer Hub (RHDH). -* You have installed the Tekton plugin. For the installation process, see xref:installation-and-configuration-tekton[Installing and configuring the Tekton plugin]. +* You have installed the Tekton plugin. .Procedure . Open your RHDH application and select a component from the *Catalog* page. @@ -165,3 +163,9 @@ image::rhdh-plugins-reference/tekton-plugin-pipeline.png[ci-cd-tab-tekton] . Click the expand row button besides PipelineRun name in the list to view the PipelineRun visualization. The pipeline run resource includes tasks to complete. When you hover the mouse pointer on a task card, you can view the steps to complete that particular task. + image::rhdh-plugins-reference/tekton-plugin-pipeline-expand.png[ci-cd-tab-tekton] + +[role="_additional-resources"] +.Additional resources + +* xref:installation-and-configuration-tekton[Installing and configuring the Tekton plugin] +//* xref:rhdh-installing-dynamic-plugins[] \ No newline at end of file diff --git a/artifacts/rhdh-plugins-reference/tekton/tekton-plugin-user.adoc b/artifacts/rhdh-plugins-reference/tekton/tekton-plugin-user.adoc index ab5094488d..9376dfea91 100644 --- a/artifacts/rhdh-plugins-reference/tekton/tekton-plugin-user.adoc +++ b/artifacts/rhdh-plugins-reference/tekton/tekton-plugin-user.adoc @@ -7,7 +7,7 @@ You can use the Tekton front-end plugin to view `PipelineRun` resources. .Prerequisites * You have installed the Red Hat Developer Hub (RHDH). -* You have installed the Tekton plugin. For the installation process, see xref:installation-and-configuration-tekton[Installing and configuring the Tekton plugin]. +* You have installed the Tekton plugin. .Procedure . Open your RHDH application and select a component from the *Catalog* page. @@ -20,3 +20,8 @@ image::rhdh-plugins-reference/tekton-plugin-pipeline.png[ci-cd-tab-tekton] . Click the expand row button besides PipelineRun name in the list to view the PipelineRun visualization. The pipeline run resource includes tasks to complete. When you hover the mouse pointer on a task card, you can view the steps to complete that particular task. + image::rhdh-plugins-reference/tekton-plugin-pipeline-expand.png[ci-cd-tab-tekton] + +[role="_additional-resources"] +.Additional resources + +* xref:installation-and-configuration-tekton[Installing and configuring the Tekton plugin] \ No newline at end of file diff --git a/artifacts/rhdh-plugins-reference/topology/topology-plugin-readme.adoc b/artifacts/rhdh-plugins-reference/topology/topology-plugin-readme.adoc index 1630a02eb5..9b72b01083 100644 --- a/artifacts/rhdh-plugins-reference/topology/topology-plugin-readme.adoc +++ b/artifacts/rhdh-plugins-reference/topology/topology-plugin-readme.adoc @@ -13,7 +13,7 @@ The Red Hat Plug-ins for Backstage (RHPIB) packages are hosted in a separate NPM ---- # update your .npmrc or .yarnrc file yarn config set "@redhat:registry" https://npm.registry.redhat.com -# then pull a package +# then pull a package yarn add @redhat/backstage-plugin-quay ---- @@ -25,10 +25,10 @@ Using this configuration, you can proceed with the installation of the individua endif::[] .Prerequisites -* The Kubernetes plugins including `@backstage/plugin-kubernetes` and `@backstage/plugin-kubernetes-backend` are installed and configured by following the https://backstage.io/docs/features/kubernetes/installation[installation] and https://backstage.io/docs/features/kubernetes/configuration[configuration] guides. +* The Kubernetes plugins including `@backstage/plugin-kubernetes` and `@backstage/plugin-kubernetes-backend` are installed and configured by following the _installation_ and _configuration_ guides. * The Kubernetes plugin is configured and connects to the cluster using a `ServiceAccount`. -* The https://backstage.io/docs/features/kubernetes/configuration#role-based-access-control[`ClusterRole`] must be granted to `ServiceAccount` accessing the cluster. If you have the {product-short} Kubernetes plugin configured, then the `ClusterRole` is already granted. -* The following must be added in``customResources`` component in the https://backstage.io/docs/features/kubernetes/configuration#configuring-kubernetes-clusters[`app-config.yaml`] file to view the OpenShift route: +* The `ClusterRole` must be granted to `ServiceAccount` accessing the cluster. If you have the {product-short} Kubernetes plugin configured, then the `ClusterRole` is already granted. +* The following must be added in``customResources`` component in the `app-config.yaml` file to view the OpenShift route: + -- [source,yaml] @@ -41,7 +41,7 @@ endif::[] plural: 'routes' ---- -Also, ensure that the route is granted a https://backstage.io/docs/features/kubernetes/configuration#role-based-access-control[`ClusterRole`]. You can use the following code to grant the `ClusterRole` to the route : +Also, ensure that the route is granted a `ClusterRole`. You can use the following code to grant the `ClusterRole` to the route : [source,yaml] ---- @@ -63,7 +63,7 @@ Also, ensure that the route is granted a https://backstage.io/docs/features/kube ---- -- -* The following permission must be granted to the https://backstage.io/docs/features/kubernetes/configuration#role-based-access-control[`ClusterRole`] to be able to view the pod logs: +* The following permission must be granted to the `ClusterRole` to be able to view the pod logs: + -- [source,yaml] @@ -86,7 +86,7 @@ Also, ensure that the route is granted a https://backstage.io/docs/features/kube ---- -- -* The following code must be added in `customResources` component in the https://backstage.io/docs/features/kubernetes/configuration#configuring-kubernetes-clusters[`app-config.yaml`] file to view the Tekton PipelineRuns list in the side panel and to view the latest PipelineRun status in the Topology node decorator: +* The following code must be added in `customResources` component in the `app-config.yaml` file to view the Tekton PipelineRuns list in the side panel and to view the latest PipelineRun status in the Topology node decorator: + -- [source,yaml] @@ -105,7 +105,7 @@ Also, ensure that the route is granted a https://backstage.io/docs/features/kube plural: 'taskruns' ---- -Also, ensure that the Pipeline, PipelineRun, and TaskRun are granted a https://backstage.io/docs/features/kubernetes/configuration#role-based-access-control[`ClusterRole`]. You can use the following code to grant the `ClusterRole` to Pipeline, PipelineRun, and TaskRun: +Also, ensure that the Pipeline, PipelineRun, and TaskRun are granted a `ClusterRole`. You can use the following code to grant the `ClusterRole` to Pipeline, PipelineRun, and TaskRun: [source,yaml] ---- @@ -127,7 +127,7 @@ Also, ensure that the Pipeline, PipelineRun, and TaskRun are granted a https://b ---- -- -* The following configuration must be added in`customResources` component in the https://backstage.io/docs/features/kubernetes/configuration#configuring-kubernetes-clusters[`app-config.yaml`] file to view the edit code decorator: +* The following configuration must be added in`customResources` component in the `app-config.yaml` file to view the edit code decorator: + -- [source,yaml] @@ -140,7 +140,7 @@ Also, ensure that the Pipeline, PipelineRun, and TaskRun are granted a https://b plural: 'checlusters' ---- -Also, ensure that the `CheCluster` is granted a https://backstage.io/docs/features/kubernetes/configuration#role-based-access-control[`ClusterRole`] as shown in the following example code: +Also, ensure that the `CheCluster` is granted a `ClusterRole` as shown in the following example code: [source,yaml] ---- @@ -177,7 +177,7 @@ annotations: app.openshift.io/vcs-ref: ---- -If Red Hat OpenShift Dev Spaces (RHODS) is installed and configured and Git URL annotations are also added in the workload YAML file, then clicking on the edit code decorator redirects you to the RHODS instance. For more information about installing RHODS, see https://access.redhat.com/documentation/en-us/red_hat_openshift_dev_spaces/3.7/html/administration_guide/installing-devspaces[Administration guide] of RHODS. +If Red Hat OpenShift Dev Spaces (RHODS) is installed and configured and Git URL annotations are also added in the workload YAML file, then clicking on the edit code decorator redirects you to the RHODS instance. For more information about installing RHODS, see Administration guide of RHODS. When you deploy your application using the OCP git import flow, then you do not need to add the labels as import flow to the workload YAML file. Otherwise, you would need to add the labels to the workload YAML file manually. @@ -386,7 +386,7 @@ Topology is a front-end plugin that enables you to view the workloads as nodes t .Prerequisites * Your {product-short} application is installed and running. -* You have installed the Topology plugin. For the installation process, see <>. +* You have installed the Topology plugin. .Procedure @@ -410,3 +410,13 @@ image::topology-tab-user3.png[topology-tab-open-url] When you click on the open URL button, it allows you to access the associated *Ingresses* and runs your application in a new tab. -- + +[role="_additional-resources"] +.Additional resources + +* <> +* link:https://backstage.io/docs/features/kubernetes/installation[Installation guide] +* link:https://backstage.io/docs/features/kubernetes/configuration[Configuration guide] +* link:https://backstage.io/docs/features/kubernetes/configuration#role-based-access-control[`ClusterRole`] +* link:https://backstage.io/docs/features/kubernetes/configuration#configuring-kubernetes-clusters[`app-config.yaml` file to view the OpenShift route] +* link:https://access.redhat.com/documentation/en-us/red_hat_openshift_dev_spaces/3.7/html/administration_guide/installing-devspaces[Administration guide of RHODS] \ No newline at end of file diff --git a/modules/integrating-with-github/proc-enabling-github-repository-discovery.adoc b/modules/integrating-with-github/proc-enabling-github-repository-discovery.adoc index de0ff31dcf..c5387044f7 100644 --- a/modules/integrating-with-github/proc-enabling-github-repository-discovery.adoc +++ b/modules/integrating-with-github/proc-enabling-github-repository-discovery.adoc @@ -5,9 +5,9 @@ Consider configuring {product-short} to discover and ingest your GitHub reposito If a repository contains a `catalog-info.yaml` file, {product-short} ingests the repository into the catalog as a component. .Prerequisites -* You link:{configuring-book-url}[added a custom {product-short} application configuration], and have sufficient permissions to modify it. +* You added a custom {product-short} application configuration, and have sufficient permissions to modify it. -* You have sufficient permissions in GitHub to create and manage a link:https://docs.github.com/en/apps/overview[GitHub App]. +* You have sufficient permissions in GitHub to create and manage a GitHub App. .Procedure . To allow {product-short} to access the GitHub API, create a GitHub App. @@ -152,3 +152,9 @@ integrations: ${GITHUB_INTEGRATION_PRIVATE_KEY_FILE} ---- +[role="_additional-resources"] +.Additional resources + +* link:{configuring-book-url}[Adding a custom {product-short} application configuration] + +* link:https://docs.github.com/en/apps/overview[GitHub App] \ No newline at end of file diff --git a/modules/observe/proc-admin-enabling-metrics-ocp-helm.adoc b/modules/observe/proc-admin-enabling-metrics-ocp-helm.adoc index bd5b2a71d1..6cf1960c95 100644 --- a/modules/observe/proc-admin-enabling-metrics-ocp-helm.adoc +++ b/modules/observe/proc-admin-enabling-metrics-ocp-helm.adoc @@ -10,7 +10,7 @@ You can enable and view metrics for a {product} Helm deployment from the *Develo .Prerequisites -* Your {ocp-short} cluster has link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/monitoring/index#enabling-monitoring-for-user-defined-projects[monitoring for user-defined projects] enabled. +* Your {ocp-short} cluster has monitoring for user-defined projects enabled. * You have installed {product} on {ocp-short} using the Helm chart. .Procedure @@ -41,4 +41,9 @@ image::rhdh/upgrade-helm-metrics.png[] .Verification . From the *Developer* perspective in the {ocp-short} web console, select the *Observe* view. -. Click the *Metrics* tab to view metrics for {product} pods. \ No newline at end of file +. Click the *Metrics* tab to view metrics for {product} pods. + +[role="_additional-resources"] +.Additional resources + +* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/monitoring/index#enabling-monitoring-for-user-defined-projects[Monitoring for user-defined projects] \ No newline at end of file diff --git a/modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc b/modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc index 921ed4d11b..176f48e1a6 100644 --- a/modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc +++ b/modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc @@ -10,7 +10,7 @@ You can enable and view metrics for an Operator-installed {product} instance fro .Prerequisites -* Your {ocp-short} cluster has link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/monitoring/index#enabling-monitoring-for-user-defined-projects[monitoring for user-defined projects] enabled. +* Your {ocp-short} cluster has monitoring for user-defined projects enabled. * You have installed {product} on {ocp-short} using the {product} Operator. * You have installed the {openshift-cli}. @@ -66,3 +66,8 @@ oc apply -f . From the *Developer* perspective in the {ocp-short} web console, select the *Observe* view. . Click the *Metrics* tab to view metrics for {product} pods. . From the Developer perspective in the {ocp-short} web console, click **Project > Services** and verify the labels for `backstage-developer-hub`. + +[role="_additional-resources"] +.Additional resources + +* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/monitoring/index#enabling-monitoring-for-user-defined-projects[Monitoring for user-defined projects] \ No newline at end of file diff --git a/modules/observe/proc-retrieving-logs-from-amazon-cloudwatch.adoc b/modules/observe/proc-retrieving-logs-from-amazon-cloudwatch.adoc index e1eb6c37ae..76b4f82530 100644 --- a/modules/observe/proc-retrieving-logs-from-amazon-cloudwatch.adoc +++ b/modules/observe/proc-retrieving-logs-from-amazon-cloudwatch.adoc @@ -3,11 +3,9 @@ .Prerequisites * CloudWatch Container Insights is used to capture logs and metrics for {eks-brand-name}. -For more information, see https://docs.aws.amazon.com/prescriptive-guidance/latest/implementing-logging-monitoring-cloudwatch/kubernetes-eks-logging.html[Logging for {eks-brand-name}] documentation. - -* To capture the logs and metrics, link:https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Container-Insights-setup-EKS-addon.html[install the Amazon CloudWatch Observability EKS add-on] in your cluster. +For more information, see Logging for {eks-brand-name} documentation. +* To capture the logs and metrics, install the Amazon CloudWatch Observability EKS add-on in your cluster. Following the setup of Container Insights, you can access container logs using Logs Insights or Live Tail views. - * CloudWatch names the log group where all container logs are consolidated in the following manner: + [subs="+quotes"] @@ -23,3 +21,9 @@ Following the setup of Container Insights, you can access container logs using L fields @timestamp, @message, kubernetes.container_name | filter kubernetes.container_name in ["install-dynamic-plugins", "backstage-backend"] ---- + +[role="_additional-resources"] +.Additional resources + +* link:https://docs.aws.amazon.com/prescriptive-guidance/latest/implementing-logging-monitoring-cloudwatch/kubernetes-eks-logging.html[Logging for {eks-brand-name} documentation] +* link:https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Container-Insights-setup-EKS-addon.html[Installing the Amazon CloudWatch Observability EKS add-on] diff --git a/modules/observe/proc-view-logs-aks.adoc b/modules/observe/proc-view-logs-aks.adoc index e3b2c0186f..4c36f1c74c 100644 --- a/modules/observe/proc-view-logs-aks.adoc +++ b/modules/observe/proc-view-logs-aks.adoc @@ -7,8 +7,6 @@ You can access live data logs generated by Kubernetes objects and collect log da * You have deployed {product-short} on {aks-short}. -For more information, see xref:{installing-on-aks-book-url}#assembly-install-rhdh-aks[{installing-on-aks-book-title}]. - .Procedure View live logs from your {product-short} instance:: @@ -35,3 +33,8 @@ View real-time log data from the Container Engine:: . Go to the *Containers* tab. . Find the backend-backstage container and click it to view real-time log data as it's generated by the Container Engine. -- + +[role="_additional-resources"] +.Additional resources + +* xref:{installing-on-aks-book-url}#assembly-install-rhdh-aks[{installing-on-aks-book-title}] diff --git a/modules/proc-create-plugin.adoc b/modules/proc-create-plugin.adoc index d917ea5913..c327a9ae74 100644 --- a/modules/proc-create-plugin.adoc +++ b/modules/proc-create-plugin.adoc @@ -6,7 +6,7 @@ You can create a plugin for the {product-short} application. .Prerequisites -* {product} application is installed and running. For more information, see link:{configuring-book-url}[{configuring-book-title}]). +* {product} application is installed and running. * `yarn` command and associated dependencies are installed. .Procedure @@ -36,3 +36,9 @@ yarn workspace {pluginID} start # Also supports --check <1> Accessing the plugin in isolation results in quicker iteration and startup times. This approach is specifically for local development, and you can find the necessary configuration in the plugin's `dev/` directory. -- + +[role="_additional-resources"] +.Additional resources + +* link:{configuring-book-url}[{configuring-book-title}] + diff --git a/modules/release-notes/README.adoc b/modules/release-notes/README.adoc index ba51ef017d..b863006fbf 100644 --- a/modules/release-notes/README.adoc +++ b/modules/release-notes/README.adoc @@ -5,7 +5,7 @@ The general purpose release notes content is single-sourced from link:https://issues.redhat.com/browse/RHIDP[the JIRA project]. .Prerequisites -* In link:https://issues.redhat.com/secure/Dashboard.jspa?selectPageId=12364101#SIGwKWmOqDCVBoapBCJiDqhoiKInaroYEg9j2PldSYMUcQVVVdrFHVDUxs1uBtQolXVZgDTdZwjXSCNOA1u11Xeog9Xjb100DUNCh2jwi0TVgzWteeg2FC1TmbT1TUrftGiFHa2CjQtp2TX1DnIGgGCIgEKI+iQfrUlV2AvkJQA[the JIRA project]: +* In the JIRA project: ** *Fix Version/s* is set. ** *Release Notes Text* is set using following format: a level 0 title followed by descriptive content, such as: + @@ -44,3 +44,7 @@ $ python modules/release-notes/single-source-release-notes.py $ git diff ---- +[role="_additional-resources"] +.Additional resources + +* link:https://issues.redhat.com/secure/Dashboard.jspa?selectPageId=12364101#SIGwKWmOqDCVBoapBCJiDqhoiKInaroYEg9j2PldSYMUcQVVVdrFHVDUxs1uBtQolXVZgDTdZwjXSCNOA1u11Xeog9Xjb100DUNCh2jwi0TVgzWteeg2FC1TmbT1TUrftGiFHa2CjQtp2TX1DnIGgGCIgEKI+iQfrUlV2AvkJQA[The JIRA project] \ No newline at end of file diff --git a/modules/software-catalogs/proc-adding-new-components-to-the-rhdh-instance.adoc b/modules/software-catalogs/proc-adding-new-components-to-the-rhdh-instance.adoc index 5cc6428f09..3da1e80610 100644 --- a/modules/software-catalogs/proc-adding-new-components-to-the-rhdh-instance.adoc +++ b/modules/software-catalogs/proc-adding-new-components-to-the-rhdh-instance.adoc @@ -9,7 +9,7 @@ .Prerequisites * You have installed and configured the {product} instance. -* You have the required permissions. See link:{authorization-book-url}[{authorization-book-title}]. +* You have the required permissions. .Procedure @@ -17,4 +17,9 @@ You can add components to your {product-very-short} instance using the following * Register components manually using the GUI or by using your `{my-app-config-file}` with the required permissions. * Create new components by using Software Templates. -* Use the bulk import plugin with the required permissions. For more information, see link:{configuring-dynamic-plugins-book-url}#bulk-importing-github-repositories[Bulk importing GitHub repositories]. \ No newline at end of file +* Use the bulk import plugin with the required permissions. For more information, see link:{configuring-dynamic-plugins-book-url}#bulk-importing-github-repositories[Bulk importing GitHub repositories]. + +[role="_additional-resources"] +.Additional resources + +* link:{authorization-book-url}[{authorization-book-title}] \ No newline at end of file diff --git a/modules/software-catalogs/proc-creating-new-components-in-the-rhdh-instance.adoc b/modules/software-catalogs/proc-creating-new-components-in-the-rhdh-instance.adoc index 877659f570..e9455a6e7b 100644 --- a/modules/software-catalogs/proc-creating-new-components-in-the-rhdh-instance.adoc +++ b/modules/software-catalogs/proc-creating-new-components-in-the-rhdh-instance.adoc @@ -11,9 +11,14 @@ You can create new components in the Software Catalog in your {product-very-shor .Prerequisites * You have installed and configured the {product} instance. -* You have the required permissions. See link:{authorization-book-url}[{authorization-book-title}]. +* You have the required permissions. .Procedure . In your {product} navigation menu, click *Catalog*. -. On the *Catalog* page, click *Self-service*. \ No newline at end of file +. On the *Catalog* page, click *Self-service*. + +[role="_additional-resources"] +.Additional resources + +* link:{authorization-book-url}[{authorization-book-title}] \ No newline at end of file diff --git a/modules/software-catalogs/proc-registering-components-manually-in-the-rhdh-instance.adoc b/modules/software-catalogs/proc-registering-components-manually-in-the-rhdh-instance.adoc index ae6f964fdf..d9070fc9ab 100644 --- a/modules/software-catalogs/proc-registering-components-manually-in-the-rhdh-instance.adoc +++ b/modules/software-catalogs/proc-registering-components-manually-in-the-rhdh-instance.adoc @@ -11,7 +11,7 @@ To manually register components in your {product-very-short} instance, create a .Prerequisites * You have installed and configured the {product} instance. -* You have the required permissions. See link:{authorization-book-url}[{authorization-book-title}]. +* You have the required permissions. .Procedure @@ -43,4 +43,9 @@ spec: .Verification -* Your software component is listed in the Software Catalog. You can view its details and ensure all the metadata is accurate. \ No newline at end of file +* Your software component is listed in the Software Catalog. You can view its details and ensure all the metadata is accurate. + +[role="_additional-resources"] +.Additional resources + +* link:{authorization-book-url}[{authorization-book-title}] \ No newline at end of file diff --git a/modules/software-catalogs/proc-updating-components-in-the-software-catalog.adoc b/modules/software-catalogs/proc-updating-components-in-the-software-catalog.adoc index 4840c1fd3a..4af8dc256a 100644 --- a/modules/software-catalogs/proc-updating-components-in-the-software-catalog.adoc +++ b/modules/software-catalogs/proc-updating-components-in-the-software-catalog.adoc @@ -11,7 +11,7 @@ You can update components in the Software Catalog in your {product} instance. .Prerequisites * You have installed and configured the {product} instance. -* You have the required permissions. See link:{authorization-book-url}[{authorization-book-title}]. +* You have the required permissions. .Procedure @@ -32,4 +32,9 @@ This action redirects you to the YAML file on GitHub. [NOTE] ==== After you merge your changes, the updated metadata in the Software Catalog appears after some time. -==== \ No newline at end of file +==== + +[role="_additional-resources"] +.Additional resources + +* link:{authorization-book-url}[{authorization-book-title}] \ No newline at end of file diff --git a/modules/techdocs/proc-techdocs-addon-install-third-party.adoc b/modules/techdocs/proc-techdocs-addon-install-third-party.adoc index 650b136917..4ea776e4d8 100644 --- a/modules/techdocs/proc-techdocs-addon-install-third-party.adoc +++ b/modules/techdocs/proc-techdocs-addon-install-third-party.adoc @@ -10,7 +10,7 @@ You can install compatible third-party TechDocs add-on on your {product} instanc .Prerequisites * The third-party TechDocs add-on has a valid `package.json` file in its root directory, containing all required metadata and dependencies. -* The third-party plugin is packaged as a dynamic plugin in an OCI image. For alternative package types, see link:https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/release-1.5/plugins-rhdh-install/#assembly-install-third-party-plugins-rhdh[Installing third-party plugins in Red Hat Developer Hub]. +* The third-party plugin is packaged as a dynamic plugin in an OCI image. For alternative package types, see documentation on installing third-party plugins in {product}. * You have installed the `yarn` package manager. * The third-party plugin is packaged as a dynamic plugin in an OCI image.* You have installed and configured Node.js and NPM. @@ -84,3 +84,8 @@ __ :: Specifies the , for example, `backstage-plugin-te __ :: Specifies the name of the third-party add-on that you want to use, for example, `Mermaid`. __ :: Specifies the name of the custom property that can be passed to the third-party add-on, for example, `themeVariables`. Properties are specific to each add-on. You can list multiple properties for an add-on. __ :: Specifies the value of a property key for the third-party add-on, for example, `lineColor: #000000`. + +[role="_additional-resources"] +.Additional resources + +* link:https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/release-1.5/plugins-rhdh-install/#assembly-install-third-party-plugins-rhdh[Installing third-party plugins in {product}] \ No newline at end of file diff --git a/modules/upgrade/proc-upgrade-rhdh-operator.adoc b/modules/upgrade/proc-upgrade-rhdh-operator.adoc index f2d43a2272..4c0f39731e 100644 --- a/modules/upgrade/proc-upgrade-rhdh-operator.adoc +++ b/modules/upgrade/proc-upgrade-rhdh-operator.adoc @@ -14,7 +14,7 @@ If you use the Operator to deploy your {product} instance, then an administrator * You are logged in as an administrator on the {ocp-short} web console. * You have installed the {product} Operator. -* You have configured the appropriate roles and permissions within your project to create or access an application. For more information, see the link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#building-applications-overview[{ocp-brand-name} documentation on Building applications]. +* You have configured the appropriate roles and permissions within your project to create or access an application. .Procedure @@ -37,5 +37,7 @@ If there is no upgrade available, the *Upgrade status* field value is *Up to dat [role="_additional-resources"] .Additional resources -* link:{installing-on-ocp-book-url}#proc-install-operator_assembly-install-rhdh-ocp-operator[{installing-on-ocp-book-title} with the Operator]. +* link:{installing-on-ocp-book-url}#proc-install-operator_assembly-install-rhdh-ocp-operator[{installing-on-ocp-book-title} with the Operator] * link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/operators/index#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster[Installing from OperatorHub by using the web console] +* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#building-applications-overview[{ocp-brand-name} documentation on Building applications] + diff --git a/modules/using-service-now/proc-enable-servicenow-custom-actions-plugin.adoc b/modules/using-service-now/proc-enable-servicenow-custom-actions-plugin.adoc index b1cb404d61..524d8a3cb7 100644 --- a/modules/using-service-now/proc-enable-servicenow-custom-actions-plugin.adoc +++ b/modules/using-service-now/proc-enable-servicenow-custom-actions-plugin.adoc @@ -6,7 +6,6 @@ In {product}, the ServiceNow custom actions are provided as a pre-loaded plugin, .Prerequisites * {product} is installed and running. -For more information about installing the {product-short}, see xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart]. * You have created a project in the {product-short}. .Procedure @@ -45,3 +44,9 @@ servicenow: password: ${SERVICENOW_PASSWORD} ---- -- + +[role="_additional-resources"] +.Additional resources + +* xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart] +