Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MTA-1097 Windup feature parity #872

Open
wants to merge 18 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,9 @@ html/
*/build/*
Gemfile.lock
*/master.html
.idea/
.idea/
.gitignore
.DS_Store
assets/.DS_Store
docs/.DS_Store
docs/topics/.DS_Store
3 changes: 3 additions & 0 deletions docs/rules-development-guide/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
17 changes: 16 additions & 1 deletion docs/topics/review-existing-rules.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
====
26 changes: 26 additions & 0 deletions docs/topics/yaml-rules.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// Module included in the following assemblies:
HagayVider1 marked this conversation as resolved.
Show resolved Hide resolved
//
// * 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.