From dev-return-73773-archive-asf-public=cust-asf.ponee.io@zookeeper.apache.org Thu Sep 27 20:56:04 2018 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx-eu-01.ponee.io (Postfix) with SMTP id CF5AD180652 for ; Thu, 27 Sep 2018 20:56:03 +0200 (CEST) Received: (qmail 72792 invoked by uid 500); 27 Sep 2018 18:56:02 -0000 Mailing-List: contact dev-help@zookeeper.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@zookeeper.apache.org Delivered-To: mailing list dev@zookeeper.apache.org Received: (qmail 72781 invoked by uid 99); 27 Sep 2018 18:56:02 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd3-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 27 Sep 2018 18:56:02 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd3-us-west.apache.org (ASF Mail Server at spamd3-us-west.apache.org) with ESMTP id 6A0FD18060F for ; Thu, 27 Sep 2018 18:56:02 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd3-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -109.501 X-Spam-Level: X-Spam-Status: No, score=-109.501 tagged_above=-999 required=6.31 tests=[ENV_AND_HDR_SPF_MATCH=-0.5, KAM_ASCII_DIVIDERS=0.8, RCVD_IN_DNSWL_MED=-2.3, SPF_PASS=-0.001, USER_IN_DEF_SPF_WL=-7.5, USER_IN_WHITELIST=-100] autolearn=disabled Received: from mx1-lw-us.apache.org ([10.40.0.8]) by localhost (spamd3-us-west.apache.org [10.40.0.10]) (amavisd-new, port 10024) with ESMTP id qcmRGNjAliWB for ; Thu, 27 Sep 2018 18:56:01 +0000 (UTC) Received: from mailrelay1-us-west.apache.org (mailrelay1-us-west.apache.org [209.188.14.139]) by mx1-lw-us.apache.org (ASF Mail Server at mx1-lw-us.apache.org) with ESMTP id D20C95F21E for ; Thu, 27 Sep 2018 18:56:00 +0000 (UTC) Received: from jira-lw-us.apache.org (unknown [207.244.88.139]) by mailrelay1-us-west.apache.org (ASF Mail Server at mailrelay1-us-west.apache.org) with ESMTP id 7794DE00A5 for ; Thu, 27 Sep 2018 18:56:00 +0000 (UTC) Received: from jira-lw-us.apache.org (localhost [127.0.0.1]) by jira-lw-us.apache.org (ASF Mail Server at jira-lw-us.apache.org) with ESMTP id 3958F23F99 for ; Thu, 27 Sep 2018 18:56:00 +0000 (UTC) Date: Thu, 27 Sep 2018 18:56:00 +0000 (UTC) From: "Tamas Penzes (JIRA)" To: dev@zookeeper.apache.org Message-ID: In-Reply-To: References: Subject: [jira] [Commented] (ZOOKEEPER-925) Consider maven site generation to replace our forrest site and documentation generation MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394 [ https://issues.apache.org/jira/browse/ZOOKEEPER-925?page=3Dcom.atlass= ian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=3D1= 6630903#comment-16630903 ]=20 Tamas Penzes commented on ZOOKEEPER-925: ---------------------------------------- Hi All, 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 proje= ct The first one is just about creating the markdown based documentation with = the opportunity of generating HTML out of it. Adding the pom.xml files only= to be able to build HTML within this step. (It is needed to be able to com= pare the result with the Forrest based generated files as part of the valid= ation.) In the=C2=A0second step I want to integrate this solution into the current = ANT based process and add the needed documentation related files to the tar= ball 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 base= d documentation, the docs directory and so on. Since this ticket also contains migration of the website, I will have to ad= d more sub-tasks in the future, when I finished the first three. > Consider maven site generation to replace our forrest site and documentat= ion generation > -------------------------------------------------------------------------= -------------- > > Key: ZOOKEEPER-925 > URL: https://issues.apache.org/jira/browse/ZOOKEEPER-925 > Project: ZooKeeper > Issue Type: Task > Components: documentation > Reporter: Patrick Hunt > Assignee: Tamas Penzes > Priority: Major > Attachments: CMS_w_RST.patch, ZOOKEEPER-925.patch, ZOOKEEPER-925.= patch > > > See WHIRR-19 for some background. > In whirr we looked at a number of site/doc generation facilities. In the = end Maven site generation plugin turned out to be by far the best option. Y= ou can see our nascent site here (no attempt at styling,etc so far): > http://incubator.apache.org/whirr/ > In particular take a look at the quick start: > http://incubator.apache.org/whirr/quick-start-guide.html > which was generated from > http://svn.apache.org/repos/asf/incubator/whirr/trunk/src/site/confluence= /quick-start-guide.confluence > notice this was standard wiki markup (confluence wiki markup, same as ava= ilable from apache) > You can read more about mvn site plugin here: > http://maven.apache.org/guides/mini/guide-site.html > Notice that other formats are available, not just confluence markup, also= note that you can use different markup formats if you like in the same sit= e (although probably not a great idea, but in some cases might be handy, fo= r example whirr uses the confluence wiki, so we can pretty much copy/paste = source docs from wiki to our site (svn) if we like) > Re maven vs our current ant based build. It's probably a good idea for us= to move the build to maven at some point. We could initially move just the= doc generation, and then incrementally move functionality from build.xml t= o mvn over a longer time period. -- This message was sent by Atlassian JIRA (v7.6.3#76005)