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.

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

Jump to bottom

📖 fix the Providers and Rules link in README.md file #271

Merged
merged 1 commit into from
Jul 27, 2023
Merged

📖 fix the Providers and Rules link in README.md file #271

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Analyzer Rule Engine
# Analyzer Rule Engine

In this project, we are writing a rule engine that can use pluggable providers for rules to make a consistent way to execute rules for Konveyor.
In this project, we are writing a rule engine that can use pluggable providers for rules to make a consistent way to execute rules for Konveyor.

One of the primary drivers for this repository is adding providers for specific languages using the Language Server Protocol. Today these providers are in tree, but we will be moving them out in the future.

Expand All @@ -15,7 +15,7 @@ $ podman build -f Dockerfile -t quay.io/konveyor/analyzer-lsp
$ podman build -f demo.Dockerfile -t test-analyzer-engine
```

This will build the engine, and include the current set of rules and examples in the container to be used.
This will build the engine, and include the current set of rules and examples in the container to be used.

To run the rules (rule-example.yaml) against the examples, and save the output to the `demo-output.yaml` file:

Expand All @@ -27,8 +27,8 @@ $ podman run -v $(pwd)/demo-output.yaml:/analyzer-lsp/output.yaml:Z test-analyze

To run the engine from source code, you need to:

* Configure providers. By default, providers are configured in `provider_settings.json`. See [Providers](#./docs/providers.md) for instructions on configuring providers.
* Configure rules. By default, rules are present in `rules_example.yaml`. See [Rules](#./docs/rules.md) for details on rule format.
* Configure providers. By default, providers are configured in `provider_settings.json`. See [Providers](./docs/providers.md) for instructions on configuring providers.
* Configure rules. By default, rules are present in `rules_example.yaml`. See [Rules](./docs/rules.md) for details on rule format.

Once the providers are configured, you can run:

Expand Down Expand Up @@ -59,7 +59,7 @@ CLI Options:

Using the LSP/Protocal from ACME https://github.com/fhs/acme-lsp and stripping out anything related to serving, proxy or anything. Just keeping the types for communication

Using JSONRPC2 from google.org/x/tools/internal. Copied and removed anything to do with serving.
Using JSONRPC2 from google.org/x/tools/internal. Copied and removed anything to do with serving.


## Code of Conduct
Expand Down
Loading