Skip to content

Commit b09bb8e

Browse files
committed
Fixes broken links in the MTA 7.0 Rules development guide
1 parent caf4797 commit b09bb8e

File tree

5 files changed

+17
-22
lines changed

5 files changed

+17
-22
lines changed

docs/topics/create-yaml-rule.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,8 +125,7 @@ The table below lists all available providers, their capabilities, and their fie
125125
|Yes
126126
|Finds files with names matching this pattern
127127
|`hasTags`
128-
3+>|This is an inline list of string tags. See _Tag Action_ for details on tag format.
129-
128+
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.
130129
.5+.^|`go`
131130
|`referenced`
132131
|`pattern`

docs/topics/rules-important-links.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@
66
[id="rules-important-links_{context}"]
77
= Additional resources
88

9-
* {ProductShortName} Javadoc: http://windup.github.io/windup/docs/latest/javadoc
9+
// * {ProductShortName} Javadocs: {LinkAPI}reporting/api/src/main/java
1010
* {ProductShortName} Jira issue tracker: {JiraWindupURL}
1111
* {ProductShortName} mailing list: [email protected]

docs/topics/templates/document-attributes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ endif::[]
105105
:ProductDocVscGuideURL: https://access.redhat.com/documentation/en-us/{DocInfoProductNameURL}/{DocInfoProductNumber}/html-single/visual_studio_code_extension_guide
106106
:ProductDocIntelliJGuideURL: https://access.redhat.com/documentation/en-us/{DocInfoProductNameURL}/{DocInfoProductNumber}/html-single/intellij_idea_plugin_guide
107107
:OpenShiftDocsURL: https://docs.openshift.com/container-platform/{OpenShiftProductNumber}
108-
:LinkAPI: http://windup.github.io/windup/docs/latest/javadoc/
108+
:LinkAPI: https://github.com/windup/windup/blob/master/
109109

110110
//Links to MTA and MTR Jira project pages:
111111
:JiraMTRURL: https://issues.redhat.com/projects/WINDUP

docs/topics/testing-rules.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ The `<not>` element has no unique attributes or child elements.
9999
[discrete]
100100
===== Summary
101101

102-
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.
102+
The `<iterable-filter>` element counts the number of times a condition is verified. For additional information, see the link:{LinkAPI}rules-base/api/src/main/java/org/jboss/windup/rules/general/IterableFilter.java[IterableFilter] class.
103103

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

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

161-
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.
161+
The `<classification-exists>` element determines if a specific classification title has been included in the analysis. For additional information, see the link:{LinkAPI}reporting/api/src/main/java/org/jboss/windup/reporting/config/ClassificationExists.java[ClassificationExists] class.
162162

163163
[IMPORTANT]
164164
====
@@ -226,7 +226,7 @@ The `<classification-exists>` has no unique child elements.
226226
[id="hint-exists-syntax_{context}"]
227227
==== <hint-exists> syntax
228228

229-
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.
229+
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}reporting/api/src/main/java/org/jboss/windup/reporting/config/HintExists.java[HintExists] class.
230230

231231
[IMPORTANT]
232232
====

docs/topics/yaml-rule-structure-syntax.adoc

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,8 @@ effort: 1 <3>
3131
category: mandatory <4>
3232
----
3333
<1> The ID must be unique within the ruleset to which the rule belongs.
34-
3534
<2> See below for a description of the label format.
36-
3735
<3> `effort` is an integer value that indicates the level of effort needed to fix this issue.
38-
3936
<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].
4037

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

336333
* `referenced`
337-
* `dependency`.
334+
* `dependency`
338335

339336
.`referenced`
340337

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

353350
The supported locations are the following:
354351

@@ -375,9 +372,9 @@ when:
375372
upperbound: "<version_string>" <2>
376373
lowerbound: "<version_string>" <3>
377374
----
378-
<1> Name of the dependency to search for
379-
<2> Upper bound on the version of the dependency
380-
<3> Lower bound on the version of the dependency
375+
<1> Name of the dependency to search for.
376+
<2> Upper bound on the version of the dependency.
377+
<3> Lower bound on the version of the dependency.
381378

382379
===== `go` provider
383380

@@ -405,9 +402,9 @@ when:
405402
upperbound: "<version_string>" <2>
406403
lowerbound: "<version_string>" <3>
407404
----
408-
<1> Name of the dependency to search for
409-
<2> Upper bound on the version of the dependency
410-
<3> Lower bound on the version of the dependency
405+
<1> Name of the dependency to search for.
406+
<2> Upper bound on the version of the dependency.
407+
<3> Lower bound on the version of the dependency.
411408

412409
==== Custom variables
413410

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

433430

434431
=== Logical conditions
@@ -521,5 +518,4 @@ labels: <2>
521518
- key=val
522519
----
523520
<1> The name must be unique within the provided rulesets.
524-
525521
<2> Ruleset labels are inherited by all rules that belong to the ruleset.

0 commit comments

Comments
 (0)