[jbosstools-issues] [JBoss JIRA] Commented: (JBDS-810) JBDS release: guides versions update

[OLga Chikvina (JIRA)]

    [ https://jira.jboss.org/jira/browse/JBDS-810?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12483073#action_12483073 ] 

OLga Chikvina commented on JBDS-810:
------------------------------------

The instruction on how to add diff markers to docs:
  - First, the tool we use to add markers is DiffMk (version 3.0.a1).
  - We added two script files in the bin/ folder of the DiffMk distribution: run.sh and run_mkdiff.sh. The first is responsible for comparing 2 files and producing a third file with diff markers. The second one we use to indicate the files to compare and the output files, the format is the following:
              ./run.sh [the path to the file] [the path to the file modified] [the path to the output file]
  - To identify the changes between two different revisions of the same guide, use the following line:
        ./run.sh /path/to/the/old/revision/guide/master.xml /path/to/the/current/revision/guide/master.xml /path/to/the/produced/by/diffmk/master_output.xml
  - Next, run the run_mkdiff.sh
  - Actually, the DiffMk is not an ideal tool for comparing. It has a lot of lacks. Here are some of such lacks we run into:
              1. It removes the HTML entities when outputs the file, for instance & in the links.
              2. Sometimes it mixes the structure of the document, for instance, put the <chapter> into the <chapter>;
              3. Sometimes it deletes the tags such as <imageobject>.
    Thus, in order the docs with diff markers could be built, the next step is validating and checking the master_output.xml files carefully. 
  - To build the guide with updated/new markers on the TOC, chapters and sections and have the changes highlighted, use the 'diffmk' profile, i.e. the 'mvn clean install -P diffmk' maven command.
  - To build the release version of the guide (for JBDS release) with updated/new markers on the TOC, use the 'releaseJBDS' profile, i.e. the 'mvn clean install -P releaseJBDS' maven command

> JBDS release: guides versions update
> ------------------------------------
>
>                 Key: JBDS-810
>                 URL: https://jira.jboss.org/jira/browse/JBDS-810
>             Project: JBoss Developer Studio
>          Issue Type: Task
>          Components: documentation
>    Affects Versions: 2.0.0.GA
>            Reporter: Svetlana mukhina
>            Assignee: Svetlana mukhina
>             Fix For: 2.1.0-doc
>
>   Original Estimate: 3 hours
>  Remaining Estimate: 3 hours
>
> Correct all versions and dates  in all JBDS guides

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira