WINDUP_3579

Author: sbeskin-redhat

.gitignore

@@ -4,3 +4,4 @@ html/
 */build/*
 Gemfile.lock
 */master.html
+.idea/

.idea/windup-documentation.iml

@@ -1,14 +1,15 @@
 :mtr:
 include::topics/templates/document-attributes.adoc[]
+:_content-type: ASSEMBLY
+[id="cli-guide"]
+= CLI Guide
+
 :toc:
 :toclevels: 4
 :numbered:
 :imagesdir: topics/images
 :context: cli-guide
 :cli-guide:
-:_content-type: ASSEMBLY
-[id="cli-guide"]
-= CLI Guide
 
 //Inclusive language statement
 include::topics/making-open-source-more-inclusive.adoc[]
@@ -35,6 +36,9 @@ include::topics/cli-run.adoc[leveloffset=+2]
 // Use OpenRewrite recipes
 include::topics/using-openrewrite-recipes.adoc[leveloffset=+3]
 
+// Available OpenRewrite recipes
+include::topics/available-openrewrite-recipes.adoc[leveloffset=+4]
+
 // Access the Report
 include::topics/access-report.adoc[leveloffset=+2]
 

docs/cli-guide-mtr/master.adoc

@@ -36,6 +36,9 @@ include::topics/cli-run.adoc[leveloffset=+2]
 // Use OpenRewrite recipes
 include::topics/using-openrewrite-recipes.adoc[leveloffset=+3]
 
+// Available OpenRewrite recipes
+include::topics/available-openrewrite-recipes.adoc[leveloffset=+4]
+
 // Access the Report
 include::topics/access-report.adoc[leveloffset=+2]
 

docs/cli-guide/master.adoc

@@ -0,0 +1,38 @@
+// Module included in the following module:
+//
+// * docs/cli-guide-mtr/master.adoc
+
+[id=available-openrewrite-recipes_{context}]
+= Available OpenRewrite recipes
+
+.Available OpenRewrite recipes
+[cols="22%,26%,26%,26%", options="header"]
+|====
+|Migration path
+|Purpose
+|rewrite.configLocation
+|activeRecipes
+
+|Java EE to Jakarta EE
+|Replace import of `javax` packages with equivalent `jakarta` packages
+
+Replace `javax` artifacts, declared within `pom.xml` files, with the `jakarta` equivalents
+
+|`<MTR_HOME>/rules/openrewrite/jakarta \ /javax/imports/rewrite.yml`
+|`org.jboss.windup.JavaxToJakarta`
+
+|Java EE to Jakarta EE
+|Rename bootstrapping files
+|`<MTR_HOME>/rules/openrewrite/jakarta \ /javax/bootstrapping/rewrite.yml`
+|`org.jboss.windup.jakarta.javax. \ BootstrappingFiles`
+
+|Java EE to Jakarta EE
+|Transform `persistence.xml` configuration
+|`<MTR_HOME>/rules/openrewrite/jakarta \ /javax/xml/rewrite.yml`
+|`org.jboss.windup.javax-jakarta. \ PersistenceXML`
+
+|Spring Boot to Quarkus
+|Replace `spring.jpa.hibernate.ddl-auto` property within files matching `application*.properties`
+|`<MTR_HOME>/rules/openrewrite/quarkus \ /springboot/properties/rewrite.yml`
+|`org.jboss.windup.sb-quarkus.Properties`
+|====

docs/topics/available-openrewrite-recipes.adoc

@@ -1,6 +1,6 @@
 // Module included in the following module:
 //
-// * docs/topics/cli-run
+// * docs/cli-guide-mtr/master.adoc
 
 [id=using-openrewrite-recipes_{context}]
 = Using OpenRewrite recipes
@@ -23,7 +23,7 @@ For example, the OpenRewrite recipe `org.jboss.windup.JavaxToJakarta` renames im
 [source,terminal,subs="attributes+"]
 ----
 $ ./windup-cli --openrewrite --input </path/to/source/project> \
-  "-Drewrite.configLocation=<path/to/rewrite.yaml>  \
+  "-Drewrite.configLocation=<path/to/rewrite.yaml>"  \
   "-DactiveRecipes=<recipe_name>" --goal dryRun
 ----
 
@@ -41,7 +41,7 @@ You can include more than one recipe by specifying each in the `activeRecipes` p
 +
 [source, terminal,subs="attributes+"]
 ----
-  "DactiveRecipes=org.jboss.windup.JavaxInjectToJakartaInject, \
+  "-DactiveRecipes=org.jboss.windup.JavaxInjectToJakartaInject, \
     org.jboss.windup.JavaxEjbToJakartaEjb"
 ----
 
@@ -53,7 +53,7 @@ You can include more than one recipe by specifying each in the `activeRecipes` p
 +
 [source,terminal,subs="attributes+"]
 ----
-$ ../windup-cli --openrewrite --input </path/to/source/project> \
-  "-Drewrite.configLocation=<path/to/rewrite.yaml>  \
+$ ./windup-cli --openrewrite --input </path/to/source/project> \
+  "-Drewrite.configLocation=<path/to/rewrite.yaml>"  \
   "-DactiveRecipes=<recipe_name>" --goal run
-----
+----