You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@helix.apache.org by Olivier Lamy <ol...@apache.org> on 2012/10/21 12:18:54 UTC
Documentation format ?
Hi Folks,
As you know we need to have a web site.
There are a bunch of documentation here [1] which need to be moved
@asf helix website.
I wonder what kind of format would you prefer to use ? (maven site ?)
Note due to recent change in infra website will be available at
helix.incubator.apache.org.
Thanks,
--
Olivier Lamy
Talend: http://coders.talend.com
http://twitter.com/olamy | http://linkedin.com/in/olamy
[1] https://github.com/linkedin/helix/wiki
Re: Documentation format ?
Posted by Olivier Lamy <ol...@apache.org>.
2012/10/22 kishore g <g....@gmail.com>:
> Hi Olivier,
>
> We use maven for building Helix, so we are good there. I am fine with
> keeping javadocs and markdowns with the project sources.
>
> Lets migrate the code to asf git, and then start making the neccessary
> changes. I have some plugin to add license files.
Jira task created to import sources @asf
https://issues.apache.org/jira/browse/INFRA-5437
>
> Feel free to make additional changes for publishing site and jars.
>
>
> Thanks,
> Kishore G
>
> On Mon, Oct 22, 2012 at 1:55 AM, Olivier Lamy <ol...@apache.org> wrote:
>
>> 2012/10/21 kishore g <g....@gmail.com>:
>> > Hi Olivier,
>> >
>> > What kind of formats are we talking about? Currently the documents on
>> > github wiki follow markdown format . Can you point me to a sample project
>> > that uses maven site.
>>
>> Ok good for markdown.
>> The question is now do you want to use maven to generate this doc and
>> javadoc etc (the mandatory part will be to commit the content to a svn
>> path for publication in asf infra).
>> Will the documentation (*.md) be in the project sources or in an other
>> scm path ?
>>
>>
>> >
>> > Thanks,
>> > Kishore G
>> >
>> > On Sun, Oct 21, 2012 at 3:18 AM, Olivier Lamy <ol...@apache.org> wrote:
>> >
>> >> Hi Folks,
>> >> As you know we need to have a web site.
>> >> There are a bunch of documentation here [1] which need to be moved
>> >> @asf helix website.
>> >>
>> >> I wonder what kind of format would you prefer to use ? (maven site ?)
>> >> Note due to recent change in infra website will be available at
>> >> helix.incubator.apache.org.
>> >>
>> >> Thanks,
>> >> --
>> >> Olivier Lamy
>> >> Talend: http://coders.talend.com
>> >> http://twitter.com/olamy | http://linkedin.com/in/olamy
>> >>
>> >> [1] https://github.com/linkedin/helix/wiki
>> >>
>>
>>
>>
>> --
>> Olivier Lamy
>> Talend: http://coders.talend.com
>> http://twitter.com/olamy | http://linkedin.com/in/olamy
>>
--
Olivier Lamy
Talend: http://coders.talend.com
http://twitter.com/olamy | http://linkedin.com/in/olamy
Re: Documentation format ?
Posted by kishore g <g....@gmail.com>.
Hi Olivier,
We use maven for building Helix, so we are good there. I am fine with
keeping javadocs and markdowns with the project sources.
Lets migrate the code to asf git, and then start making the neccessary
changes. I have some plugin to add license files.
Feel free to make additional changes for publishing site and jars.
Thanks,
Kishore G
On Mon, Oct 22, 2012 at 1:55 AM, Olivier Lamy <ol...@apache.org> wrote:
> 2012/10/21 kishore g <g....@gmail.com>:
> > Hi Olivier,
> >
> > What kind of formats are we talking about? Currently the documents on
> > github wiki follow markdown format . Can you point me to a sample project
> > that uses maven site.
>
> Ok good for markdown.
> The question is now do you want to use maven to generate this doc and
> javadoc etc (the mandatory part will be to commit the content to a svn
> path for publication in asf infra).
> Will the documentation (*.md) be in the project sources or in an other
> scm path ?
>
>
> >
> > Thanks,
> > Kishore G
> >
> > On Sun, Oct 21, 2012 at 3:18 AM, Olivier Lamy <ol...@apache.org> wrote:
> >
> >> Hi Folks,
> >> As you know we need to have a web site.
> >> There are a bunch of documentation here [1] which need to be moved
> >> @asf helix website.
> >>
> >> I wonder what kind of format would you prefer to use ? (maven site ?)
> >> Note due to recent change in infra website will be available at
> >> helix.incubator.apache.org.
> >>
> >> Thanks,
> >> --
> >> Olivier Lamy
> >> Talend: http://coders.talend.com
> >> http://twitter.com/olamy | http://linkedin.com/in/olamy
> >>
> >> [1] https://github.com/linkedin/helix/wiki
> >>
>
>
>
> --
> Olivier Lamy
> Talend: http://coders.talend.com
> http://twitter.com/olamy | http://linkedin.com/in/olamy
>
Re: Documentation format ?
Posted by Olivier Lamy <ol...@apache.org>.
2012/10/21 kishore g <g....@gmail.com>:
> Hi Olivier,
>
> What kind of formats are we talking about? Currently the documents on
> github wiki follow markdown format . Can you point me to a sample project
> that uses maven site.
Ok good for markdown.
The question is now do you want to use maven to generate this doc and
javadoc etc (the mandatory part will be to commit the content to a svn
path for publication in asf infra).
Will the documentation (*.md) be in the project sources or in an other
scm path ?
>
> Thanks,
> Kishore G
>
> On Sun, Oct 21, 2012 at 3:18 AM, Olivier Lamy <ol...@apache.org> wrote:
>
>> Hi Folks,
>> As you know we need to have a web site.
>> There are a bunch of documentation here [1] which need to be moved
>> @asf helix website.
>>
>> I wonder what kind of format would you prefer to use ? (maven site ?)
>> Note due to recent change in infra website will be available at
>> helix.incubator.apache.org.
>>
>> Thanks,
>> --
>> Olivier Lamy
>> Talend: http://coders.talend.com
>> http://twitter.com/olamy | http://linkedin.com/in/olamy
>>
>> [1] https://github.com/linkedin/helix/wiki
>>
--
Olivier Lamy
Talend: http://coders.talend.com
http://twitter.com/olamy | http://linkedin.com/in/olamy
Re: Documentation format ?
Posted by kishore g <g....@gmail.com>.
Hi Olivier,
What kind of formats are we talking about? Currently the documents on
github wiki follow markdown format . Can you point me to a sample project
that uses maven site.
Thanks,
Kishore G
On Sun, Oct 21, 2012 at 3:18 AM, Olivier Lamy <ol...@apache.org> wrote:
> Hi Folks,
> As you know we need to have a web site.
> There are a bunch of documentation here [1] which need to be moved
> @asf helix website.
>
> I wonder what kind of format would you prefer to use ? (maven site ?)
> Note due to recent change in infra website will be available at
> helix.incubator.apache.org.
>
> Thanks,
> --
> Olivier Lamy
> Talend: http://coders.talend.com
> http://twitter.com/olamy | http://linkedin.com/in/olamy
>
> [1] https://github.com/linkedin/helix/wiki
>