diff --git a/docs/Dev-Internal-API-Features.adoc b/docs/Dev-Internal-API-Features.adoc index 0db7e4c200..eafe5b8059 100644 --- a/docs/Dev-Internal-API-Features.adoc +++ b/docs/Dev-Internal-API-Features.adoc @@ -9,7 +9,6 @@ A `Rule` implements `Context`, which stores metadata. The following example gets -------- WindupRuleProvider ruleProvider = (WindupRuleProvider) context.get(RuleMetadata.RULE_PROVIDER); -[source,java] -------- For more information about the metadata stored in the context, see xref:Rules-Metadata[Rules Metadata] diff --git a/docs/Known-Issues.adoc b/docs/Known-Issues.adoc index 851a209fa3..d1634011b6 100644 --- a/docs/Known-Issues.adoc +++ b/docs/Known-Issues.adoc @@ -1,13 +1,4 @@ [[Known-Issues]] === Known Windup Issues -The following is a list of currently known issues. - -* https://issues.jboss.org/browse/WINDUP-73[WINDUP-73] -** If you do not see expected log messages, resort to `System.out.println()` for logging. -** You may see too much logging, especially from Forge. This is to be expected. - -* https://issues.jboss.org/browse/WINDUP-197[WINDUP-197] -** Exceptions in Surefire reports are broken due to the way Forge wraps exceptions and the way Surefire handles them. -** You need to debug or rewrap exceptions using TestUtil.rewrap(ex). - +Windup known issues are tracked here: https://issues.jboss.org/browse/WINDUP-496?jql=project%20%3D%20WINDUP%20AND%20issuetype%20%3D%20Bug%20AND%20status%20in%20%28Open%2C%20%22Coding%20In%20Progress%22%2C%20Reopened%2C%20%22Pull%20Request%20Sent%22%29[Open Windup issues] diff --git a/docs/Review-the-Report.adoc b/docs/Review-the-Report.adoc index 8c9ad5c6b8..c1e86d69ac 100644 --- a/docs/Review-the-Report.adoc +++ b/docs/Review-the-Report.adoc @@ -85,13 +85,13 @@ Explore the Windup `OUTPUT_REPORT_DIRECTORY/reports` folder to find additional r ===== Rule Provider Execution Report -The `OUTPUT_REPORT_DIRECTORY/reports/ruleproviders.html` page provides the list of rule providers that executed when running the Windup migration command against the application. +The `OUTPUT_REPORT_DIRECTORY/reports/windup_ruleproviders.html` page provides the list of rule providers that executed when running the Windup migration command against the application. image:images/report-javaee-ear-ruleprovider.png[RuleProvider Report, 500] ===== Rule Provider Execution Report -The `OUTPUT_REPORT_DIRECTORY/reports/ruleproviders.html` page provides the list of rule providers that executed when running the Windup migration command against the application. +The `OUTPUT_REPORT_DIRECTORY/reports/windup_ruleproviders.html` page provides the list of rule providers that executed when running the Windup migration command against the application. ===== Individual File Analysis Reports diff --git a/docs/Rules-Create-a-Basic-Java-based-Rule-Add-on.adoc b/docs/Rules-Create-a-Basic-Java-based-Rule-Add-on.adoc index eec9cdba12..3c1200c538 100644 --- a/docs/Rules-Create-a-Basic-Java-based-Rule-Add-on.adoc +++ b/docs/Rules-Create-a-Basic-Java-based-Rule-Add-on.adoc @@ -144,7 +144,7 @@ The following are examples of some dependencies you may need for your rule add-o org.jboss.forge.furnace furnace-maven-plugin - ${version.furnace} + ${version.forge} generate-dot diff --git a/docs/Rules-Rule-Execution-Lifecycle.adoc b/docs/Rules-Rule-Execution-Lifecycle.adoc index 00abbad424..935f47ae3c 100644 --- a/docs/Rules-Rule-Execution-Lifecycle.adoc +++ b/docs/Rules-Rule-Execution-Lifecycle.adoc @@ -3,33 +3,56 @@ ==== Rule Lifecycle -Windup executes each rule in a single threaded mode. The following +Windup executes each rule in sequential order. The following sections describe the phases of rule execution and how rules may specify that one or more other rules must be executed before or after they are run. -For graphical overview of rule processing, see +For a graphical overview of rule processing, see https://docs.google.com/drawings/d/1IMnds3Qu8Wwcf7_mr7NJ9a3YgtcGJ7dejl09EhWl7Vc/edit[this diagram]. ==== Rule Phases -By default, a rule runs during the http://windup.github.io/windup/docs/javadoc/latest/org/jboss/windup/config/RulePhase.html#MIGRATION_RULES[MIGRATION_RULES] phase. However, a -rule may require certain processing or actions to occur before the it +------------- +INFO: Loaded [67] org.jboss.windup.config.WindupRuleProvider [ +org.jboss.windup.config.phase.Implicit +org.jboss.windup.config.phase.Initialization +org.jboss.windup.config.phase.Discovery +org.jboss.windup.config.phase.ArchiveExtraction +org.jboss.windup.config.phase.ArchiveMetadataExtraction +org.jboss.windup.config.phase.ClassifyFileTypes +org.jboss.windup.config.phase.DiscoverProjectStructure +org.jboss.windup.config.phase.Decompilation +org.jboss.windup.config.phase.InitialAnalysis +org.jboss.windup.config.phase.MigrationRules +org.jboss.windup.config.phase.PostMigrationRules +org.jboss.windup.config.phase.PreReportGeneration +org.jboss.windup.config.phase.ReportGeneration +org.jboss.windup.config.phase.PostReportGeneration +org.jboss.windup.config.phase.ReportRendering +org.jboss.windup.config.phase.PostReportRendering +org.jboss.windup.config.phase.Finalize +org.jboss.windup.config.phase.PostFinalize +] +------------- + + +By default, a rule runs during the https://github.com/windup/windup/blob/master/config/api/src/main/java/org/jboss/windup/config/phase/MigrationRules.java[MigrationRules] phase. However, a +rule may require certain processing or actions to occur before it executes, such as the extraction of archives and scanning of java or XML files. -Rule phases provide an way for rule authors to specify and control in +Rule phases provide a way for rule authors to specify and control in which phase of the rule lifecycle the rule should execute. This is done by overriding the `WindupRuleProvider.getPhase()` method. The following -example specifies this rule should execute during the http://windup.github.io/windup/docs/javadoc/latest/org/jboss/windup/config/RulePhase.html#INITIAL_ANALYSIS[INITIAL_ANALYSIS] -rule phase. +example specifies this rule should execute during the https://github.com/windup/windup/blob/master/config/api/src/main/java/org/jboss/windup/config/phase/InitialAnalysis.java[InitialAnalysis] rule phase. [source,java] ---- @Override public RulePhase getPhase() { - return RulePhase.INITIAL_ANALYSIS; + return InitialAnalysis.class; } ---- @@ -75,12 +98,10 @@ before executing the the current rule. [source,java] ---- -List> executeBeforeList = new ArrayList<>(); - @Override public List> getExecuteBefore() { - return executeBeforeList.add(RuleToFireBefore.class); + return asClassList(RuleToFireBefore.class); } ---- @@ -90,11 +111,9 @@ specified after executing the the current rule. [source,java] ---- -List> executeAfterList = new ArrayList<>(); - @Override public List> getExecuteAfter() { - return executeAfterList.add(RuleToFireAfter.class); + return asClassList(RuleToFireAfter.class); } ---- \ No newline at end of file diff --git a/docs/Windup-Core-Development-Guide.adoc b/docs/Windup-Core-Development-Guide.adoc index dc3b4b2607..7ea4c9abfa 100644 --- a/docs/Windup-Core-Development-Guide.adoc +++ b/docs/Windup-Core-Development-Guide.adoc @@ -8,8 +8,6 @@ This guide is for developers who plan to contribute source code updates or core rule add-ons to the Windup 2.0 project. -NOTE: This is a very rough first draft! - include::What-is-Windup.adoc[tabsize=4] include::Features-of-Windup-2.0.adoc[tabsize=4] include::Get-Involved.adoc[tabsize=4] diff --git a/docs/Windup-Rules-Development-Guide.adoc b/docs/Windup-Rules-Development-Guide.adoc index b9efdb3ae1..ada2632d95 100644 --- a/docs/Windup-Rules-Development-Guide.adoc +++ b/docs/Windup-Rules-Development-Guide.adoc @@ -6,10 +6,8 @@ == Overview -This guide is for engineers, consultants, and others who plan to use -Windup 2.0 to migrate Java applications or other components. - -NOTE: This is a very rough first draft! +This guide is for engineers, consultants, and others who plan to create +custom rules for Windup 2.0. include::What-is-Windup.adoc[tabsize=4] diff --git a/docs/Windup-User-Guide.adoc b/docs/Windup-User-Guide.adoc index 51b2ab5961..950471e2ec 100644 --- a/docs/Windup-User-Guide.adoc +++ b/docs/Windup-User-Guide.adoc @@ -7,9 +7,7 @@ == Overview This guide is for engineers, consultants, and others who plan to use -Windup 2.0 to migrate Java applications or other components. - -NOTE: This is a very rough first draft! +Windup 2.0 to migrate Java applications or other components. include::What-is-Windup.adoc[tabsize=4] diff --git a/html/WindupCoreDevelopmentGuide.html b/html/WindupCoreDevelopmentGuide.html index 8f39f04662..421aeeb44b 100644 --- a/html/WindupCoreDevelopmentGuide.html +++ b/html/WindupCoreDevelopmentGuide.html @@ -521,18 +521,6 @@

Overview

This guide is for developers who plan to contribute source code updates or core rule add-ons to the Windup 2.0 project.

-
- - - - - -
-
Note
-		 -This is a very rough first draft! -
-

What is Windup?

@@ -2246,7 +2234,7 @@

Additional Reports

Rule Provider Execution Report
-

The OUTPUT_REPORT_DIRECTORY/reports/ruleproviders.html page provides the list of rule providers that executed when running the Windup migration command against the application.

+

The OUTPUT_REPORT_DIRECTORY/reports/windup_ruleproviders.html page provides the list of rule providers that executed when running the Windup migration command against the application.

RuleProvider Report

@@ -2255,7 +2243,7 @@
Rule Provider Execution Report
Rule Provider Execution Report
-

The OUTPUT_REPORT_DIRECTORY/reports/ruleproviders.html page provides the list of rule providers that executed when running the Windup migration command against the application.

+

The OUTPUT_REPORT_DIRECTORY/reports/windup_ruleproviders.html page provides the list of rule providers that executed when running the Windup migration command against the application.

@@ -2331,37 +2319,60 @@

Rule Execution Lifecycle

Rule Lifecycle

-

Windup executes each rule in a single threaded mode. The following +

Windup executes each rule in sequential order. The following sections describe the phases of rule execution and how rules may specify that one or more other rules must be executed before or after they are run.

-

For graphical overview of rule processing, see +

For a graphical overview of rule processing, see this diagram.

Rule Phases

-
-

By default, a rule runs during the MIGRATION_RULES phase. However, a -rule may require certain processing or actions to occur before the it +

+
+
INFO: Loaded [67] org.jboss.windup.config.WindupRuleProvider [
+org.jboss.windup.config.phase.Implicit
+org.jboss.windup.config.phase.Initialization
+org.jboss.windup.config.phase.Discovery
+org.jboss.windup.config.phase.ArchiveExtraction
+org.jboss.windup.config.phase.ArchiveMetadataExtraction
+org.jboss.windup.config.phase.ClassifyFileTypes
+org.jboss.windup.config.phase.DiscoverProjectStructure
+org.jboss.windup.config.phase.Decompilation
+org.jboss.windup.config.phase.InitialAnalysis
+org.jboss.windup.config.phase.MigrationRules
+org.jboss.windup.config.phase.PostMigrationRules
+org.jboss.windup.config.phase.PreReportGeneration
+org.jboss.windup.config.phase.ReportGeneration
+org.jboss.windup.config.phase.PostReportGeneration
+org.jboss.windup.config.phase.ReportRendering
+org.jboss.windup.config.phase.PostReportRendering
+org.jboss.windup.config.phase.Finalize
+org.jboss.windup.config.phase.PostFinalize
+]
+
+
+
+

By default, a rule runs during the MigrationRules phase. However, a +rule may require certain processing or actions to occur before it executes, such as the extraction of archives and scanning of java or XML files.

-

Rule phases provide an way for rule authors to specify and control in +

Rule phases provide a way for rule authors to specify and control in which phase of the rule lifecycle the rule should execute. This is done by overriding the WindupRuleProvider.getPhase() method. The following -example specifies this rule should execute during the INITIAL_ANALYSIS -rule phase.

+example specifies this rule should execute during the InitialAnalysis rule phase.

@Override
 public RulePhase getPhase() {
-    return RulePhase.INITIAL_ANALYSIS;
+    return InitialAnalysis.class;
 }
@@ -2428,12 +2439,10 @@

Execute Before and Execute After

-
List<Class<? extends WindupRuleProvider>> executeBeforeList = new ArrayList<>();
-
-@Override
+
@Override
 public List<Class<? extends WindupRuleProvider>> getExecuteBefore()
 {
-   return executeBeforeList.add(RuleToFireBefore.class);
+   return asClassList(RuleToFireBefore.class);
 }
@@ -2444,12 +2453,10 @@

Execute Before and Execute After

-
List<Class<? extends WindupRuleProvider>> executeAfterList = new ArrayList<>();
-
-@Override
+
@Override
 public List<Class<? extends WindupRuleProvider>> getExecuteAfter()
 {
-    return executeAfterList.add(RuleToFireAfter.class);
+    return asClassList(RuleToFireAfter.class);
 }
@@ -3032,7 +3039,7 @@
Create a Maven Project
<plugin> <groupId>org.jboss.forge.furnace</groupId> <artifactId>furnace-maven-plugin</artifactId> - <version>${version.furnace}</version> + <version>${version.forge}</version> <executions> <execution> <id>generate-dot</id> @@ -4120,8 +4127,7 @@

Find the RuleProvider that 
WindupRuleProvider ruleProvider =
-     (WindupRuleProvider) context.get(RuleMetadata.RULE_PROVIDER);
-[source,java]
+ (WindupRuleProvider) context.get(RuleMetadata.RULE_PROVIDER);
@@ -5822,37 +5828,7 @@

Fork and Clone the GitHub Project

Known Windup Issues

-

The following is a list of currently known issues.

-
-
-
    -
  • -

    WINDUP-73

    -
    -
      -
    • -

      If you do not see expected log messages, resort to System.out.println() for logging.

      -
      • -
    • -

      You may see too much logging, especially from Forge. This is to be expected.

      -
      • -
    -
    -
    • -
  • -

    WINDUP-197

    -
    -
      -
    • -

      Exceptions in Surefire reports are broken due to the way Forge wraps exceptions and the way Surefire handles them.

      -
      • -
    • -

      You need to debug or rewrap exceptions using TestUtil.rewrap(ex).

      -
      • -
    -
    -
    • -
+

Windup known issues are tracked here: Open Windup issues

@@ -5949,7 +5925,7 @@

Reporting Terms

diff --git a/html/WindupRulesDevelopmentGuide.html b/html/WindupRulesDevelopmentGuide.html index 9a38d28276..0fa2bb90ae 100644 --- a/html/WindupRulesDevelopmentGuide.html +++ b/html/WindupRulesDevelopmentGuide.html @@ -495,20 +495,8 @@

Windup Rules Development Guide

Overview

-

This guide is for engineers, consultants, and others who plan to use -Windup 2.0 to migrate Java applications or other components.

-
-
- - - - - -
-
Note
-		 -This is a very rough first draft! -
+

This guide is for engineers, consultants, and others who plan to create +custom rules for Windup 2.0.

What is Windup?

@@ -1456,7 +1444,7 @@

Additional Reports

Rule Provider Execution Report
-

The OUTPUT_REPORT_DIRECTORY/reports/ruleproviders.html page provides the list of rule providers that executed when running the Windup migration command against the application.

+

The OUTPUT_REPORT_DIRECTORY/reports/windup_ruleproviders.html page provides the list of rule providers that executed when running the Windup migration command against the application.

RuleProvider Report

@@ -1465,7 +1453,7 @@
Rule Provider Execution Report
Rule Provider Execution Report
-

The OUTPUT_REPORT_DIRECTORY/reports/ruleproviders.html page provides the list of rule providers that executed when running the Windup migration command against the application.

+

The OUTPUT_REPORT_DIRECTORY/reports/windup_ruleproviders.html page provides the list of rule providers that executed when running the Windup migration command against the application.

@@ -1675,37 +1663,60 @@

Rule Execution Lifecycle

Rule Lifecycle

-

Windup executes each rule in a single threaded mode. The following +

Windup executes each rule in sequential order. The following sections describe the phases of rule execution and how rules may specify that one or more other rules must be executed before or after they are run.

-

For graphical overview of rule processing, see +

For a graphical overview of rule processing, see this diagram.

Rule Phases

-
-

By default, a rule runs during the MIGRATION_RULES phase. However, a -rule may require certain processing or actions to occur before the it +

+
+
INFO: Loaded [67] org.jboss.windup.config.WindupRuleProvider [
+org.jboss.windup.config.phase.Implicit
+org.jboss.windup.config.phase.Initialization
+org.jboss.windup.config.phase.Discovery
+org.jboss.windup.config.phase.ArchiveExtraction
+org.jboss.windup.config.phase.ArchiveMetadataExtraction
+org.jboss.windup.config.phase.ClassifyFileTypes
+org.jboss.windup.config.phase.DiscoverProjectStructure
+org.jboss.windup.config.phase.Decompilation
+org.jboss.windup.config.phase.InitialAnalysis
+org.jboss.windup.config.phase.MigrationRules
+org.jboss.windup.config.phase.PostMigrationRules
+org.jboss.windup.config.phase.PreReportGeneration
+org.jboss.windup.config.phase.ReportGeneration
+org.jboss.windup.config.phase.PostReportGeneration
+org.jboss.windup.config.phase.ReportRendering
+org.jboss.windup.config.phase.PostReportRendering
+org.jboss.windup.config.phase.Finalize
+org.jboss.windup.config.phase.PostFinalize
+]
+
+
+
+

By default, a rule runs during the MigrationRules phase. However, a +rule may require certain processing or actions to occur before it executes, such as the extraction of archives and scanning of java or XML files.

-

Rule phases provide an way for rule authors to specify and control in +

Rule phases provide a way for rule authors to specify and control in which phase of the rule lifecycle the rule should execute. This is done by overriding the WindupRuleProvider.getPhase() method. The following -example specifies this rule should execute during the INITIAL_ANALYSIS -rule phase.

+example specifies this rule should execute during the InitialAnalysis rule phase.

@Override
 public RulePhase getPhase() {
-    return RulePhase.INITIAL_ANALYSIS;
+    return InitialAnalysis.class;
 }
@@ -1772,12 +1783,10 @@

Execute Before and Execute After

-
List<Class<? extends WindupRuleProvider>> executeBeforeList = new ArrayList<>();
-
-@Override
+
@Override
 public List<Class<? extends WindupRuleProvider>> getExecuteBefore()
 {
-   return executeBeforeList.add(RuleToFireBefore.class);
+   return asClassList(RuleToFireBefore.class);
 }
@@ -1788,12 +1797,10 @@

Execute Before and Execute After

-
List<Class<? extends WindupRuleProvider>> executeAfterList = new ArrayList<>();
-
-@Override
+
@Override
 public List<Class<? extends WindupRuleProvider>> getExecuteAfter()
 {
-    return executeAfterList.add(RuleToFireAfter.class);
+    return asClassList(RuleToFireAfter.class);
 }
@@ -2376,7 +2383,7 @@
Create a Maven Project
<plugin> <groupId>org.jboss.forge.furnace</groupId> <artifactId>furnace-maven-plugin</artifactId> - <version>${version.furnace}</version> + <version>${version.forge}</version> <executions> <execution> <id>generate-dot</id> @@ -3089,7 +3096,7 @@

Additional Reports

Rule Provider Execution Report
-

The OUTPUT_REPORT_DIRECTORY/reports/ruleproviders.html page provides the list of rule providers that executed when running the Windup migration command against the application.

+

The OUTPUT_REPORT_DIRECTORY/reports/windup_ruleproviders.html page provides the list of rule providers that executed when running the Windup migration command against the application.

RuleProvider Report

@@ -3098,7 +3105,7 @@
Rule Provider Execution Report
Rule Provider Execution Report
-

The OUTPUT_REPORT_DIRECTORY/reports/ruleproviders.html page provides the list of rule providers that executed when running the Windup migration command against the application.

+

The OUTPUT_REPORT_DIRECTORY/reports/windup_ruleproviders.html page provides the list of rule providers that executed when running the Windup migration command against the application.

@@ -3521,37 +3528,7 @@

Fork and Clone the GitHub Project<

Known Windup Issues

-

The following is a list of currently known issues.

-
-
-
    -
  • -

    WINDUP-73

    -
    -
      -
    • -

      If you do not see expected log messages, resort to System.out.println() for logging.

      -
      • -
    • -

      You may see too much logging, especially from Forge. This is to be expected.

      -
      • -
    -
    -
    • -
  • -

    WINDUP-197

    -
    -
      -
    • -

      Exceptions in Surefire reports are broken due to the way Forge wraps exceptions and the way Surefire handles them.

      -
      • -
    • -

      You need to debug or rewrap exceptions using TestUtil.rewrap(ex).

      -
      • -
    -
    -
    • -
+

Windup known issues are tracked here: Open Windup issues

@@ -3940,7 +3917,7 @@

Custom Models (coming from Addons) diff --git a/html/WindupUserGuide.html b/html/WindupUserGuide.html index 384fad550d..4f3e9913a4 100644 --- a/html/WindupUserGuide.html +++ b/html/WindupUserGuide.html @@ -451,18 +451,6 @@

Overview

This guide is for engineers, consultants, and others who plan to use Windup 2.0 to migrate Java applications or other components.

-
- - - - - -
-
Note
-		 -This is a very rough first draft! -
-

What is Windup?

@@ -1409,7 +1397,7 @@

Additional Reports

Rule Provider Execution Report
-

The OUTPUT_REPORT_DIRECTORY/reports/ruleproviders.html page provides the list of rule providers that executed when running the Windup migration command against the application.

+

The OUTPUT_REPORT_DIRECTORY/reports/windup_ruleproviders.html page provides the list of rule providers that executed when running the Windup migration command against the application.

RuleProvider Report

@@ -1418,7 +1406,7 @@
Rule Provider Execution Report
Rule Provider Execution Report
-

The OUTPUT_REPORT_DIRECTORY/reports/ruleproviders.html page provides the list of rule providers that executed when running the Windup migration command against the application.

+

The OUTPUT_REPORT_DIRECTORY/reports/windup_ruleproviders.html page provides the list of rule providers that executed when running the Windup migration command against the application.

@@ -1503,37 +1491,7 @@

Fork and Clone the GitHub Project

Known Windup Issues

-

The following is a list of currently known issues.

-
-
-
    -
  • -

    WINDUP-73

    -
    -
      -
    • -

      If you do not see expected log messages, resort to System.out.println() for logging.

      -
      • -
    • -

      You may see too much logging, especially from Forge. This is to be expected.

      -
      • -
    -
    -
    • -
  • -

    WINDUP-197

    -
    -
      -
    • -

      Exceptions in Surefire reports are broken due to the way Forge wraps exceptions and the way Surefire handles them.

      -
      • -
    • -

      You need to debug or rewrap exceptions using TestUtil.rewrap(ex).

      -
      • -
    -
    -
    • -
+

Windup known issues are tracked here: Open Windup issues

@@ -1722,7 +1680,7 @@

OCPsoft Rewrite

diff --git a/scripts/pagelinksUserGuide.txt b/scripts/pagelinksUserGuide.txt deleted file mode 100644 index 51b2ab5961..0000000000 --- a/scripts/pagelinksUserGuide.txt +++ /dev/null @@ -1,48 +0,0 @@ -= Windup User Guide - -:toc: -:toclevels: 4 - - -== Overview - -This guide is for engineers, consultants, and others who plan to use -Windup 2.0 to migrate Java applications or other components. - -NOTE: This is a very rough first draft! - -include::What-is-Windup.adoc[tabsize=4] - -include::Features-of-Windup-2.0.adoc[tabsize=4] - -include::Windup-Processing-Overview.adoc[tabsize=4] - -include::Get-Involved.adoc[tabsize=4] - -include::Report-Issues-with-Windup.adoc[tabsize=4] - -include::About-the-WINDUP_HOME-Variable.adoc[tabsize=4] - - -== Run Windup - -include::Install-Windup.adoc[tabsize=4] - -include::Execute-Windup.adoc[tabsize=4] - -include::Review-the-Report.adoc[tabsize=4] - -== Additional Resources - -include::Review-the-Windup-Quickstarts.adoc[tabsize=4] - -include::Known-Issues.adoc[tabsize=4] - -include::Glossary.adoc[tabsize=4] - -include::Windup-Architectural-Components.adoc[tabsize=4] - - - - - diff --git a/scripts/windupDocPublish.sh b/scripts/windupDocPublish.sh index 383bf5a848..42d8847497 100755 --- a/scripts/windupDocPublish.sh +++ b/scripts/windupDocPublish.sh @@ -44,11 +44,21 @@ echo " User Guide: " file://$2/docs/$WINDUP_VERSION/html/WindupUserGuide.html echo " Rules Development Guide: " file://$2/docs/$WINDUP_VERSION/html/WindupRulesDevelopmentGuide.html echo " Core Development Guide: " file://$2/docs/$WINDUP_VERSION/html/WindupCoreDevelopmentGuide.html -# cd $2 -# git add docs -# git commit -m "Update the docs" +cd $2 +git add docs + +git commit -m "Update the docs for release $3" + +echo "The following are manual steps: " +echo " git push origin HEAD" +echo " (issue a pull and verify)" +echo " git push upstream gh-pages" +echo " firefox http://windup.github.io/windup/docs/$WINDUP_VERSION/html/WindupUserGuide.html" + # git push origin HEAD ## issue a pull and verify # git push upstream gh-pages #firefox http://windup.github.io/windup/docs/$WINDUP_VERSION/html/WindupUserGuide.html +cd $1 +