Skip to content

MTA-1097 Windup feature parity #872

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.

Sign up for GitHub

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

Open
HagayVider1 wants to merge 18 commits into
base: main
Choose a base branch
from
Open

MTA-1097 Windup feature parity #872

Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
428ece8
Updated .gitignore file
HagayVider1 Apr 21, 2024
daf975d
Replaced link to
HagayVider1 Apr 25, 2024
e01775f
Returned XML rules
HagayVider1 Apr 25, 2024
d621606
Update .gitignore
HagayVider1 May 6, 2024
857aa8b
Added section in Introduction chapter - Using existing YAML rules
HagayVider1 Jun 3, 2024
549b0c6
Added note in Using existing rules with link to repository of YAML rules
HagayVider1 Jun 3, 2024
5404b97
New section in Introduction chapter - Using YAML rules
HagayVider1 Jun 3, 2024
a920d61
Updated context IDs for new YAML rules section
HagayVider1 Jun 3, 2024
d6ddabb
Added YAML rules at end of the MTA rules section
HagayVider1 Jun 3, 2024
cf507a9
Commented out insertion of YAML rules
HagayVider1 Jun 3, 2024
490bde8
Returned yaml-rules.adoc file
HagayVider1 Jun 3, 2024
db3612a
Removed YAML rules section from MTA rules
HagayVider1 Jun 3, 2024
d797c63
Commented out YAML rules section - will return after correcting error
HagayVider1 Jun 3, 2024
b4ba9e1
Edited existing rules section
HagayVider1 Jun 3, 2024
7f746a9
Updated yaml-rules.adoc master.adoc
HagayVider1 Jun 4, 2024
b743347
Updated NOTE
HagayVider1 Jun 4, 2024
335d8bc
Updated YAML rules section
HagayVider1 Jun 4, 2024
71787c6
Revert "Updated yaml-rules.adoc master.adoc"
HagayVider1 Jun 5, 2024
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
View file
Open in desktop
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
View file
Open in desktop
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]
Copy link
Copy Markdown
Collaborator

@anarnold97 anarnold97 Jun 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you checked your preview?


[id="creating-yaml-rules_{context}"]
== Creating YAML rules

Expand Down
18 changes: 17 additions & 1 deletion docs/topics/review-existing-rules.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,20 @@ 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.
New XML rules are occasionally added, so it is a good idea to check back frequently to review the updates.

NOTE
Comment thread
HagayVider1 marked this conversation as resolved.
Outdated
.YAML rules
====
.Existing {ProductShortName} rules `.yaml` files

XML rules are in the process of being replaced with newer YAML rules.
Copy link
Copy Markdown
Collaborator

@anarnold97 anarnold97 Jun 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 RedHat.PassiveVoice 1(32-46) 'being replaced' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice.


Most of the `.xml` rules files have been converted to comparable `.yaml` rule files.
Copy link
Copy Markdown
Collaborator

@anarnold97 anarnold97 Jun 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 RedHat.PassiveVoice 3(36-50) 'been converted' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice.


These 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].
Copy link
Copy Markdown
Collaborator

@anarnold97 anarnold97 Jun 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 RedHat.PassiveVoice 5(23-34) 'are located' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice.


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.
Copy link
Copy Markdown
Collaborator

@anarnold97 anarnold97 Jun 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 RedHat.PassiveVoice 7(10-22) 'are numbered' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice.


New YAML rules are continuously added, so it is a good idea to check back frequently to review the updates.
Copy link
Copy Markdown
Collaborator

@anarnold97 anarnold97 Jun 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 RedHat.SimpleWords 9(74-84) Use simple language. Consider using 'often' rather than 'frequently'.

====
26 changes: 26 additions & 0 deletions docs/topics/yaml-rules.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// Module included in the following assemblies:
Comment thread
HagayVider1 marked this conversation as 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.