Fixed the rule indentation and added location descriptions

Prabha Kylasamiyer Sundara Rajan · Prabha Kylasamiyer Sundara Rajan · commit 32146b04658b · 2025-12-12T17:45:01.000+05:30
Signed-off-by: Prabha Kylasamiyer Sundara Rajan &lt;pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb&gt;
diff --git a/docs/topics/rules-development/create-go-custom-rule.adoc b/docs/topics/rules-development/create-go-custom-rule.adoc
@@ -9,10 +9,10 @@
 [role="_abstract"]
 You can create custom rules for Golang (Go) applications based on the following example.
 
-You can use the following custom rule to check if MTA triggers an incident when it detects a go file in your project.
+You can use the following custom rule to check if {ProductShortName} triggers an incident when it detects a `go` file in your project.
 
 .Procedure
-. Create a `go-rule-001.yml` file in a directory. .
+. Create a `go-rule-001.yml` file in a directory. 
 
 . Copy the following rule in the `yaml` file:
 +
@@ -54,16 +54,16 @@ func main() {
 
 [source, terminal]
 ----
-$ ./mta-cli analyze -i <path_to_Go_project> -o <path_to_report_directory> \ --run-local=false --rules <path_to_go-rule-001.yml>
+$ ./mta-cli analyze -i _<path_to_Go_project>_ -o _<path_to_report_directory>_ \ --run-local=false --rules _<path_to_go-rule-001.yml>_
 ----
 +
 
 [NOTE]
 ====
-Add the --overwrite option if you want to use the same directory for the report when you run subsequent tests. {ProductShortName} overwrites the current report with the result of the latest analysis that you run.
+Add the `--overwrite` option if you want to use the same directory for the report when you run subsequent tests. {ProductShortName} overwrites the current report with the result of the latest analysis that you run.
 ====
 
-. Open the static report in the path `/home/<USER>/output/static-report/` in your browser.
+. Open the static report at `/home/<USER>/output/static-report/` in your browser.
 
 . Navigate to the issues to verify the `golang apiextensions/v1/customresourcedefinitions found {{file}}:{{lineNumber}}` issue.
 
diff --git a/docs/topics/rules-development/create-nodejs-custom-rule.adoc b/docs/topics/rules-development/create-nodejs-custom-rule.adoc
@@ -7,12 +7,12 @@
 = Creating a custom Node.js rule
 
 [role="_abstract"]
-{ProductShortName} requires you to create custom rules to analyze `Node.js` applications. A `Node.js` rule can contain `nodejs.referenced` capability which supports the `pattern` field. 
+ You must create custom rules to analyze `Node.js` applications by using {ProductShortName}. A `Node.js` rule can contain `nodejs.referenced` capability which supports the `pattern` field. 
 
 The following example uses a custom rule to check if a `.tsx` file in the `Node.js` project imports the `React` framework.
 
 .Procedure
-. Create the directory `test-nodejs`.
+. Create the `test-nodejs` directory.
 +
 
 [source, terminal]
@@ -25,7 +25,7 @@ $ mkdir -p ~/test-nodejs
 [source, yaml]
 ----
 - ruleID: test-tsx-support-00000
-  description: "Found React import in .tsx file"
+  description: Found React import in .tsx file
   message: Found React import in .tsx file
   effort: 1
   when:
@@ -55,12 +55,12 @@ $ ./mta-cli analyze -i ~/test-nodejs/ -o \
 
 [NOTE]
 ====
-Add the --overwrite option if you want to use the same directory for the report when you run subsequent tests. {ProductShortName} overwrites the current report with the result of the latest analysis that you run.
+Add the `--overwrite` option if you want to use the same directory for the report when you run subsequent tests. {ProductShortName} overwrites the current report with the result of the latest analysis that you run.
 ====
 
 . Open the static report at `~/test-nodejs/report/static-report/index.html` in your browser.
 
-. Click the <application_name> to open the Dashboard.
+. Click the _<application_name>_ to open the Dashboard.
 
 . Review the incidents in the *Issues* tab.
 
diff --git a/docs/topics/rules-development/create-python-custom-rule.adoc b/docs/topics/rules-development/create-python-custom-rule.adoc
@@ -7,14 +7,16 @@
 = Creating custom Python rules
 
 [role="_abstract"]
-{ProductShortName} requires you to create custom rules to analyze `Python` applications. A `Python` rule can contain `python.referenced` capability with the supported fields. 
+You must create custom rules to analyze `Python` applications by using {ProductShortName}. A `Python` rule can contain `python.referenced` capability with the supported fields. 
 
-The following example uses two custom rules: the first rule checks if `bad_method` is specified and the second rule checks if `hello_world` is specified in `file_a.py` in your project.
+The following example uses two custom rules: 
+
+* The first rule checks if `bad_method` is specified 
+* The second rule checks if `hello_world` is specified in `file_a.py` in your project.
 
 .Procedure
 . Create the directory `test-python`.
 +
-
 [source, terminal]
 ----
 $ mkdir -p ~/test-python
@@ -35,16 +37,15 @@ $ mkdir -p ~/test-python
 
 . Create a `python-rule-002.yml` file in the directory and add the following rule:
 +
-
 [source, yaml]
 ----
-- category: mandatory
-  ruleID: python-rule-002
-  effort: 1
-  message: "Found a python"
-  when:
-    python.referenced:
-      pattern: "hello_world"
+  - category: mandatory
+    ruleID: python-rule-002
+    effort: 1
+    message: "Found a python"
+    when:
+      python.referenced:
+        pattern: "hello_world"
 ----
 
 . Save the following `Python` code as `file_b.py`.
@@ -62,7 +63,6 @@ def bad_method():
 
 . Save the following code as a second file, `file_a.py`.
 +
-
 [source, python]
 ----
 import file_b
@@ -72,7 +72,6 @@ print(file_b.bad_method())
 
 . Run the following command in the {ProductShortName} CLI:
 +
-
 [source, terminal]
 ----
 $ ./mta-cli analyze -i ~/test-python/ -o \
@@ -84,12 +83,12 @@ $ ./mta-cli analyze -i ~/test-python/ -o \
 
 [NOTE]
 ====
-Add the --overwrite option if you want to use the same directory for the report when you run subsequent tests. {ProductShortName} overwrites the current report with the result of the latest analysis that you run.
+Add the `--overwrite` option if you want to use the same directory for the report when you run subsequent tests. {ProductShortName} overwrites the current report with the result of the latest analysis that you run.
 ====
 
 . Open the static report at `~/test-python/report/static-report/index.html` in your browser.
 
-. Click the <application_name> to open the Dashboard.
+. Click the _<application_name>_ to open the Dashboard.
 
 . Review the incidents in the *Issues* tab.
 
diff --git a/docs/topics/rules-development/yaml-java-locations.adoc b/docs/topics/rules-development/yaml-java-locations.adoc
@@ -167,8 +167,8 @@ when:
    location: METHOD
    pattern: '* java.lang.String' 
 ----
-|METHOD_CALL|Matches against method calls in the source code.
-a|
+|METHOD_CALL|Matches against the method call in the source code.
+a|The following example matches the `getConnection` method call of the `java.sql.DriverManager` class with three parameters of type `String`.
 [source, yaml]
 ----
 when:
@@ -187,7 +187,7 @@ when:
   pattern: javax.xml*
 ----
 |CONSTRUCTOR_CALL|Matches against constructor calls in the source code.
-a|The following example 
+a|The following example matches the `FileOutputStream` constructor call that takes a String and a boolean value as input parameters.
 [source, yaml]
 ----
 when:
@@ -196,7 +196,7 @@ when:
     pattern: java.io.FileOutputStream(java.lang.String, boolean)
 ----
 |IMPORT|Matches against class imports. You can use it with FQNs or an asterisk (*) to allow for wider matches.
-a|
+a|The following example matches with the import of `org.apache.lucene.search` package and sub packages in the source code.
 [source, yaml]
 ----
 when:
