Skip to content

Commit 96f3bae

Browse files
author
Prabha Kylasamiyer Sundara Rajan
committed
Fixed a few xrefs
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <[email protected]>
1 parent 870e387 commit 96f3bae

File tree

3 files changed

+19
-9
lines changed

3 files changed

+19
-9
lines changed

assemblies/rules-development-guide/assembly_rule-yaml-actions.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,10 @@ endif::[]
1919
You can use rule actions to generate information about the source code. The rule action information can be included in a violation or used to categorize the source code.
2020

2121
Rules can include the following types of actions:
22-
* `Message`: use message action to display an informative message in the static report that contains the violation triggered by the rule. See xref:yaml-message-actions_{context}[Message action] for more information.
23-
* `Tag`: use tags to categorize parts of the source code. For example, Backend=Java, where Backend is the key and Java is the value. See xref:yaml-tag-actions_{context}[Tag actions] for more information.
24-
Each rule includes either one of them or both of them.
2522

26-
include::topics/rules-development/yaml-rule-actions.adoc[leveloffset=+1]
23+
* `Message`: use message action to display an informative message in the static report that contains the violation triggered by the rule. See xref:yaml-message-actions_rule-yaml-actions[Message action] for more information.
24+
* `Tag`: use tags to categorize parts of the source code. For example, Backend=Java, where Backend is the key and Java is the value. See xref:yaml-tag-actions_rule-yaml-actions[Tag actions] for more information.
25+
Each rule includes either one of them or both of them.
2726
2827
include::topics/rules-development/yaml-tag-actions.adoc[leveloffset=+1]
2928

docs/topics/rules-development/yaml-custom-variables.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
= Custom variables
88

99
[role="_abstract"]
10-
Provider conditions can have associated custom variables. You can use custom variables to capture relevant information from the matched line in the source code. The values of these variables are interpolated with data matched in the source code. These values can be used to generate detailed template messages in a rule's action (see xref:yaml-rule-actions_rule-yaml-actions[Message actions]). They can be added to a rule in the `customVariables` field:
10+
Provider conditions can have associated custom variables. You can use custom variables to capture relevant information from the matched line in the source code. The values of these variables are interpolated with data matched in the source code. These values can be used to generate detailed template messages in a rule's action (see xref:yaml-message-actions_rule-yaml-actions[Message actions]). They can be added to a rule in the `customVariables` field:
1111

1212
[source,yaml]
1313
----

docs/topics/rules-development/yaml-message-actions.adoc

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,26 @@
77
= Message action
88

99
[role="_abstract"]
10-
A message action is employed to generate an issue with the specified message when a rule matches, for example:
10+
A message action is used to generate an issue with the specified message when a rule condition matches the source code, for example:
1111

1212
[source,yaml]
1313
----
14-
# When a match is found, the analyzer generates incidents with the same message.
15-
message: "helpful message about the violation"
14+
- ruleID: test-rule
15+
message: Test rule matched. Please resolve this migration issue.
16+
when:
17+
<CONDITION>
18+
----
19+
20+
Optionally, a message can include hyperlinks to external URLs that provide relevant information about the issue or a quick fix.
21+
22+
[source,yaml]
23+
----
24+
links:
25+
- url: "konveyor.io"
26+
title: "Short title for the link"
1627
----
1728

18-
You can also create a template message to include information about the match that has been interpolated through custom variables on the rule.
29+
You can also create a template message to include information about the match that has been interpolated through xref:yaml-custom-variables_logical-chaining-custom-variables[custom variables] on the rule.
1930
// link link:#custom-variables[Custom Variables]):
2031

2132
[source,yaml]

0 commit comments

Comments
 (0)