You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@kafka.apache.org by Paolo Patierno <pp...@live.com> on 2017/07/13 08:51:33 UTC

Kafka doc : official repo or web site repo ?

Hi guys,

I have big doubt on where is the doc and what to do for upgrading that.

I see the docs folder in the Kafka repo (but even there I have a PR opened for one month on Kafka Connect not yet merged) but then I see the Kafka web site repo where there is the same doc.

Reading the new Kafka Stream doc I noticed that it seems to be only in the Kafka web site repo and not in the Kafka repo.


Can you clarifying me where to submit PRs for doc ? On which side ?


Thanks,


Paolo Patierno
Senior Software Engineer (IoT) @ Red Hat
Microsoft MVP on Windows Embedded & IoT
Microsoft Azure Advisor

Twitter : @ppatierno<http://twitter.com/ppatierno>
Linkedin : paolopatierno<http://it.linkedin.com/in/paolopatierno>
Blog : DevExperience<http://paolopatierno.wordpress.com/>

Re: Kafka doc : official repo or web site repo ?

Posted by Guozhang Wang <wa...@gmail.com>.
Ewen, Paolo:

There is already a PR from Derrick who did the kafka-site PR for kafka repo
as well: https://github.com/apache/kafka/pull/3540

We usually only first push to kafka, and then piggy-back to kafka-site upon
releases; for some changes that we'd like to push in the middle of a
release cycle we usually do double-PRs and two commits.


Guozhang

On Fri, Jul 21, 2017 at 2:19 PM, Ewen Cheslack-Postava <ew...@confluent.io>
wrote:

> Paolo,
>
> Good question and good catch! I think those updates caused things to
> diverge because the author needed to make updates to both the regular docs
> and some of the styling assets that are only in the kafka-site repo. I've
> pinged the folks that worked on it to make sure the changes make it
> properly back into the main Kafka repo.
>
> -Ewen
>
> On Fri, Jul 21, 2017 at 6:23 AM, Paolo Patierno <pp...@live.com>
> wrote:
>
> > Hi Ewen,
> >
> >
> > thank you very much for your answer. I know that you guys are really busy
> > and I pushed my PRs during the 0.11.0 release cycle so ... I can
> > understand, no worries ;)
> >
> >
> > Regarding the documentation happy to know that I pushed in the right repo
> > but ...
> >
> > ... regarding the Kafka Streams new shiny documentation I see that the
> > main page on the web site has the following phrase on the top "The
> easiest
> > way to write mission-critical ..."
> >
> > If I try to search it in the Kafka repo I can't find it (I imagine that
> it
> > should be in docs/streams/index.html ... but it's not there).
> >
> > Instead, if I search for the same phrase in the kafka-site repo I can
> find
> > it in 0110/streams/index.html.
> >
> >
> > So it seems that the doc is in the kafka-site repo but not in the kafka
> > repo ... where am I wrong ?
> >
> >
> > Thanks,
> >
> > Paolo.
> >
> >
> > Paolo Patierno
> > Senior Software Engineer (IoT) @ Red Hat
> > Microsoft MVP on Windows Embedded & IoT
> > Microsoft Azure Advisor
> >
> > Twitter : @ppatierno<http://twitter.com/ppatierno>
> > Linkedin : paolopatierno<http://it.linkedin.com/in/paolopatierno>
> > Blog : DevExperience<http://paolopatierno.wordpress.com/>
> >
> >
> > ________________________________
> > From: Ewen Cheslack-Postava <ew...@confluent.io>
> > Sent: Friday, July 21, 2017 2:57 AM
> > To: dev@kafka.apache.org
> > Subject: Re: Kafka doc : official repo or web site repo ?
> >
> > Hi Paolo,
> >
> > Docs are a little bit confusing. Some of the docs are version-specific
> and
> > those live in the main repo and are managed by the same branches that
> > releases are managed on. Then there is the
> > https://github.com/apache/kafka-site which contains the actual contents
> of
> > the site. During release, the current snapshot of version-specific docs
> are
> > copied into the kafka-site repo (as the current version, or a historical
> > version as you would see at, e.g.,
> > http://kafka.apache.org/0102/documentation.html).
> >
> > For your PR, you submitted to the correct location. Sorry for the delay
> in
> > review, we tend to get a little backlogged -- not enough committers to
> > review and commit the volume of PRs we are getting. I've reviewed and
> > committed that first one and I see you have a bunch of others that we'll
> > try to get to as well. Once you get a feel for which reviewers can/will
> > review different parts of the code, you'll be able to more easily tag
> > committers for review and commit (in the case of Connect, myself
> (@ewencp),
> > @hachikuji, and @gwenshap are good targets).
> >
> > Thanks for contributing! I especially appreciate docs fixes :)
> >
> > -Ewen
> >
> > On Thu, Jul 13, 2017 at 1:51 AM, Paolo Patierno <pp...@live.com>
> > wrote:
> >
> > > Hi guys,
> > >
> > > I have big doubt on where is the doc and what to do for upgrading that.
> > >
> > > I see the docs folder in the Kafka repo (but even there I have a PR
> > opened
> > > for one month on Kafka Connect not yet merged) but then I see the Kafka
> > web
> > > site repo where there is the same doc.
> > >
> > > Reading the new Kafka Stream doc I noticed that it seems to be only in
> > the
> > > Kafka web site repo and not in the Kafka repo.
> > >
> > >
> > > Can you clarifying me where to submit PRs for doc ? On which side ?
> > >
> > >
> > > Thanks,
> > >
> > >
> > > Paolo Patierno
> > > Senior Software Engineer (IoT) @ Red Hat
> > > Microsoft MVP on Windows Embedded & IoT
> > > Microsoft Azure Advisor
> > >
> > > Twitter : @ppatierno<http://twitter.com/ppatierno>
> > > Linkedin : paolopatierno<http://it.linkedin.com/in/paolopatierno>
> > > Blog : DevExperience<http://paolopatierno.wordpress.com/>
> > >
> >
>



-- 
-- Guozhang

Re: Kafka doc : official repo or web site repo ?

Posted by Ewen Cheslack-Postava <ew...@confluent.io>.
Paolo,

Good question and good catch! I think those updates caused things to
diverge because the author needed to make updates to both the regular docs
and some of the styling assets that are only in the kafka-site repo. I've
pinged the folks that worked on it to make sure the changes make it
properly back into the main Kafka repo.

-Ewen

On Fri, Jul 21, 2017 at 6:23 AM, Paolo Patierno <pp...@live.com> wrote:

> Hi Ewen,
>
>
> thank you very much for your answer. I know that you guys are really busy
> and I pushed my PRs during the 0.11.0 release cycle so ... I can
> understand, no worries ;)
>
>
> Regarding the documentation happy to know that I pushed in the right repo
> but ...
>
> ... regarding the Kafka Streams new shiny documentation I see that the
> main page on the web site has the following phrase on the top "The easiest
> way to write mission-critical ..."
>
> If I try to search it in the Kafka repo I can't find it (I imagine that it
> should be in docs/streams/index.html ... but it's not there).
>
> Instead, if I search for the same phrase in the kafka-site repo I can find
> it in 0110/streams/index.html.
>
>
> So it seems that the doc is in the kafka-site repo but not in the kafka
> repo ... where am I wrong ?
>
>
> Thanks,
>
> Paolo.
>
>
> Paolo Patierno
> Senior Software Engineer (IoT) @ Red Hat
> Microsoft MVP on Windows Embedded & IoT
> Microsoft Azure Advisor
>
> Twitter : @ppatierno<http://twitter.com/ppatierno>
> Linkedin : paolopatierno<http://it.linkedin.com/in/paolopatierno>
> Blog : DevExperience<http://paolopatierno.wordpress.com/>
>
>
> ________________________________
> From: Ewen Cheslack-Postava <ew...@confluent.io>
> Sent: Friday, July 21, 2017 2:57 AM
> To: dev@kafka.apache.org
> Subject: Re: Kafka doc : official repo or web site repo ?
>
> Hi Paolo,
>
> Docs are a little bit confusing. Some of the docs are version-specific and
> those live in the main repo and are managed by the same branches that
> releases are managed on. Then there is the
> https://github.com/apache/kafka-site which contains the actual contents of
> the site. During release, the current snapshot of version-specific docs are
> copied into the kafka-site repo (as the current version, or a historical
> version as you would see at, e.g.,
> http://kafka.apache.org/0102/documentation.html).
>
> For your PR, you submitted to the correct location. Sorry for the delay in
> review, we tend to get a little backlogged -- not enough committers to
> review and commit the volume of PRs we are getting. I've reviewed and
> committed that first one and I see you have a bunch of others that we'll
> try to get to as well. Once you get a feel for which reviewers can/will
> review different parts of the code, you'll be able to more easily tag
> committers for review and commit (in the case of Connect, myself (@ewencp),
> @hachikuji, and @gwenshap are good targets).
>
> Thanks for contributing! I especially appreciate docs fixes :)
>
> -Ewen
>
> On Thu, Jul 13, 2017 at 1:51 AM, Paolo Patierno <pp...@live.com>
> wrote:
>
> > Hi guys,
> >
> > I have big doubt on where is the doc and what to do for upgrading that.
> >
> > I see the docs folder in the Kafka repo (but even there I have a PR
> opened
> > for one month on Kafka Connect not yet merged) but then I see the Kafka
> web
> > site repo where there is the same doc.
> >
> > Reading the new Kafka Stream doc I noticed that it seems to be only in
> the
> > Kafka web site repo and not in the Kafka repo.
> >
> >
> > Can you clarifying me where to submit PRs for doc ? On which side ?
> >
> >
> > Thanks,
> >
> >
> > Paolo Patierno
> > Senior Software Engineer (IoT) @ Red Hat
> > Microsoft MVP on Windows Embedded & IoT
> > Microsoft Azure Advisor
> >
> > Twitter : @ppatierno<http://twitter.com/ppatierno>
> > Linkedin : paolopatierno<http://it.linkedin.com/in/paolopatierno>
> > Blog : DevExperience<http://paolopatierno.wordpress.com/>
> >
>

Re: Kafka doc : official repo or web site repo ?

Posted by Paolo Patierno <pp...@live.com>.
Hi Ewen,


thank you very much for your answer. I know that you guys are really busy and I pushed my PRs during the 0.11.0 release cycle so ... I can understand, no worries ;)


Regarding the documentation happy to know that I pushed in the right repo but ...

... regarding the Kafka Streams new shiny documentation I see that the main page on the web site has the following phrase on the top "The easiest way to write mission-critical ..."

If I try to search it in the Kafka repo I can't find it (I imagine that it should be in docs/streams/index.html ... but it's not there).

Instead, if I search for the same phrase in the kafka-site repo I can find it in 0110/streams/index.html.


So it seems that the doc is in the kafka-site repo but not in the kafka repo ... where am I wrong ?


Thanks,

Paolo.


Paolo Patierno
Senior Software Engineer (IoT) @ Red Hat
Microsoft MVP on Windows Embedded & IoT
Microsoft Azure Advisor

Twitter : @ppatierno<http://twitter.com/ppatierno>
Linkedin : paolopatierno<http://it.linkedin.com/in/paolopatierno>
Blog : DevExperience<http://paolopatierno.wordpress.com/>


________________________________
From: Ewen Cheslack-Postava <ew...@confluent.io>
Sent: Friday, July 21, 2017 2:57 AM
To: dev@kafka.apache.org
Subject: Re: Kafka doc : official repo or web site repo ?

Hi Paolo,

Docs are a little bit confusing. Some of the docs are version-specific and
those live in the main repo and are managed by the same branches that
releases are managed on. Then there is the
https://github.com/apache/kafka-site which contains the actual contents of
the site. During release, the current snapshot of version-specific docs are
copied into the kafka-site repo (as the current version, or a historical
version as you would see at, e.g.,
http://kafka.apache.org/0102/documentation.html).

For your PR, you submitted to the correct location. Sorry for the delay in
review, we tend to get a little backlogged -- not enough committers to
review and commit the volume of PRs we are getting. I've reviewed and
committed that first one and I see you have a bunch of others that we'll
try to get to as well. Once you get a feel for which reviewers can/will
review different parts of the code, you'll be able to more easily tag
committers for review and commit (in the case of Connect, myself (@ewencp),
@hachikuji, and @gwenshap are good targets).

Thanks for contributing! I especially appreciate docs fixes :)

-Ewen

On Thu, Jul 13, 2017 at 1:51 AM, Paolo Patierno <pp...@live.com> wrote:

> Hi guys,
>
> I have big doubt on where is the doc and what to do for upgrading that.
>
> I see the docs folder in the Kafka repo (but even there I have a PR opened
> for one month on Kafka Connect not yet merged) but then I see the Kafka web
> site repo where there is the same doc.
>
> Reading the new Kafka Stream doc I noticed that it seems to be only in the
> Kafka web site repo and not in the Kafka repo.
>
>
> Can you clarifying me where to submit PRs for doc ? On which side ?
>
>
> Thanks,
>
>
> Paolo Patierno
> Senior Software Engineer (IoT) @ Red Hat
> Microsoft MVP on Windows Embedded & IoT
> Microsoft Azure Advisor
>
> Twitter : @ppatierno<http://twitter.com/ppatierno>
> Linkedin : paolopatierno<http://it.linkedin.com/in/paolopatierno>
> Blog : DevExperience<http://paolopatierno.wordpress.com/>
>

Re: Kafka doc : official repo or web site repo ?

Posted by Ewen Cheslack-Postava <ew...@confluent.io>.
Hi Paolo,

Docs are a little bit confusing. Some of the docs are version-specific and
those live in the main repo and are managed by the same branches that
releases are managed on. Then there is the
https://github.com/apache/kafka-site which contains the actual contents of
the site. During release, the current snapshot of version-specific docs are
copied into the kafka-site repo (as the current version, or a historical
version as you would see at, e.g.,
http://kafka.apache.org/0102/documentation.html).

For your PR, you submitted to the correct location. Sorry for the delay in
review, we tend to get a little backlogged -- not enough committers to
review and commit the volume of PRs we are getting. I've reviewed and
committed that first one and I see you have a bunch of others that we'll
try to get to as well. Once you get a feel for which reviewers can/will
review different parts of the code, you'll be able to more easily tag
committers for review and commit (in the case of Connect, myself (@ewencp),
@hachikuji, and @gwenshap are good targets).

Thanks for contributing! I especially appreciate docs fixes :)

-Ewen

On Thu, Jul 13, 2017 at 1:51 AM, Paolo Patierno <pp...@live.com> wrote:

> Hi guys,
>
> I have big doubt on where is the doc and what to do for upgrading that.
>
> I see the docs folder in the Kafka repo (but even there I have a PR opened
> for one month on Kafka Connect not yet merged) but then I see the Kafka web
> site repo where there is the same doc.
>
> Reading the new Kafka Stream doc I noticed that it seems to be only in the
> Kafka web site repo and not in the Kafka repo.
>
>
> Can you clarifying me where to submit PRs for doc ? On which side ?
>
>
> Thanks,
>
>
> Paolo Patierno
> Senior Software Engineer (IoT) @ Red Hat
> Microsoft MVP on Windows Embedded & IoT
> Microsoft Azure Advisor
>
> Twitter : @ppatierno<http://twitter.com/ppatierno>
> Linkedin : paolopatierno<http://it.linkedin.com/in/paolopatierno>
> Blog : DevExperience<http://paolopatierno.wordpress.com/>
>