zookeeper-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tamaashu <...@git.apache.org>
Subject [GitHub] zookeeper issue #643: ZOOKEEPER-3153: Create MarkDown files and build proces...
Date Thu, 27 Sep 2018 18:53:01 GMT
Github user tamaashu commented on the issue:

    https://github.com/apache/zookeeper/pull/643
  
    Hi @anmolnar,
    
    Yes it is intentional.
    
    The original ticket was "ZOOKEEPER-925 Consider maven site generation to replace our forrest
site and documentation generation" where I have created three sub-tasks:
    * ZOOKEEPER-3153 Create MarkDown files and build process for them
    * ZOOKEEPER-3154 Update release process to use the MarkDown solution
    * ZOOKEEPER-3155 Remove Forrest XMLs and their build process from the project
    
    This PR mainly covers the first one, just creating the markdown based documentation with
the opportunity of generating HTML out of it. Adding the pom.xml files only happened to be
able to build HTML within this step. (It is needed to be able to compare the result with the
Forrest based generated files as part of the validation.)
    
    In the next step I want to integrate this solution into the current ANT based process
and add the needed documentation related files to the tarball we deliver. In this step I also
want to modify the documentation about how to prepare the deliverable in the future. 
    
    As last I will clean up the old solution, like source files to Forrest based documentation,
the docs directory and so on.
    
    Since the parent ticket also contains migration of the website, I will have to add more
sub-tasks in the future, when I finished these three.


---

Mime
View raw message