Skip to content

Commit

Permalink
Fixes broken links in the MTA 7.0 Rules development guide
Browse files Browse the repository at this point in the history
  • Loading branch information
RichardHoch committed Jun 10, 2024
1 parent caf4797 commit d537814
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 22 deletions.
3 changes: 1 addition & 2 deletions docs/topics/create-yaml-rule.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -125,8 +125,7 @@ The table below lists all available providers, their capabilities, and their fie
|Yes
|Finds files with names matching this pattern
|`hasTags`
3+>|This is an inline list of string tags. See _Tag Action_ for details on tag format.

3+.^| This is an inline list of string tags. See *Tag Actions* in xref:yaml-rule-actions_{context}[Rule Actions] for details on tag format.
.5+.^|`go`
|`referenced`
|`pattern`
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/rules-important-links.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@
[id="rules-important-links_{context}"]
= Additional resources

* {ProductShortName} Javadoc: http://windup.github.io/windup/docs/latest/javadoc
// * {ProductShortName} Javadoc: http://windup.github.io/windup/docs/latest/javadoc
* {ProductShortName} Jira issue tracker: {JiraWindupURL}
* {ProductShortName} mailing list: [email protected]
2 changes: 1 addition & 1 deletion docs/topics/templates/document-attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ endif::[]
:ProductDocVscGuideURL: https://access.redhat.com/documentation/en-us/{DocInfoProductNameURL}/{DocInfoProductNumber}/html-single/visual_studio_code_extension_guide
:ProductDocIntelliJGuideURL: https://access.redhat.com/documentation/en-us/{DocInfoProductNameURL}/{DocInfoProductNumber}/html-single/intellij_idea_plugin_guide
:OpenShiftDocsURL: https://docs.openshift.com/container-platform/{OpenShiftProductNumber}
:LinkAPI: http://windup.github.io/windup/docs/latest/javadoc/
:LinkAPI: https://github.com/windup/windup/blob/master/reporting/api/src/main/java/

//Links to MTA and MTR Jira project pages:
:JiraMTRURL: https://issues.redhat.com/projects/WINDUP
Expand Down
9 changes: 6 additions & 3 deletions docs/topics/testing-rules.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ The `<not>` element has no unique attributes or child elements.
[discrete]
===== Summary

The `<iterable-filter>` element counts the number of times a condition is verified. For additional information, see the link:{LinkAPI}org/jboss/windup/rules/general/IterableFilter.html[IterableFilter] class.
The `<iterable-filter>` element counts the number of times a condition is verified. For additional information, see the link:https://github.com/windup/windup/blob/master/rules-base/api/src/main/java/org/jboss/windup/rules/general/IterableFilter.java[IterableFilter] class.

The following is an example that looks for four instances of the specified message.

Expand Down Expand Up @@ -158,7 +158,10 @@ The `<iterable-filter>` element has no unique child elements.
[id="classification_exists_syntax_{context}"]
==== <classification-exists> syntax

The `<classification-exists>` element determines if a specific classification title has been included in the analysis. For additional information, see the link:{LinkAPI}org/jboss/windup/reporting/config/ClassificationExists.html[ClassificationExists] class.
The `<classification-exists>` element determines if a specific classification title has been included in the analysis. For additional information, see the link:{LinkAPI}org/jboss/windup/reporting/config/ClassificationExists.java[ClassificationExists] class.

ink:{LinkAPI}org/jboss/windup/rules/general/IterableFilter.java[IterableFilter] class.


[IMPORTANT]
====
Expand Down Expand Up @@ -226,7 +229,7 @@ The `<classification-exists>` has no unique child elements.
[id="hint-exists-syntax_{context}"]
==== <hint-exists> syntax

The `<hint-exists>` element determines if a specific hint has been included in the analysis. It searches for any instances of the defined message, and is typically used to search for the beginning or a specific class inside of a `<message>` element. For additional information, see the link:{LinkAPI}org/jboss/windup/reporting/config/HintExists.html[HintExists] class.
The `<hint-exists>` element determines if a specific hint has been included in the analysis. It searches for any instances of the defined message, and is typically used to search for the beginning or a specific class inside of a `<message>` element. For additional information, see the link:{LinkAPI}org/jboss/windup/reporting/config/HintExists.java[HintExists] class.

[IMPORTANT]
====
Expand Down
26 changes: 11 additions & 15 deletions docs/topics/yaml-rule-structure-syntax.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,8 @@ effort: 1 <3>
category: mandatory <4>
----
<1> The ID must be unique within the ruleset to which the rule belongs.

<2> See below for a description of the label format.

<3> `effort` is an integer value that indicates the level of effort needed to fix this issue.

<4> `category` describes the severity of the issue for migration. The value can be either `mandatory`, `optional` or `potential`. For a description of these categories, see xref:yaml-rule-categories_{context}[Rule categories].

[id="yaml-rule-labels_{context}"]
Expand Down Expand Up @@ -334,7 +331,7 @@ The `java` provider analyzes Java source code.
This provider has the following capabilities:

* `referenced`
* `dependency`.
* `dependency`

.`referenced`

Expand All @@ -348,7 +345,7 @@ when:
location: "<location>" <2>
----
<1> A RegEx pattern to match, for example, `org.kubernetes.*`
<2> Specifies the exact location where the pattern needs to be matched, for example, `IMPORT`
<2> Specifies the exact location where the pattern needs to be matched, for example, `IMPORT`.

The supported locations are the following:

Expand All @@ -375,9 +372,9 @@ when:
upperbound: "<version_string>" <2>
lowerbound: "<version_string>" <3>
----
<1> Name of the dependency to search for
<2> Upper bound on the version of the dependency
<3> Lower bound on the version of the dependency
<1> Name of the dependency to search for.
<2> Upper bound on the version of the dependency.
<3> Lower bound on the version of the dependency.

===== `go` provider

Expand Down Expand Up @@ -405,9 +402,9 @@ when:
upperbound: "<version_string>" <2>
lowerbound: "<version_string>" <3>
----
<1> Name of the dependency to search for
<2> Upper bound on the version of the dependency
<3> Lower bound on the version of the dependency
<1> Name of the dependency to search for.
<2> Upper bound on the version of the dependency.
<3> Lower bound on the version of the dependency.

==== Custom variables

Expand All @@ -426,9 +423,9 @@ Provider conditions can have associated custom variables. You can use custom var
pattern: com.example.apps.GenericClass.get
----
<1> `pattern`: A RegEx pattern that is matched on the source code line when a match is found
<2> `name`: The name of the variable that can be used in templates
<3> `message`: A template for a message using a custom variable
<1> `pattern`: A RegEx pattern that is matched on the source code line when a match is found.
<2> `name`: The name of the variable that can be used in templates.
<3> `message`: A template for a message using a custom variable.


=== Logical conditions
Expand Down Expand Up @@ -521,5 +518,4 @@ labels: <2>
- key=val
----
<1> The name must be unique within the provided rulesets.

<2> Ruleset labels are inherited by all rules that belong to the ruleset.

0 comments on commit d537814

Please sign in to comment.