From 748523fb79471a9e746401e69542ded64acd0601 Mon Sep 17 00:00:00 2001 From: Sande Gilda Date: Fri, 12 Dec 2014 15:31:23 -0500 Subject: [PATCH] Update guide HTML and contributing information --- CONTRIBUTING.md | 33 +++++++++++++++++--------------- Execute-Windup.adoc | 4 ++-- Install-and-Configure-Maven.adoc | 4 ++-- WindupRulesDevelopmentGuide.html | 8 ++++---- WindupUserGuide.html | 6 +++--- 5 files changed, 29 insertions(+), 26 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e1f046ba96..ee17197492 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,50 +8,53 @@ The following guidelines make the transition from the Windup Wiki pages to the W === Build Windup from Source -* At the beginning of each new Wiki page, add an anchor with the exact page name, including the dashes. This is needed when the pages are combined into a book. +* At the beginning of each new Wiki page, add an anchor with the exact page name, including the dashes. This generates the correct anchors that are needed when the pages are combined into a book. [[Dev-Build-Windup-from-Source]] === Build Windup from Source -* Wiki generates anchors using dashes for spaces. AsciiDoctor generates a leading underscore and underscores for spaces. When referring to another section within the same page, do not use the `<>` syntax. It does not generate correctly for the documentation books. Instead, create an anchor and use the 'xref:' syntax to provide the link. +* Wiki generates anchors using dashes for spaces. AsciiDoctor generates a leading underscore and underscores for spaces.When referring to another section within the same page, do not use the `<>` syntax. Instead, create an anchor and use the 'xref:' syntax to provide the link. - Create the anchor at the top of the page: + Create the anchor at the top of the section using double brackets to force the generation of dashes instead of underscores: - [_windup_command_examples] + [[windup-command-examples]] ==== Windup Command Examples - Then use the `xref` to create the link. Note, the Wiki generates the name with dashes (-) for spaces. + Then use the `xref` to create the link. See xref:windup-command-examples[Windup Command Examples] for more information. - Because Asciidoctor generates a leading underscore and underscores for spaces, we need to modify the `xref:` text when the documentation is copied to windup-documenation. - - See xref:_windup_command_examples[Windup Command Examples] for more information. ## Build the Windup Guides -* Install Ascidoctor +* If you have not yet done so, install Ascidoctor gem install sciidoctor * Grab the latest changes from the Windup Wiki site + * Copy the guides from the Wiki and leave the `.asciidoc` extension. Compare this page to the Guide template in the windup-documentaion to see if any pages were added to the guide. + + | **Wiki Guide Name** | **Windup Documentation Guide Name** | + |:-------------|:-------------| + | User-Guide.asciidoc | Windup-User-Guide.adoc | + | Rules-Development-Guide.asciidoc | Windup-Rules-Development-Guide.adoc | + | Core-Development-Guide.asciidoc | Windup-Core-Development-Guide.adoc | + | Migration-Planning-Guide.asciidoc | Windup-Migration-Planning-Guide.adoc | + + * Copy any updated pages from the Windup Wiki and replace the `.asciidoc` extension with `.adoc` cp ../windup.wiki/Features-of-Windup-2.0.asciidoc Features-of-Windup-2.0.adoc - + * Find the internal `link:` macros in pages that link to other pages. - * Make sure each linked page is added with an `include:` in the Guide template. + * Make sure each page referenced by the link is added to the guide template with an `include:`. * Make sure the wiki page is copied and added to this GitHub. * Replace the `link:` macros with a `xref:` macros. - * Find the internal `xref:` macros. Add a leading underscore and replace the dashes with underscores. - - Old: See xref:windup-command-examples[Windup Command Examples] for more information. - New: See xref:_windup_command_examples[Windup Command Examples] for more information. * Build the HTML version of the guide diff --git a/Execute-Windup.adoc b/Execute-Windup.adoc index 27358e6931..6ca53611dd 100644 --- a/Execute-Windup.adoc +++ b/Execute-Windup.adoc @@ -70,7 +70,7 @@ Where: NOTE: If the *OUTPUT_REPORT_DIRECTORY* directory exists, it is deleted and recreated by Windup, so be careful not to specify a directory that contains important information! + -See xref:_windup_command_examples[Windup Command Examples] below for concrete examples of Windup commands using source code directories and archives located in the Windup GitHub repository. +See xref:windup-command-examples[Windup Command Examples] below for concrete examples of Windup commands using source code directories and archives located in the Windup GitHub repository. . You should see the following result upon completion of the command: + @@ -102,7 +102,7 @@ To see the list of available parameters for the `windup-migrate-app` command, ex man windup-migrate-app -[_windup_command_examples] +[[windup-command-examples]] ==== Windup Command Examples The following Windup command examples report against applications located in the https://github.com/windup/windup/tree/master/test-files[Windup source test-files] directory. diff --git a/Install-and-Configure-Maven.adoc b/Install-and-Configure-Maven.adoc index f74f4102bd..5c674c6ed3 100644 --- a/Install-and-Configure-Maven.adoc +++ b/Install-and-Configure-Maven.adoc @@ -5,7 +5,7 @@ If you plan to use Eclipse Luna (4.4) to build Windup, you can skip this step. This version of Eclipse embeds Maven 3.2.1 so you do not need to -install it separately. Skip to the section entitled xref:_configure_maven_to_build_windup[Configure Maven to Build Windup]. +install it separately. Skip to the section entitled xref:configure-maven-to-build-windup[Configure Maven to Build Windup]. If you plan to run Maven using the command line or plan to use Red Hat JBoss Developer Studio 7.1.1 or an older version of Eclipse, you must @@ -35,7 +35,7 @@ and click `OK`. _Note: If you use another IDE, refer to the product documentation to update the Maven installation._ -[_configure_maven_to_build_windup] +[[configure-maven-to-build-windup]] ==== Configure Maven to Build Windup Windup uses artifacts located in the diff --git a/WindupRulesDevelopmentGuide.html b/WindupRulesDevelopmentGuide.html index cd147769c4..46f8b4c225 100644 --- a/WindupRulesDevelopmentGuide.html +++ b/WindupRulesDevelopmentGuide.html @@ -1048,7 +1048,7 @@

Start Windup

-

See Windup Command Examples below for concrete examples of Windup commands using source code directories and archives located in the Windup GitHub repository.

+

See Windup Command Examples below for concrete examples of Windup commands using source code directories and archives located in the Windup GitHub repository.

  • @@ -1099,7 +1099,7 @@

    Windup Help

    -

    Windup Command Examples

    +

    Windup Command Examples

    The following Windup command examples report against applications located in the Windup source test-files directory.

    @@ -1345,7 +1345,7 @@

    Download and Install Maven

    If you plan to use Eclipse Luna (4.4) to build Windup, you can skip this step. This version of Eclipse embeds Maven 3.2.1 so you do not need to -install it separately. Skip to the section entitled Configure Maven to Build Windup.

    +install it separately. Skip to the section entitled Configure Maven to Build Windup.

    If you plan to run Maven using the command line or plan to use Red Hat @@ -1401,7 +1401,7 @@

    Configure the Maven Insta

    -

    Configure Maven to Build Windup

    +

    Configure Maven to Build Windup

    Windup uses artifacts located in the JBoss Nexus diff --git a/WindupUserGuide.html b/WindupUserGuide.html index e91b233314..df612306bf 100644 --- a/WindupUserGuide.html +++ b/WindupUserGuide.html @@ -1006,7 +1006,7 @@

    Start Windup

    -

    See Windup Command Examples below for concrete examples of Windup commands using source code directories and archives located in the Windup GitHub repository.

    +

    See Windup Command Examples below for concrete examples of Windup commands using source code directories and archives located in the Windup GitHub repository.

  • @@ -1057,7 +1057,7 @@

    Windup Help

    -

    Windup Command Examples

    +

    Windup Command Examples

    The following Windup command examples report against applications located in the Windup source test-files directory.

    @@ -1280,7 +1280,7 @@
    Rule Provider Execution Report
    Individual File Analysis Reports
    -

    You can directly access the the file analysis report pages described above by browsing for them by name in the OUTPUT_REPORT_DIRECTORY/reports/ directory. Because the same common file names can exist in multiple archives, for example "manifest.mf" or "web.xml", Windup adds a unique numeric suffix to each report file name.

    +

    You can directly access the the file analysis report pages described above by browsing for them by name in the OUTPUT_REPORT_DIRECTORY/reports/ directory. Because the same common file names can exist in multiple archives, for example "manifest.mf" or "web.xml", Windup adds a unique numeric suffix to each report file name.

    Report Directory File List