Home | About | Sematext search-lucene.com search-hadoop.com
 Search Hadoop and all its subprojects:

Switch to Threaded View
Drill >> mail # dev >> Make a distribution of documentation for Drill


Copy link to this message
-
Re: Make a distribution of documentation for Drill

> Ok, we can use the maven plugin, doxia-module-markdown to integrate doc
> files with maven.
>

Perfect! Much appreciated.

Cheers,
Michael

--
Michael Hausenblas
Ireland, Europe
http://mhausenblas.info/

On 17 Dec 2013, at 13:44, Rajika Kumarasiri <[EMAIL PROTECTED]> wrote:

> Ok, we can use the maven plugin, doxia-module-markdown to integrate doc
> files with maven.
>
> http://stackoverflow.com/questions/14829190/how-to-use-markdown-for-maven-project-site
>
> Rajika
>
>
> On Tue, Dec 17, 2013 at 4:44 AM, Michael Hausenblas <
> [EMAIL PROTECTED]> wrote:
>
>> Rajika,
>>
>> Great stuff!
>>
>>> have the documentation sources in xml format and have maven to build the
>>> html version into the release distribution.
>>
>> Hmm. Why XML? I’d suggest to do it in Markdown which also directly renders
>> in GitHub. Way easier to write and read ;)
>>
>>
>> Cheers,
>>                Michael
>>
>> --
>> Michael Hausenblas
>> Ireland, Europe
>> http://mhausenblas.info/
>>
>> On 16 Dec 2013, at 14:59, Rajika Kumarasiri <[EMAIL PROTECTED]>
>> wrote:
>>
>>> I created the following jiras. I will attach the patches. The idea is to
>>> have the documentation sources in xml format and have maven to build the
>>> html version into the release distribution.
>>>
>>> https://issues.apache.org/jira/browse/DRILL-328
>>> https://issues.apache.org/jira/browse/DRILL-32<
>> https://issues.apache.org/jira/browse/DRILL-328>
>>> 9
>>> https://issues.apache.org/jira/browse/DRILL-3<
>> https://issues.apache.org/jira/browse/DRILL-328>
>>> 30
>>>
>>> Rajika
>>>
>>>
>>> On Mon, Dec 16, 2013 at 12:34 AM, Jacques Nadeau <[EMAIL PROTECTED]>
>> wrote:
>>>
>>>> Sounds good Rajika.  Can you start by creating some Jira's and assigning
>>>> themselves.  We can then use them to further discuss your ideas.
>>>>
>>>> Thanks!
>>>> Jacques
>>>>
>>>>
>>>> On Sun, Dec 15, 2013 at 12:12 AM, Ted Dunning <[EMAIL PROTECTED]>
>>>> wrote:
>>>>
>>>>> I think that is a great idea.  The mechanics will have to be worked
>> out,
>>>>> but the doing of it is a great thing.
>>>>>
>>>>>
>>>>>
>>>>> On Sat, Dec 14, 2013 at 3:53 PM, Rajika Kumarasiri <
>>>>> [EMAIL PROTECTED]> wrote:
>>>>>
>>>>>> As of now Drill documentation is scattered in couple of wiki pages. I
>>>>>> think it would be a good idea to make a standard documentation
>>>>>> distribution as part of the binary distribution
>>>>>> (apache-drill-*-docs.tar.gz).
>>>>>>
>>>>>>
>>>>>> As a starter point we can start with the followings;
>>>>>>
>>>>>> 1. Installations guide.
>>>>>> 2. Quick starter guide.
>>>>>> 3. Developer guide.
>>>>>>
>>>>>> If you agree I would like to work on this.
>>>>>>
>>>>>> Rajika
>>>>>>
>>>>>
>>>>
>>
>>