diff --git a/docs/topics/create-yaml-rule.adoc b/docs/topics/create-yaml-rule.adoc index dbca33b02a..628a3b6a91 100644 --- a/docs/topics/create-yaml-rule.adoc +++ b/docs/topics/create-yaml-rule.adoc @@ -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` diff --git a/docs/topics/rules-important-links.adoc b/docs/topics/rules-important-links.adoc index 35db891e97..bac3338675 100644 --- a/docs/topics/rules-important-links.adoc +++ b/docs/topics/rules-important-links.adoc @@ -6,6 +6,6 @@ [id="rules-important-links_{context}"] = Additional resources -* {ProductShortName} Javadoc: http://windup.github.io/windup/docs/latest/javadoc +// * {ProductShortName} Javadocs: {LinkAPI}reporting/api/src/main/java * {ProductShortName} Jira issue tracker: {JiraWindupURL} * {ProductShortName} mailing list: windup-eng@redhat.com diff --git a/docs/topics/templates/document-attributes.adoc b/docs/topics/templates/document-attributes.adoc index 0ad1046857..7ae62840ab 100644 --- a/docs/topics/templates/document-attributes.adoc +++ b/docs/topics/templates/document-attributes.adoc @@ -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/ //Links to MTA and MTR Jira project pages: :JiraMTRURL: https://issues.redhat.com/projects/WINDUP diff --git a/docs/topics/testing-rules.adoc b/docs/topics/testing-rules.adoc index d4f18919e5..270e7c8d34 100644 --- a/docs/topics/testing-rules.adoc +++ b/docs/topics/testing-rules.adoc @@ -99,7 +99,7 @@ The `` element has no unique attributes or child elements. [discrete] ===== Summary -The `` 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 `` 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. The following is an example that looks for four instances of the specified message. @@ -158,7 +158,7 @@ The `` element has no unique child elements. [id="classification_exists_syntax_{context}"] ==== syntax -The `` 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 `` 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. [IMPORTANT] ==== @@ -226,7 +226,7 @@ The `` has no unique child elements. [id="hint-exists-syntax_{context}"] ==== syntax -The `` 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 `` element. For additional information, see the link:{LinkAPI}org/jboss/windup/reporting/config/HintExists.html[HintExists] class. +The `` 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 `` element. For additional information, see the link:{LinkAPI}reporting/api/src/main/java/org/jboss/windup/reporting/config/HintExists.java[HintExists] class. [IMPORTANT] ==== diff --git a/docs/topics/yaml-rule-structure-syntax.adoc b/docs/topics/yaml-rule-structure-syntax.adoc index e252b22f19..6133b198ed 100644 --- a/docs/topics/yaml-rule-structure-syntax.adoc +++ b/docs/topics/yaml-rule-structure-syntax.adoc @@ -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}"] @@ -334,7 +331,7 @@ The `java` provider analyzes Java source code. This provider has the following capabilities: * `referenced` -* `dependency`. +* `dependency` .`referenced` @@ -348,7 +345,7 @@ when: 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: @@ -375,9 +372,9 @@ when: upperbound: "" <2> lowerbound: "" <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 @@ -405,9 +402,9 @@ when: upperbound: "" <2> lowerbound: "" <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 @@ -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 @@ -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. \ No newline at end of file