You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@drill.apache.org by Rajika Kumarasiri <ra...@gmail.com> on 2013/12/15 00:53:17 UTC
Make a distribution of documentation for Drill
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
Re: Make a distribution of documentation for Drill
Posted by Rajika Kumarasiri <ra...@gmail.com>.
I just attached a possible patch to DRILL-339. This add a new module to
project called documentation which will be built from the root pom. It will
generate a documentation distribution, apache-drill-*-docs.tar.gz in side
target in the same module.
Rajika
On Tue, Dec 17, 2013 at 1:49 PM, Rajika Kumarasiri <
rajika.kumarasiri@gmail.com> wrote:
> 4. User guide.
>
> How user guide defer from quick start guide ? Quick starter guide helps
> you to install, run and test the sample quickly. While user guide is a
> complete guide on all configuration options.
>
> Rajika
>
>
> On Sat, Dec 14, 2013 at 6:53 PM, Rajika Kumarasiri <
> rajika.kumarasiri@gmail.com> 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
>>
>>
>>
>
Re: Make a distribution of documentation for Drill
Posted by Rajika Kumarasiri <ra...@gmail.com>.
4. User guide.
How user guide defer from quick start guide ? Quick starter guide helps you
to install, run and test the sample quickly. While user guide is a complete
guide on all configuration options.
Rajika
On Sat, Dec 14, 2013 at 6:53 PM, Rajika Kumarasiri <
rajika.kumarasiri@gmail.com> 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
>
>
>
Re: Make a distribution of documentation for Drill
Posted by Michael Hausenblas <mi...@gmail.com>.
> 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 <ra...@gmail.com> 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 <
> michael.hausenblas@gmail.com> 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 <ra...@gmail.com>
>> 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 <ja...@apache.org>
>> 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 <te...@gmail.com>
>>>> 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 <
>>>>> rajika.kumarasiri@gmail.com> 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
>>>>>>
>>>>>
>>>>
>>
>>
Re: Make a distribution of documentation for Drill
Posted by Rajika Kumarasiri <ra...@gmail.com>.
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 <
michael.hausenblas@gmail.com> 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 <ra...@gmail.com>
> 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 <ja...@apache.org>
> 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 <te...@gmail.com>
> >> 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 <
> >>> rajika.kumarasiri@gmail.com> 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
> >>>>
> >>>
> >>
>
>
Re: Make a distribution of documentation for Drill
Posted by Michael Hausenblas <mi...@gmail.com>.
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 <ra...@gmail.com> 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 <ja...@apache.org> 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 <te...@gmail.com>
>> 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 <
>>> rajika.kumarasiri@gmail.com> 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
>>>>
>>>
>>
Re: Make a distribution of documentation for Drill
Posted by Rajika Kumarasiri <ra...@gmail.com>.
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 <ja...@apache.org> 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 <te...@gmail.com>
> 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 <
> > rajika.kumarasiri@gmail.com> 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
> > >
> >
>
Re: Make a distribution of documentation for Drill
Posted by Jacques Nadeau <ja...@apache.org>.
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 <te...@gmail.com> 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 <
> rajika.kumarasiri@gmail.com> 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
> >
>
Re: Make a distribution of documentation for Drill
Posted by Ted Dunning <te...@gmail.com>.
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 <
rajika.kumarasiri@gmail.com> 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
>