Modularize modules/dynamic-plugins/proc-topology-configur

Author: GitHub Actions

assemblies/dynamic-plugins/assembly-configuring-rhdh-plugins.adoc

@@ -20,18 +20,7 @@ include::../../artifacts/rhdh-plugins-reference/nexus-repository-manager/nexus-r
 include::../../artifacts/rhdh-plugins-reference/tekton/tekton-plugin-admin.adoc[leveloffset=+1]
 
 // Topology
-== Installing the Topology plugin
-include::../modules/dynamic-plugins/proc-topology-install.adoc[leveloffset=+2]
-
-include::../assembly-topology-plugin-configure.adoc[leveloffset=+1]
-
-include::../assembly-managing-labels-annotations-topology.adoc[leveloffset=+1]
-
-include::../assembly-bulk-importing-from-github.adoc[leveloffset=+1]
-
-include::../assembly-using-servicenow.adoc[leveloffset=+1]
-
-include::../assembly-using-kubernetes-custom-actions.adoc[leveloffset=+1]
+include::../dynamic-plugins/assembly-install-topology-plugin.adoc[leveloffset=+1]
 
 // Overriding Core Backend Service Configuration
 include::../modules/dynamic-plugins/con-overriding-core-backend-services.adoc[leveloffset=+1]

assemblies/dynamic-plugins/assembly-install-topology-plugin.adoc

@@ -0,0 +1,14 @@
+[id="install-topology-plugin_{context}"]
+= Installing the Topology plugin
+
+include::../modules/dynamic-plugins/proc-topology-install.adoc[leveloffset=+2]
+
+include::../assembly-topology-plugin-configure.adoc[leveloffset=+1]
+
+include::../assembly-managing-labels-annotations-topology.adoc[leveloffset=+1]
+
+include::../assembly-bulk-importing-from-github.adoc[leveloffset=+1]
+
+include::../assembly-using-servicenow.adoc[leveloffset=+1]
+
+include::../assembly-using-kubernetes-custom-actions.adoc[leveloffset=+1]

modules/dynamic-plugins/proc-namespace-annotation.adoc

@@ -2,14 +2,15 @@
 
 = Namespace annotation
 
-To identify the Kubernetes resources using the defined namespace, add the `backstage.io/kubernetes-namespace` annotation:
-
+.Procedure
+* To identify the Kubernetes resources using the defined namespace, add the `backstage.io/kubernetes-namespace` annotation:
++
 [source,yaml]
 ----
 annotations:
   backstage.io/kubernetes-namespace: <RESOURCE_NS>
 ----
-
++
 The Red Hat OpenShift Dev Spaces instance is not accessible using the source code editor if the `backstage.io/kubernetes-namespace` annotation is added to the `catalog-info.yaml` file.
-
++
 To retrieve the instance URL, you require the CheCluster custom resource (CR). As the CheCluster CR is created in the openshift-devspaces namespace, the instance URL is not retrieved if the namespace annotation value is not openshift-devspaces.

modules/dynamic-plugins/proc-node-connector.adoc

@@ -2,8 +2,9 @@
 
 = Node connector
 
+.Procedure
 To display the workload resources such as deployments or pods with a visual connector, add the following annotation:
-
++
 [source,yaml]
 ----
 annotations:

modules/dynamic-plugins/proc-viewing-openshift-routes.adoc

@@ -1,8 +1,9 @@
 [id="proc-viewing-openshift-routes_{context}"]
 = Viewing OpenShift routes
 
-To view OpenShift routes, you must grant read access to the routes resource in the Cluster Role:
-
+.Procedure
+. To view OpenShift routes, grant read access to the routes resource in the Cluster Role:
++
 [source,yaml]
 ----
   apiVersion: rbac.authorization.k8s.io/v1
@@ -19,9 +20,8 @@ To view OpenShift routes, you must grant read access to the routes resource in t
         - get
         - list
 ----
-
-You must also add the following in `kubernetes.customResources` property in your `{my-app-config-file}` file:
-
+. Also add the following in `kubernetes.customResources` property in your `{my-app-config-file}` file:
++
 [source,yaml]
 ----
 kubernetes:

modules/dynamic-plugins/proc-viewing-pod-logs.adoc

@@ -1,8 +1,9 @@
 [id="proc-viewing-pod-logs_{context}"]
 = Viewing pod logs
 
-To view pod logs, you must grant the following permission to the `ClusterRole`:
-
+.Procedure
+* To view pod logs, you must grant the following permission to the `ClusterRole`:
++
 [source,yaml]
 ----
  apiVersion: rbac.authorization.k8s.io/v1

modules/dynamic-plugins/proc-viewing-tekton-pipelineruns.adoc

@@ -1,8 +1,9 @@
 [id="proc-viewing-tekton-pipelineruns_{context}"]
 = Viewing Tekton PipelineRuns
 
-To view the Tekton PipelineRuns you must grant read access to the `pipelines`, `pipelinesruns`, and `taskruns` resources in the `ClusterRole`:
-
+.Procedure
+. To view the Tekton PipelineRuns, grant read access to the `pipelines`, `pipelinesruns`, and `taskruns` resources in the `ClusterRole`:
++
 [source,yaml]
 ----
  ...
@@ -22,9 +23,8 @@ To view the Tekton PipelineRuns you must grant read access to the `pipelines`, `
         - get
         - list
 ----
-
-To view the Tekton PipelineRuns list in the side panel and the latest PipelineRuns status in the Topology node decorator, you must add the following code to the `kubernetes.customResources` property in your `{my-app-config-file}` file:
-
+. To view the Tekton PipelineRuns list in the side panel and the latest PipelineRuns status in the Topology node decorator, add the following code to the `kubernetes.customResources` property in your `{my-app-config-file}` file:
++
 [source,yaml]
 ----
 kubernetes:

modules/dynamic-plugins/proc-viewing-virtual-machines.adoc

@@ -1,9 +1,11 @@
 [id="proc-viewing-virtual-machines_{context}"]
 = Viewing virtual machines
 
-To view virtual machines, the OpenShift Virtualization operator must be installed and configured on a Kubernetes cluster.
-You must also grant read access to the `VirtualMachines` resource in the `ClusterRole`:
-
+.Prerequisites
+. The OpenShift Virtualization operator is installed and configured on a Kubernetes cluster.
+.Procedure
+. Grant read access to the `VirtualMachines` resource in the `ClusterRole`:
++
 [source,yaml]
 ----
  ...
@@ -22,9 +24,8 @@ You must also grant read access to the `VirtualMachines` resource in the `Cluste
         - get
         - list
 ----
-
-To view the virtual machine nodes on the topology plugin, you must add the following code to the `kubernetes.customResources` property in the `{my-app-config-file}` file:
-
+. To view the virtual machine nodes on the topology plugin, add the following code to the `kubernetes.customResources` property in the `{my-app-config-file}` file:
++
 [source,yaml]
 ----
 kubernetes: