[1.2.x] RHIDP 3484 Fix Syntax Highlighting (#483)

openshift-cherrypick-robot · jmagak · web-flow · commit b5ccea8da310 · 2024-09-06T18:14:36.000+02:00
* Fixes syntax highlighting

* Fixes syntax highlighting

* change syntax highlighting

* updates syntax highlighting

---------

Co-authored-by: jmagak &lt;jmagak@redhat.com&gt;
diff --git a/artifacts/rhdh-plugins-reference/argocd/argocd-plugin-readme.adoc b/artifacts/rhdh-plugins-reference/argocd/argocd-plugin-readme.adoc
@@ -11,7 +11,7 @@ You can use the Argo CD plugin to visualize the Continuous Delivery (CD) workflo
 * Add Argo CD instance information to your `app-config.yaml` configmap as shown in the following example:
 
 +
-[source,typescript]
+[source,yaml]
 ----
 argocd:
   appLocatorMethods:
diff --git a/assemblies/assembly-add-custom-app-file-openshift.adoc b/assemblies/assembly-add-custom-app-file-openshift.adoc
@@ -3,7 +3,7 @@
 
 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]
+[source,yaml]
 ----
 kind: ConfigMap
 apiVersion: v1
diff --git a/modules/admin/proc-configuring-postgresql-instance-using-helm.adoc b/modules/admin/proc-configuring-postgresql-instance-using-helm.adoc
@@ -24,7 +24,7 @@ By default, {product-short} uses a database for each plugin and automatically cr
 
 . Optional: Create a certificate secret to configure your PostgreSQL instance with a TLS connection: 
 +
-[source,yaml]
+[source,terminal]
 ----
 cat <<EOF | oc -n <your-namespace> create -f -
 apiVersion: v1
@@ -52,7 +52,7 @@ EOF
 
 . Create a credential secret to connect with the PostgreSQL instance:
 +
-[source,yaml]
+[source,terminal]
 ----
 cat <<EOF | oc -n <your-namespace> create -f -
 apiVersion: v1
diff --git a/modules/admin/proc-configuring-postgresql-instance-using-operator.adoc b/modules/admin/proc-configuring-postgresql-instance-using-operator.adoc
@@ -76,7 +76,7 @@ EOF
 
 . Create a `Backstage` custom resource (CR):
 +
-[source,yaml]
+[source,terminal]
 ----
 cat <<EOF | oc -n <your-namespace> create -f -
 apiVersion: rhdh.redhat.com/v1alpha1
diff --git a/modules/admin/proc-migrating-databases-to-an-external-server.adoc b/modules/admin/proc-migrating-databases-to-an-external-server.adoc
@@ -35,7 +35,7 @@ oc port-forward -n developer-hub backstage-psql-developer-hub-0 15432:5432
 
 . Make a copy of the following `db_copy.sh` script and edit the details based on your configuration:
 +
-[source,script]
+[source,bash]
 ----
 #!/bin/bash
 
diff --git a/modules/dynamic-plugins/proc-rhdh-example-external-dynamic-plugins.adoc b/modules/dynamic-plugins/proc-rhdh-example-external-dynamic-plugins.adoc
@@ -9,6 +9,7 @@ The NPM registry contains external dynamic plugins that you can use for demonstr
 
 To install the Notifications and Kubernetes actions plugins, include them in the Helm chart values in the `global.dynamic.plugins` list as shown in the following example:
 
+[source,yaml]
 ----
 global:
   dynamic:
diff --git a/modules/dynamic-plugins/proc-using-custom-npm-registry.adoc b/modules/dynamic-plugins/proc-using-custom-npm-registry.adoc
@@ -10,6 +10,8 @@ You can install external plugins in an air-gapped environment by setting up a cu
 You can configure the NPM registry URL and authentication information for dynamic plugin packages using a Helm chart. For dynamic plugin packages obtained through `npm pack`, you can use a `.npmrc` file. 
 
 Using the Helm chart, add the `.npmrc` file to the NPM registry by creating a secret named `dynamic-plugins-npmrc` with the following content:
+
+[source,yaml]
 ----
 apiVersion: v1
 kind: Secret
diff --git a/modules/dynamic-plugins/ref-example-dynamic-plugin-helm-installations.adoc b/modules/dynamic-plugins/ref-example-dynamic-plugin-helm-installations.adoc
@@ -5,7 +5,7 @@
 The following examples demonstrate how to configure the Helm chart for specific types of dynamic plugin installations. 
 
 .Configuring a local plugin and an external plugin when the external plugin requires a specific app-config
-[source,java]
+[source,yaml]
 ----
 global:
   dynamic:
@@ -17,7 +17,7 @@ global:
 ----
 
 .Disabling a plugin from an included file
-[source,java]
+[source,yaml]
 ----
 global:
   dynamic:
@@ -29,7 +29,7 @@ global:
 ----
 
 .Enabling a plugin from an included file
-[source,java]
+[source,yaml]
 ----
 global:
   dynamic:
@@ -41,7 +41,7 @@ global:
 ----
 
 .Enabling a plugin that is disabled in an included file
-[source,java]
+[source,yaml]
 ----
 global:
   dynamic:
diff --git a/modules/getting-started/proc-add-source-control-rhdh-catalog.adoc b/modules/getting-started/proc-add-source-control-rhdh-catalog.adoc
@@ -60,7 +60,7 @@ The configuration of GitHub authentication is required to enable the GitHub OAut
 . Modify your `app-config-rhdh` ConfigMap to include the GitHub authentication configuration as follows:
 +
 --
-[source]
+[source,yaml]
 ----
 kind: ConfigMap
 apiVersion: v1
@@ -172,7 +172,7 @@ The configuration of GitHub is required to enable the GitHub plugins in {product
 . Modify your `app-config-rhdh` ConfigMap to include the GitHub integration configuration as follows:
 +
 --
-[source]
+[source,yaml]
 ----
 kind: ConfigMap
 apiVersion: v1
diff --git a/modules/getting-started/proc-customize-rhdh-homepage.adoc b/modules/getting-started/proc-customize-rhdh-homepage.adoc
@@ -146,7 +146,7 @@ If the request call fails or is not configured, the {product-short} instance fal
 
 * If the images or icons do not load, then allowlist them by adding your image or icon host URLs to the content security policy’s (csp) `img-src` in your custom ConfigMap as follows:
 
-[source]
+[source,yaml]
 ----
 kind: ConfigMap
 apiVersion: v1
diff --git a/modules/getting-started/proc-enable-servicenow-custom-actions-plugin.adoc b/modules/getting-started/proc-enable-servicenow-custom-actions-plugin.adoc
@@ -15,7 +15,7 @@ In {product}, the ServiceNow custom actions are provided as a pre-loaded plugin,
 . To activate the custom actions plugin, add a `package` with plugin name and update the `disabled` field in your Helm Chart as follows:
 +
 --
-[source]
+[source,yaml]
 ----
 global:
   dynamic:
@@ -35,7 +35,7 @@ The default configuration for a plugin is extracted from the `dynamic-plugins.de
 . Set the following variables in the Helm Chart to access the custom actions:
 +
 --
-[source]
+[source,yaml]
 ----
 servicenow:
   # The base url of the ServiceNow instance.
diff --git a/modules/getting-started/proc-techdocs-publish-site.adoc b/modules/getting-started/proc-techdocs-publish-site.adoc
@@ -16,7 +16,7 @@ npx @techdocs/cli publish --publisher-type <awsS3|googleGcs> --storage-name <buc
 
 . Add a `.github/workflows/techdocs.yml` file in your Software Template(s). For example:
 +
-[source]
+[source,yaml]
 ----
 name: Publish TechDocs Site
 
diff --git a/modules/getting-started/ref-techdocs-example-config-plugin-operator.adoc b/modules/getting-started/ref-techdocs-example-config-plugin-operator.adoc
@@ -4,7 +4,7 @@
 
 The following example shows a {product} Operator config map configuration for the TechDocs plugin:
 
-[source]
+[source,yaml]
 ----
 kind: ConfigMap
 apiVersion: v1

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ You can use the Argo CD plugin to visualize the Continuous Delivery (CD) workflo`
`11`	`11`	* Add Argo CD instance information to your `app-config.yaml` configmap as shown in the following example:
`12`	`12`
`13`	`13`	`+`
`14`		`-[source,typescript]`
	`14`	`+[source,yaml]`
`15`	`15`	`----`
`16`	`16`	`argocd:`
`17`	`17`	`appLocatorMethods:`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ EOF`
`76`	`76`
`77`	`77`	. Create a `Backstage` custom resource (CR):
`78`	`78`	`+`
`79`		`-[source,yaml]`
	`79`	`+[source,terminal]`
`80`	`80`	`----`
`81`	`81`	`cat <<EOF \| oc -n <your-namespace> create -f -`
`82`	`82`	`apiVersion: rhdh.redhat.com/v1alpha1`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ oc port-forward -n developer-hub backstage-psql-developer-hub-0 15432:5432`
`35`	`35`
`36`	`36`	. Make a copy of the following `db_copy.sh` script and edit the details based on your configuration:
`37`	`37`	`+`
`38`		`-[source,script]`
	`38`	`+[source,bash]`
`39`	`39`	`----`
`40`	`40`	`#!/bin/bash`
`41`	`41`