diff --git a/.gitignore b/.gitignore index 727eef49f7..50a6f869d2 100644 --- a/.gitignore +++ b/.gitignore @@ -4,4 +4,9 @@ html/ */build/* Gemfile.lock */master.html -.idea/ \ No newline at end of file +.idea/ +.gitignore +.DS_Store +assets/.DS_Store +docs/.DS_Store +docs/topics/.DS_Store diff --git a/docs/rules-development-guide/master.adoc b/docs/rules-development-guide/master.adoc index c30ea04ef9..8984b40819 100644 --- a/docs/rules-development-guide/master.adoc +++ b/docs/rules-development-guide/master.adoc @@ -26,6 +26,9 @@ include::topics/mta-about-home-var.adoc[leveloffset=+3] // MTA Rules include::topics/about-rules.adoc[leveloffset=+2] +// YAML rule files +include::topics/yaml-rules.adoc[leveloffset=+3] + [id="creating-yaml-rules_{context}"] == Creating YAML rules diff --git a/docs/topics/review-existing-rules.adoc b/docs/topics/review-existing-rules.adoc index 4172e0a90c..6e3754b312 100644 --- a/docs/topics/review-existing-rules.adoc +++ b/docs/topics/review-existing-rules.adoc @@ -12,4 +12,19 @@ You can fork and clone the {ProductShortName} XML rules on your local machine. Rules are grouped by target platform and function. When you create a new rule, it is helpful to find a rule that is similar to the one you need and use it as a starting template. -New rules are continually added, so it is a good idea to check back frequently to review the updates. +{ProductShortName} YAML rules are replacing the XML rules. See are being replaced occasionally added, so it is a good idea to check back frequently to review the updates. + +[NOTE] +==== +.Existing {ProductShortName} rules YAML rule files + +YAML-base rules are in the process of replacing the XML-based. + +Comparable `.yaml` rule files are available for most `.xml` rules. + +A GitHub repository stores these YAML-based rules at the following location: link:https://github.com/konveyor/rulesets/tree/main/default/generated[https://github.com/konveyor/rulesets/tree/main/default/generated]. + +The numbered YAML rule files are grouped according to target platform. When you create a new rule, it is helpful to find a rule that is similar to the one you need and use it as a starting template. + +The repository may show newly added YAML rule files, so it is a good idea to check back occasionally to review the updates. +==== \ No newline at end of file diff --git a/docs/topics/yaml-rules.adoc b/docs/topics/yaml-rules.adoc new file mode 100644 index 0000000000..fa41090584 --- /dev/null +++ b/docs/topics/yaml-rules.adoc @@ -0,0 +1,26 @@ +// Module included in the following assemblies: +// +// * docs/rules-development-guide/master.adoc + +:_content-type: PROCEDURE +[id="open-yaml-rule_{context}"] += Using existing YAML rules + +You can open and edit existing {ProductShortName} YAML-based rule. This assumes that you have already installed {ProductShortName}. See link:{ProductDocUserGuideURL}/index#installing_and_running_the_cli[Installing and running the CLI] in the _{UserCLIBookName}_ for installation instructions. + +To access the repository of YAML rule files, you must fork and clone an existing rule from the Red Hat Konveyor rules repository. + +[id="yaml-rules-repository_{context}"] +== Replicate YAML rules library + +You can fork and clone the {ProductShortName} YAML rule files on your local machine. + +The YAML-based rules are located on GitHub at the following location: link:https://github.com/konveyor/rulesets/tree/main/default/generated[https://github.com/konveyor/rulesets/tree/main/default/generated]. + +The rules are numbered and grouped according to target platform. When you create a new rule, it is helpful to find a rule that is similar to the one you need and use it as a starting template. + +New YAML rules are continuously added, so it is a good idea to check back frequently to review the updates. + + + +