Added explicit steps for configuring and using custom rules. #276
Conversation
Signed-off-by: Maira Usman <maira.usman5703@gmail.com>
Signed-off-by: Maira Usman <maira.usman5703@gmail.com>
|
@jwmatthews , Can you please confirm if this is the content you meant to include in the document? |
docs/customApps.md
Outdated
| To ensure the analysis uses the necessary custom rules, follow these steps: | ||
|
|
||
| 1. Custom Rules: Download or create your custom rules and place them in the samples/custom_rules directory. | ||
| 2. Ignore Default Rules: The analysis script is set to ignore default Kantra rules. You can review or adjust this in example/analyze.sh if needed. |
There was a problem hiding this comment.
@Myrausman this information you have is not technically correct, as the section you are documenting will NOT ignore default rules. That is why I gave you more context so you could fully understand the 2 places we run analysis.
The documentation for this section:
https://github.com/konveyor/kai/blob/1ed90050c210c5a3597b0ef1a073eb41f4843008/docs/customApps.md#run-analysis
Is talking about how to run the analysis for the sample data which Kai will consult.
That analysis DOES NOT ignore default rules.
Please remove:
2. Ignore Default Rules: The analysis script is set to ignore default Kantra rules. You can review or adjust this in example/analyze.sh if needed.
Signed-off-by: Maira Usman <maira.usman5703@gmail.com>
There was a problem hiding this comment.
Almost ready, but need to adjust a trunk fmt issue
Please see https://github.com/konveyor/kai/blob/main/CONTRIBUTING.md#linting for how to install/run trunk to fix this.
Signed-off-by: Myrausman <maira.usman5703@gmail.com>
Myrausman
force-pushed
the
Update-customsApps
branch
from
1288198
to
15916c9
Compare
Fixes #212