You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@kafka.apache.org by Christian Posta <ch...@gmail.com> on 2016/03/02 23:39:43 UTC

migrating the main-page docs to gitbook format

Would love to have the docs in gitbook/markdown format so they can easily
be viewed from the source repo (or mirror, technically) on github.com. They
can also be easily converted to HTML, have a side-navigation ToC, and still
be versioned along with the src code.

Thoughts?

-- 
*Christian Posta*
twitter: @christianposta
http://www.christianposta.com/blog
http://fabric8.io

Re: migrating the main-page docs to gitbook format

Posted by Christian Posta <ch...@gmail.com>.
All,

Here's a first spike.. would love feedback.. happy to continue the convo
here (https://issues.apache.org/jira/browse/KAFKA-2967)

http://christianposta.com/kafka-docs/_book/index.html

have the gitbook build integrated with the kafka gradle builds and rest of
WIP here:

https://github.com/christian-posta/kafka/tree/ceposta-doco

On Thu, Mar 3, 2016 at 6:28 AM, Marcos Luis Ortiz Valmaseda <
marcosluis2186@gmail.com> wrote:

> I love that too
> +1
>
> 2016-03-02 21:15 GMT-05:00 Christian Posta <ch...@gmail.com>:
>
> > For sure! Will take a look!
> >
> > On Wednesday, March 2, 2016, Gwen Shapira <gw...@confluent.io> wrote:
> >
> > > Hey!
> > >
> > > Yes! We'd love that too! Maybe you want to help us out with
> > > https://issues.apache.org/jira/browse/KAFKA-2967 ?
> > >
> > > Gwen
> > >
> > > On Wed, Mar 2, 2016 at 2:39 PM, Christian Posta
> > > <christian.posta@gmail.com <javascript:;>> wrote:
> > > > Would love to have the docs in gitbook/markdown format so they can
> > easily
> > > > be viewed from the source repo (or mirror, technically) on
> github.com.
> > > They
> > > > can also be easily converted to HTML, have a side-navigation ToC, and
> > > still
> > > > be versioned along with the src code.
> > > >
> > > > Thoughts?
> > > >
> > > > --
> > > > *Christian Posta*
> > > > twitter: @christianposta
> > > > http://www.christianposta.com/blog
> > > > http://fabric8.io
> > >
> >
> >
> > --
> > *Christian Posta*
> > twitter: @christianposta
> > http://www.christianposta.com/blog
> > http://fabric8.io
> >
>



-- 
*Christian Posta*
twitter: @christianposta
http://www.christianposta.com/blog
http://fabric8.io

Re: migrating the main-page docs to gitbook format

Posted by Marcos Luis Ortiz Valmaseda <ma...@gmail.com>.
I love that too
+1

2016-03-02 21:15 GMT-05:00 Christian Posta <ch...@gmail.com>:

> For sure! Will take a look!
>
> On Wednesday, March 2, 2016, Gwen Shapira <gw...@confluent.io> wrote:
>
> > Hey!
> >
> > Yes! We'd love that too! Maybe you want to help us out with
> > https://issues.apache.org/jira/browse/KAFKA-2967 ?
> >
> > Gwen
> >
> > On Wed, Mar 2, 2016 at 2:39 PM, Christian Posta
> > <christian.posta@gmail.com <javascript:;>> wrote:
> > > Would love to have the docs in gitbook/markdown format so they can
> easily
> > > be viewed from the source repo (or mirror, technically) on github.com.
> > They
> > > can also be easily converted to HTML, have a side-navigation ToC, and
> > still
> > > be versioned along with the src code.
> > >
> > > Thoughts?
> > >
> > > --
> > > *Christian Posta*
> > > twitter: @christianposta
> > > http://www.christianposta.com/blog
> > > http://fabric8.io
> >
>
>
> --
> *Christian Posta*
> twitter: @christianposta
> http://www.christianposta.com/blog
> http://fabric8.io
>

Re: migrating the main-page docs to gitbook format

Posted by Christian Posta <ch...@gmail.com>.
For sure! Will take a look!

On Wednesday, March 2, 2016, Gwen Shapira <gw...@confluent.io> wrote:

> Hey!
>
> Yes! We'd love that too! Maybe you want to help us out with
> https://issues.apache.org/jira/browse/KAFKA-2967 ?
>
> Gwen
>
> On Wed, Mar 2, 2016 at 2:39 PM, Christian Posta
> <christian.posta@gmail.com <javascript:;>> wrote:
> > Would love to have the docs in gitbook/markdown format so they can easily
> > be viewed from the source repo (or mirror, technically) on github.com.
> They
> > can also be easily converted to HTML, have a side-navigation ToC, and
> still
> > be versioned along with the src code.
> >
> > Thoughts?
> >
> > --
> > *Christian Posta*
> > twitter: @christianposta
> > http://www.christianposta.com/blog
> > http://fabric8.io
>


-- 
*Christian Posta*
twitter: @christianposta
http://www.christianposta.com/blog
http://fabric8.io

Re: migrating the main-page docs to gitbook format

Posted by Gwen Shapira <gw...@confluent.io>.
Hey!

Yes! We'd love that too! Maybe you want to help us out with
https://issues.apache.org/jira/browse/KAFKA-2967 ?

Gwen

On Wed, Mar 2, 2016 at 2:39 PM, Christian Posta
<ch...@gmail.com> wrote:
> Would love to have the docs in gitbook/markdown format so they can easily
> be viewed from the source repo (or mirror, technically) on github.com. They
> can also be easily converted to HTML, have a side-navigation ToC, and still
> be versioned along with the src code.
>
> Thoughts?
>
> --
> *Christian Posta*
> twitter: @christianposta
> http://www.christianposta.com/blog
> http://fabric8.io