[jira] [Updated] (SAMZA-136) Copy-editing documentation

["Martin Kleppmann (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/SAMZA-136?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Martin Kleppmann updated SAMZA-136:
-----------------------------------

    Attachment: SAMZA-136-v2.patch
                group-by-example.png
                dag.png

I have attached an updated patch, which further edits the introduction, and also makes substantial changes to the 'comparisons' section of the docs. In particular, I've rewritten the comparison with Storm (as it reflects the state of Storm before Aug 2012, and Storm has changed a lot since then) and the explanation of Samza's state handling (because I found the previous explanation confusing).

I have also changed "member" to "user" throughout the documentation, as discussed.

Attached two updated image files separately, because they're not included in the patch. They belong in the docs/img/0.7.0/learn/documentation/introduction directory.

Could you take a look if this looks reasonable? I'm hoping everything is clear and accurate, but please let me know if you find any issues.

If it's ok, I suggest we commit this. I'm planning to edit the rest of the documentation (including SAMZA-7) later, but this patch is already getting quite large. Thanks!

> Copy-editing documentation
> --------------------------
>
>                 Key: SAMZA-136
>                 URL: https://issues.apache.org/jira/browse/SAMZA-136
>             Project: Samza
>          Issue Type: Improvement
>          Components: docs
>    Affects Versions: 0.7.0
>            Reporter: Martin Kleppmann
>            Assignee: Martin Kleppmann
>            Priority: Minor
>         Attachments: SAMZA-136-v1.html, SAMZA-136-v1.patch, SAMZA-136-v2.patch, dag.png, group-by-example.png
>
>
> The documentation at http://samza.incubator.apache.org/learn/documentation/0.7.0/ is good in terms of content, but would benefit from a bit of editing to make it smoother to read. I am happy to go through it.



--
This message was sent by Atlassian JIRA
(v6.1.5#6160)