Merge pull request #52108 from bergerhoffer/updating-admonition-syntax

bergerhoffer · web-flow · commit 97196f3c0ae4 · 2022-10-25T14:40:51.000-04:00
Fixing admonition syntax
diff --git a/logging/troubleshooting/cluster-logging-troubleshooting-for-critical-alerts.adoc b/logging/troubleshooting/cluster-logging-troubleshooting-for-critical-alerts.adoc
@@ -239,12 +239,15 @@ If the used disk percentage is above 85%, the node has exceeded the low watermar
 oc -n openshift-logging get es elasticsearch -o jsonpath='{.spec.redundancyPolicy}'
 ----
 +
-NOTE: If you are using a `ClusterLogging` CR, enter:
-+
+[NOTE]
+====
+If you are using a `ClusterLogging` CR, enter:
+
 [source,terminal]
 ----
 oc -n openshift-logging get cl -o jsonpath='{.items[*].spec.logStore.elasticsearch.redundancyPolicy}'
 ----
+====
 
 .. If the cluster `redundancyPolicy` is higher than `SingleRedundancy`, set it to `SingleRedundancy` and save this change.
 
@@ -319,12 +322,15 @@ The shards relocate to a node with low disk usage that has not crossed any water
 oc -n openshift-logging get es elasticsearch -o jsonpath='{.spec.redundancyPolicy}'
 ----
 +
-NOTE: If you are using a `ClusterLogging` CR, enter:
-+
+[NOTE]
+====
+If you are using a `ClusterLogging` CR, enter:
+
 [source,terminal]
 ----
 oc -n openshift-logging get cl -o jsonpath='{.items[*].spec.logStore.elasticsearch.redundancyPolicy}'
 ----
+====
 
 .. If the cluster `redundancyPolicy` is higher than `SingleRedundancy`, set it to `SingleRedundancy` and save this change.
 
@@ -386,12 +392,15 @@ Check the `nodes.node_name.fs` field to determine the free disk space on that no
 oc -n openshift-logging get es elasticsearch -o jsonpath='{.spec.redundancyPolicy}'
 ----
 +
-NOTE: If you are using a `ClusterLogging` CR, enter:
-+
+[NOTE]
+====
+If you are using a `ClusterLogging` CR, enter:
+
 [source,terminal]
 ----
 oc -n openshift-logging get cl -o jsonpath='{.items[*].spec.logStore.elasticsearch.redundancyPolicy}'
 ----
+====
 
 .. If the cluster `redundancyPolicy` is higher than `SingleRedundancy`, set it to `SingleRedundancy` and save this change.
 
@@ -482,12 +491,15 @@ for pod in `oc -n openshift-logging get po -l component=elasticsearch -o jsonpat
 oc -n openshift-logging get es elasticsearch -o jsonpath='{.spec.redundancyPolicy}'
 ----
 +
-NOTE: If you are using a `ClusterLogging` CR, enter:
-+
+[NOTE]
+====
+If you are using a `ClusterLogging` CR, enter:
+
 [source,terminal]
 ----
 oc -n openshift-logging get cl -o jsonpath='{.items[*].spec.logStore.elasticsearch.redundancyPolicy}'
 ----
+====
 
 .. If the cluster `redundancyPolicy` is higher than `SingleRedundancy`, set it to `SingleRedundancy` and save this change.
 
diff --git a/modules/developer-cli-odo-creating-and-deploying-a-nodejs-application-with-odo.adoc b/modules/developer-cli-odo-creating-and-deploying-a-nodejs-application-with-odo.adoc
@@ -60,7 +60,10 @@ $ cd <directory_name>
 $ odo create nodejs
 ----
 +
-NOTE: By default, the latest image is used. You can also explicitly specify an image version by using `odo create openshift/nodejs:8`.
+[NOTE]
+====
+By default, the latest image is used. You can also explicitly specify an image version by using `odo create openshift/nodejs:8`.
+====
 
 . Push the initial source code to the component:
 +
diff --git a/modules/developer-cli-odo-deploying-a-java-application-using-a-devfile.adoc b/modules/developer-cli-odo-deploying-a-java-application-using-a-devfile.adoc
@@ -68,7 +68,10 @@ The previous command produces the following output:
 To apply the URL configuration changes, please use odo push
 ----
 +
-NOTE: You must use your cluster host domain name when creating the URL.
+[NOTE]
+====
+You must use your cluster host domain name when creating the URL.
+====
 
 . Push the component to the cluster:
 +
diff --git a/modules/installation-rhv-customizing-install-config-yaml.adoc b/modules/installation-rhv-customizing-install-config-yaml.adoc
@@ -15,7 +15,10 @@ Here, you use three Python scripts to override some of the installation program'
 
 * By default, the installation program sets the platform to `ovirt`. However, installing a cluster on user-provisioned infrastructure is more similar to installing a cluster on bare metal. Therefore, you delete the ovirt platform section from `install-config.yaml` and change the platform to `none`. Instead, you use `inventory.yml` to specify all of the required settings.
 
-NOTE: These snippets work with Python 3 and Python 2.
+[NOTE]
+====
+These snippets work with Python 3 and Python 2.
+====
 
 // TBD - https://issues.redhat.com/browse/OCPRHV-414
 // Please discuss with engineering whether these three scripts can/should be combined into a single script.
diff --git a/modules/ipi-install-configure-multiple-cluster-nodes.adoc b/modules/ipi-install-configure-multiple-cluster-nodes.adoc
@@ -36,4 +36,7 @@ hosts:
  networkConfig: *BOND
 ----
 
-NOTE: Configuration of multiple cluster nodes is only available for initial deployments on installer-provisioned infrastructure.
+[NOTE]
+====
+Configuration of multiple cluster nodes is only available for initial deployments on installer-provisioned infrastructure.
+====
diff --git a/modules/nw-kube-proxy-config.adoc b/modules/nw-kube-proxy-config.adoc
@@ -7,7 +7,10 @@
 
 You can modify the following `kubeProxyConfig` parameters.
 
-IMPORTANT: Because of performance improvements introduced in {product-title} 4.3 and greater, adjusting the `iptablesSyncPeriod` parameter is no longer necessary.
+[NOTE]
+====
+Because of performance improvements introduced in {product-title} 4.3 and greater, adjusting the `iptablesSyncPeriod` parameter is no longer necessary.
+====
 
 .Parameters
 [cols="30%,30%,30%,10%",options="header"]
diff --git a/modules/nw-multus-host-device-object.adoc b/modules/nw-multus-host-device-object.adoc
@@ -5,8 +5,11 @@
 [id="nw-multus-host-device-object_{context}"]
 = Configuration for a host device additional network
 
-IMPORTANT: Specify your network device by setting only one of the
+[NOTE]
+====
+Specify your network device by setting only one of the
 following parameters: `device`, `hwaddr`, `kernelpath`, or `pciBusID`.
+====
 
 The following object describes the configuration parameters for the host-device CNI plug-in:
 
diff --git a/modules/nw-operator-cr.adoc b/modules/nw-operator-cr.adoc
@@ -216,7 +216,10 @@ endif::operator[]
 |====
 
 ifdef::operator[]
-NOTE: You can only change the configuration for your cluster network provider during cluster installation.
+[NOTE]
+====
+You can only change the configuration for your cluster network provider during cluster installation.
+====
 endif::operator[]
 
 .Example OpenShift SDN configuration
@@ -348,7 +351,10 @@ If you set this field to `true`, you do not receive the performance benefits of
 |====
 
 ifdef::operator[]
-NOTE: You can only change the configuration for your cluster network provider during cluster installation, except for the `gatewayConfig` field that can be changed at runtime as a post-installation activity.
+[NOTE]
+====
+You can only change the configuration for your cluster network provider during cluster installation, except for the `gatewayConfig` field that can be changed at runtime as a post-installation activity.
+====
 endif::operator[]
 
 .Example OVN-Kubernetes configuration with IPSec enabled
diff --git a/modules/ossm-mixer-policy-1x.adoc b/modules/ossm-mixer-policy-1x.adoc
@@ -11,7 +11,10 @@ In previous versions of {SMProductName}, Mixer's policy enforcement was enabled
 .Prerequisites
 * Access to the OpenShift CLI (`oc`).
 
-NOTE: The examples use `<istio-system>` as the control plane namespace. Replace this value with the namespace where you deployed the Service Mesh Control Plane (SMCP).
+[NOTE]
+====
+The examples use `<istio-system>` as the control plane namespace. Replace this value with the namespace where you deployed the Service Mesh Control Plane (SMCP).
+====
 
 .Procedure
 
diff --git a/modules/ossm-threescale-metrics.adoc b/modules/ossm-threescale-metrics.adoc
@@ -7,7 +7,10 @@
 = 3scale Adapter metrics
 The adapter, by default reports various Prometheus metrics that are exposed on port `8080` at the `/metrics` endpoint. These metrics provide insight into how the interactions between the adapter and 3scale are performing. The service is labeled to be automatically discovered and scraped by Prometheus.
 
-NOTE: There are incompatible changes in the 3scale Istio Adapter metrics since the previous releases in Service Mesh 1.x.
+[NOTE]
+====
+There are incompatible changes in the 3scale Istio Adapter metrics since the previous releases in Service Mesh 1.x.
+====
 
 In Prometheus, metrics have been renamed with one addition for the backend cache, so that the following metrics exist as of Service Mesh 2.0:
 
diff --git a/modules/recommended-etcd-practices.adoc b/modules/recommended-etcd-practices.adoc
@@ -27,7 +27,10 @@ The following hard disk features provide optimal etcd performance:
 
 Avoid NAS or SAN setups and spinning drives. Always benchmark by using utilities such as fio. Continuously monitor the cluster performance as it increases.
 
-IMPORTANT: Avoid using the Network File System (NFS) protocol or other network based file systems.
+[NOTE]
+====
+Avoid using the Network File System (NFS) protocol or other network based file systems.
+====
 
 Some key metrics to monitor on a deployed {product-title} cluster are p99 of etcd disk write ahead log duration and the number of etcd leader changes. Use Prometheus to track these metrics.
 
diff --git a/modules/restore-replace-stopped-baremetal-etcd-member.adoc b/modules/restore-replace-stopped-baremetal-etcd-member.adoc
@@ -434,7 +434,7 @@ spec:
 EOF
 ----
 +
-[Note]
+[NOTE]
 ====
 The username and password can be found from the other bare metal host's secrets. The protocol to use in `bmc:address` can be taken from other bmh objects.
 ====
diff --git a/modules/threescale-backend-cache.adoc b/modules/threescale-backend-cache.adoc
@@ -8,7 +8,10 @@
 
 The 3scale backend cache provides an authorization and reporting cache for clients of the 3scale Service Management API. This cache is embedded in the adapter to enable lower latencies in responses in certain situations assuming the administrator is willing to accept the trade-offs.
 
-NOTE: 3scale backend cache is disabled by default. 3scale backend cache functionality trades inaccuracy in rate limiting and potential loss of hits since the last flush was performed for low latency and higher consumption of resources in the processor and memory.
+[NOTE]
+====
+3scale backend cache is disabled by default. 3scale backend cache functionality trades inaccuracy in rate limiting and potential loss of hits since the last flush was performed for low latency and higher consumption of resources in the processor and memory.
+====
 
 == Advantages of enabling backend cache
 

Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,10 @@ $ cd <directory_name>`
`60`	`60`	`$ odo create nodejs`
`61`	`61`	`----`
`62`	`62`	`+`
`63`		-NOTE: By default, the latest image is used. You can also explicitly specify an image version by using `odo create openshift/nodejs:8`.
	`63`	`+[NOTE]`
	`64`	`+====`
	`65`	+By default, the latest image is used. You can also explicitly specify an image version by using `odo create openshift/nodejs:8`.
	`66`	`+====`
`64`	`67`
`65`	`68`	`. Push the initial source code to the component:`
`66`	`69`	`+`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,10 @@ The previous command produces the following output:`
`68`	`68`	`To apply the URL configuration changes, please use odo push`
`69`	`69`	`----`
`70`	`70`	`+`
`71`		`-NOTE: You must use your cluster host domain name when creating the URL.`
	`71`	`+[NOTE]`
	`72`	`+====`
	`73`	`+You must use your cluster host domain name when creating the URL.`
	`74`	`+====`
`72`	`75`
`73`	`76`	`. Push the component to the cluster:`
`74`	`77`	`+`