From dd95d5d86d1429fa00495294003cbc90292eebaa Mon Sep 17 00:00:00 2001
From: Emily McMullan <emcmulla@redhat.com>
Date: Wed, 1 Nov 2023 16:26:24 -0400
Subject: [PATCH] remove windup ref

Signed-off-by: Emily McMullan <emcmulla@redhat.com>
---
 README.md                    | 45 +-----------------------------------
 docs/developer.md            |  1 +
 docs/example.md              | 41 ++++++++++++++++++++++++++++++++
 docs/{windup.md => usage.md} | 11 ++++++---
 4 files changed, 51 insertions(+), 47 deletions(-)
 create mode 100644 docs/example.md
 rename docs/{windup.md => usage.md} (50%)

diff --git a/README.md b/README.md
index 34cb722..1b3be7f 100644
--- a/README.md
+++ b/README.md
@@ -207,50 +207,7 @@ To run `transform rules` on application source code, run:
 kantra transform rules --input=<path/to/xmlrules> --output=<path/to/output/dir>
 ```
 
-## Quick Demos
-
-Once you have kantra installed, these examples will help you run both an 
-analyze and a transform command.
-
-### Analyze
-
-- Get the example application to run analysis on  
-`git clone https://github.com/konveyor/example-applications`
-
-- List available target technologies  
-`kantra analyze --list-targets`
-
-- Run analysis with a specified target technology  
-`kantra analyze --input=<path-to/example-applications/example-1> --output=<path-to-output-dir> --target=cloud-readiness`
-
-- Several analysis reports will have been created in your specified output path:
-
-```sh
-$ ls ./output/ -1
-analysis.log
-dependencies.yaml
-dependency.log
-output.yaml
-static-report
-```
-
-`output.yaml` is the file that contains issues report.   
-`static-report` contains the static HTML report.  
-`dependencies.yaml`contains a dependencies report.  
-
-### Transform
-
-- Get the example application to transform source code  
-`git clone https://github.com/ivargrimstad/jakartaee-duke`
-
-- View available OpenRewrite recipes  
-`kantra transform openrewrite --list-targets` 
-
-- Run a recipe on the example application  
-`kantra transform openrewrite --input=<path-to/jakartaee-duke> --target=jakarta-imports`
-
-- Inspect the `jakartaee-duke` application source code diff to see the transformation  
-
+### analyze and transform [examples](./docs/example.md)
 
 ## Code of Conduct
 Refer to Konveyor's Code of Conduct [here](https://github.com/konveyor/community/blob/main/CODE_OF_CONDUCT.md).
diff --git a/docs/developer.md b/docs/developer.md
index 31ddd74..b42161e 100644
--- a/docs/developer.md
+++ b/docs/developer.md
@@ -11,5 +11,6 @@ Two environment variables control the container runtime and the kantra image: `P
 `RUNNER_IMG=kantra:dev PODMAN_BIN=/usr/local/bin/podman go run main.go analyze --input=<path-to-src-application> --output=./output`
 
 #### Helpful flags:
+
 - To increase logs for debugging, you can set `--log-level` (default is 5)
 - ie: `--log-level=7`
diff --git a/docs/example.md b/docs/example.md
new file mode 100644
index 0000000..a4b96d8
--- /dev/null
+++ b/docs/example.md
@@ -0,0 +1,41 @@
+Once you have kantra installed, these examples will help you run both an 
+analyze and a transform command.
+
+### Analyze
+
+- Get the example application to run analysis on  
+`git clone https://github.com/konveyor/example-applications`
+
+- List available target technologies  
+`kantra analyze --list-targets`
+
+- Run analysis with a specified target technology  
+`kantra analyze --input=<path-to/example-applications/example-1> --output=<path-to-output-dir> --target=cloud-readiness`
+
+- Several analysis reports will have been created in your specified output path:
+
+```sh
+$ ls ./output/ -1
+analysis.log
+dependencies.yaml
+dependency.log
+output.yaml
+static-report
+```
+
+`output.yaml` is the file that contains issues report.   
+`static-report` contains the static HTML report.  
+`dependencies.yaml`contains a dependencies report.  
+
+### Transform
+
+- Get the example application to transform source code  
+`git clone https://github.com/ivargrimstad/jakartaee-duke`
+
+- View available OpenRewrite recipes  
+`kantra transform openrewrite --list-targets` 
+
+- Run a recipe on the example application  
+`kantra transform openrewrite --input=<path-to/jakartaee-duke> --target=jakarta-imports`
+
+- Inspect the `jakartaee-duke` application source code diff to see the transformation  
diff --git a/docs/windup.md b/docs/usage.md
similarity index 50%
rename from docs/windup.md
rename to docs/usage.md
index ce1e72a..f08ad5a 100644
--- a/docs/windup.md
+++ b/docs/usage.md
@@ -1,8 +1,13 @@
-## Known differences between Windup and kantra output
+## Output
+
+
+#### Default rules:
+
+- the analyze command runs against a set of packaged rules [here](https://github.com/konveyor/rulesets/)
+- `--label-selector` and/or `--target` can filter these rules
+- `--rules` can be provided to run analyze on rules outside of this set
 
 #### `--rules` + `--target`
-- In Windup, you can specify a custom rule with a target. If the custom rule does not
-have a label with the given target specified, it will **still** run the rule.  
 
 - In kantra, if a rule is given as well as a target, but the given rule **does not**
 have the target label, the given rule will not match.