From easyant-dev-return-221-apmail-incubator-easyant-dev-archive=incubator.apache.org@incubator.apache.org Mon Oct 3 19:34:19 2011 Return-Path: X-Original-To: apmail-incubator-easyant-dev-archive@minotaur.apache.org Delivered-To: apmail-incubator-easyant-dev-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 1CD5895F2 for ; Mon, 3 Oct 2011 19:34:19 +0000 (UTC) Received: (qmail 13171 invoked by uid 500); 3 Oct 2011 19:34:19 -0000 Delivered-To: apmail-incubator-easyant-dev-archive@incubator.apache.org Received: (qmail 13151 invoked by uid 500); 3 Oct 2011 19:34:19 -0000 Mailing-List: contact easyant-dev-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: easyant-dev@incubator.apache.org Delivered-To: mailing list easyant-dev@incubator.apache.org Received: (qmail 13143 invoked by uid 99); 3 Oct 2011 19:34:19 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 03 Oct 2011 19:34:19 +0000 X-ASF-Spam-Status: No, hits=1.5 required=5.0 tests=FREEMAIL_FROM,HTML_MESSAGE,RCVD_IN_DNSWL_LOW,SPF_PASS,T_TO_NO_BRKTS_FREEMAIL X-Spam-Check-By: apache.org Received-SPF: pass (nike.apache.org: domain of jeanlouis.boudart@gmail.com designates 209.85.160.175 as permitted sender) Received: from [209.85.160.175] (HELO mail-gy0-f175.google.com) (209.85.160.175) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 03 Oct 2011 19:34:11 +0000 Received: by gyg8 with SMTP id 8so3724460gyg.6 for ; Mon, 03 Oct 2011 12:33:50 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :content-type; bh=g+4/GtzXe4wUIqrjELyMV73j80SIuh1pCo2XaXY6D1Y=; b=Pp8stmwNe5EAXUNWC1DJSJ3P1L/OdLdOkzJm1mSh1PDlu7XxBFRb5pXEILPShGMus3 ld3URdRxSHhb2tzNnDil2nNDA6Gq7C4ki1pl7mx+jHLlbMD9sGwZECeQwHoibgSSEW5t YrYAgW1fAkvzGVmCq0M11Cq6SXZ3uzDm0qI90= MIME-Version: 1.0 Received: by 10.236.156.67 with SMTP id l43mr2182746yhk.10.1317670430332; Mon, 03 Oct 2011 12:33:50 -0700 (PDT) Received: by 10.147.137.1 with HTTP; Mon, 3 Oct 2011 12:33:50 -0700 (PDT) In-Reply-To: References: Date: Mon, 3 Oct 2011 21:33:50 +0200 Message-ID: Subject: Re: Plugin documentation From: Jean-Louis Boudart To: easyant-dev@incubator.apache.org Content-Type: multipart/alternative; boundary=20cf303f67f8ee56eb04ae6a0d76 X-Virus-Checked: Checked by ClamAV on apache.org --20cf303f67f8ee56eb04ae6a0d76 Content-Type: text/plain; charset=ISO-8859-1 IMHO, Plugins or buildtypes should document : - a few lines explaning plugin objectives and phylosophy - an example of use (this can be partially generated) - their dependencies (including extenal libraries, but also other easyant's plugins) - properties declared with - targets and extensionPoints - a target graph could also be useful on complex plugins Almost all of these information can be retrieved from PluginService api in easyant core except the first point which needs by definition to be hand written. I have no idea yet about tools that can be used to achieve this (i mean the hand written part, as we can generate stuff from PluginService result). Any ideas ? Xooki ? A wiki syntax ? Docbook ? Using Apache Doxia (the documentation backend behind maven site) ? Apache Forrest ? Others ? Note that EasyAnt provides a documentation plugin [1] based on XDOC[2]. Output format should be html based (to be browsable through easyant website), but i would also feel happy if we support PDF. [1] http://svn.apache.org/viewvc/incubator/easyant/plugins/trunk/documentation/ [2] http://maven.apache.org/doxia/references/xdoc-format.html 2011/10/3 Jean-Louis Boudart > Hi there > > As you should know we've recently refactored easyant's build process to > make it simpler and more extandable. > We need to reimplement a better mechanism to generate plugin documentation. > > This brings a few questions like : > > - What do you expect to find on plugin / buildtype documentation ? > - Which tools / technology could we to generate this stuff ? > - Which output format are we targeting ? (html ? pdf ? both ? others ?) > > > Feel free to discuss about your ideas here, we will then update the issue > on jira[1] with your feedbacks. > > Any ideas are welcome. > > [1] https://issues.apache.org/jira/browse/EASYANT-42 > > -- > Jean Louis Boudart > Independent consultant > Apache EasyAnt commiter http://incubator.apache.org/easyant/ > -- Jean Louis Boudart Independent consultant Apache EasyAnt commiter http://incubator.apache.org/easyant/ --20cf303f67f8ee56eb04ae6a0d76--