samza-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Martin Kleppmann" <mkleppm...@linkedin.com>
Subject Re: Review Request 21866: SAMZA-7: Update docs to no longer refer to Samza 0.6 classes
Date Thu, 05 Jun 2014 22:02:12 GMT


> On June 4, 2014, 7:41 p.m., Jakob Homan wrote:
> > docs/learn/documentation/0.7.0/api/overview.md, line 27
> > <https://reviews.apache.org/r/21866/diff/2/?file=602026#file602026line27>
> >
> >     Something that confused me at the beginning was that this name, Kafka, is arbitrary.
 I think people assume we have built-in mapping to the Kafka factories.  Not sure if this
is worth calling out.

Yes, I think that is worth calling out. (I had the same confusion with serdes.) I've included
the factory property in more of the config examples, hopefully making clear the link between
the factory class and the alias. I've also added an explicit note on this page to say the
system name is user-defined.


> On June 4, 2014, 7:41 p.m., Jakob Homan wrote:
> > docs/learn/documentation/0.7.0/api/overview.md, line 62
> > <https://reviews.apache.org/r/21866/diff/2/?file=602026#file602026line62>
> >
> >     cluster may not be the best term here.  File-based streams, irc-based streams,
etc. wouldn't fit.

Good point. I've rephrased it, and avoided the word "cluster" (which is just unnecessary jargon
anyway).


> On June 4, 2014, 7:41 p.m., Jakob Homan wrote:
> > docs/learn/documentation/0.7.0/api/overview.md, line 110
> > <https://reviews.apache.org/r/21866/diff/2/?file=602026#file602026line110>
> >
> >     Is there a way to call this out visually, a warning block or something?

Not sure what we have in our stylesheet, but for now I've added a bold "NOTE:".


> On June 4, 2014, 7:41 p.m., Jakob Homan wrote:
> > docs/learn/documentation/0.7.0/container/checkpointing.md, line 54
> > <https://reviews.apache.org/r/21866/diff/2/?file=602028#file602028line54>
> >
> >     This is a pretty confusing API.  Can we add a table?

Agree it's confusing. I can't quite visualise what kind of table you imagine though. Could
you sketch it?


> On June 4, 2014, 7:41 p.m., Jakob Homan wrote:
> > docs/learn/documentation/0.7.0/container/samza-container.md, line 54
> > <https://reviews.apache.org/r/21866/diff/2/?file=602033#file602033line54>
> >
> >     Table?

Good idea. Done.


> On June 4, 2014, 7:41 p.m., Jakob Homan wrote:
> > docs/learn/documentation/0.7.0/container/state-management.md, line 66
> > <https://reviews.apache.org/r/21866/diff/2/?file=602035#file602035line66>
> >
> >     S4 is considering retirement from Incubator.  It may not be the best example.

Ok, I've replaced it with a Storm example (which is not quite the same, but will serve the
purpose of illustration).


> On June 4, 2014, 7:41 p.m., Jakob Homan wrote:
> > docs/learn/documentation/0.7.0/jobs/logging.md, line 10
> > <https://reviews.apache.org/r/21866/diff/2/?file=602043#file602043line10>
> >
> >     Include link to log4j config difficulties, ie SAMZA-109.

Good point, I've added it.


- Martin


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/21866/#review44743
-----------------------------------------------------------


On June 2, 2014, 10:49 p.m., Martin Kleppmann wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/21866/
> -----------------------------------------------------------
> 
> (Updated June 2, 2014, 10:49 p.m.)
> 
> 
> Review request for samza.
> 
> 
> Repository: samza
> 
> 
> Description
> -------
> 
> Also general improvements:
> 
> * Heavy editing of API overview and pages in the Container section of
>   the docs, for improved clarity.
> * Added links to javadocs where appropriate.
> * Added a page on serialization, which wasn't really covered previously.
> 
> 
> Diffs
> -----
> 
>   docs/img/0.7.0/learn/documentation/container/checkpointing-2.png cfd85e1700595a2fe47d8bafd4656c637d50129f

>   docs/img/0.7.0/learn/documentation/container/checkpointing.png aa3624022eecdb39c0c20d873b2641bdea3c55ea

>   docs/img/0.7.0/learn/documentation/container/checkpointing.svg PRE-CREATION 
>   docs/img/0.7.0/learn/documentation/container/job-flow.png 046f9e3f24158bb4e9be797ffc09d5210a7dccd2

>   docs/img/0.7.0/learn/documentation/container/metrics.png 8be2a38ec6ce03bc617ebddbe8799f8c2cff13f1

>   docs/img/0.7.0/learn/documentation/container/tasks-and-partitions.png 68b753f14b4366d49c0c6959ec903b17288846dd

>   docs/img/0.7.0/learn/documentation/container/tasks-and-partitions.svg PRE-CREATION

>   docs/learn/documentation/0.7.0/api/overview.md 2d03ec3efdab3b8046d4de57d00cc9dd89c6bdae

>   docs/learn/documentation/0.7.0/comparisons/mupd8.md 78e7b6429edb759ad11d3a840059e93a17e613e4

>   docs/learn/documentation/0.7.0/container/checkpointing.md 42b2e8dde9d5160b698e1d973aa8da53163e5455

>   docs/learn/documentation/0.7.0/container/event-loop.md 1f9c51e4eab460b573a8f05696df71769dc1baa0

>   docs/learn/documentation/0.7.0/container/index.md 17751de05e3029006541878b401f0a0d53373c71

>   docs/learn/documentation/0.7.0/container/jmx.md a9fcc779cc16b3c8f25bbf56ceea3b451b376c93

>   docs/learn/documentation/0.7.0/container/metrics.md 078ce47807f8cc88c7eaaea01c8a98a7cd4274e2

>   docs/learn/documentation/0.7.0/container/samza-container.md PRE-CREATION 
>   docs/learn/documentation/0.7.0/container/serialization.md PRE-CREATION 
>   docs/learn/documentation/0.7.0/container/state-management.md aa418ffac114c2956d92fb55eb81ab6f7cf70881

>   docs/learn/documentation/0.7.0/container/streams.md 0f18b345165f29ebcc4a3443f1397447c3aaf40d

>   docs/learn/documentation/0.7.0/container/task-runner.md bdc5ab604bc6c62262c4b53157aa77ace08c7788

>   docs/learn/documentation/0.7.0/container/windowing.md 6a243781e512591639e65db1ddb551a09a852903

>   docs/learn/documentation/0.7.0/index.html 7806baf71bee61e5316d5bc627fee219012d3375

>   docs/learn/documentation/0.7.0/introduction/architecture.md c4e0fc97f563d7b115f5bc5b27ae1496101dda31

>   docs/learn/documentation/0.7.0/jobs/configuration.md d4a516eb6bf5a01f631859d0b2296a506501d1d6

>   docs/learn/documentation/0.7.0/jobs/job-runner.md c73b23425dab77346f5d684760d51a3f30b34511

>   docs/learn/documentation/0.7.0/jobs/logging.md 6bb6bf4b3630165159acc47e4cfb8e1afe6659cb

>   docs/learn/documentation/0.7.0/jobs/packaging.md 62c089a915f9103e5a1f38a3b44bc4e4348573be

>   docs/learn/documentation/0.7.0/jobs/yarn-jobs.md 3d971cd444f71b2763c29c295f0c54ab034bb251

>   docs/learn/documentation/0.7.0/yarn/application-master.md 0da6dc0c4cf26567bdf37d10218853a27525be27

>   docs/learn/documentation/0.7.0/yarn/isolation.md c68572967d4aaaa2ab9f973e7b62f7c604b07ff5

> 
> Diff: https://reviews.apache.org/r/21866/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Martin Kleppmann
> 
>


Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message