avro-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Skye Wanderman-Milne (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (AVRO-1202) Add "Getting started" guide to documentation
Date Mon, 12 Nov 2012 20:59:12 GMT

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

Skye Wanderman-Milne updated AVRO-1202:
---------------------------------------

    Attachment: AVRO-1202.1.tar.gz
                AVRO-1202.1.patch

Thanks for the feedback everyone! I added some minor fixes (removing whitespace, adding more
formatting tags, etc.). I've also included all the generated docs files, including css, in
the .tar.gz so you can actually see the formatting.

If someone can verify that using a builder is the preferred way to construct Avro objects,
I'll change the examples accordingly.

Jeff, thanks for the code example. I think for the getting started guides we should keep it
simple and stick to using one schema, but a separate page going over your example with multiple
schemas would be very useful if you want to write one up. (Maybe flesh it out a little to
go over how this works, cases where this does/doesn't work, etc. -- I actually don't know
much about using multiple schemas myself :))
                
> Add "Getting started" guide to documentation
> --------------------------------------------
>
>                 Key: AVRO-1202
>                 URL: https://issues.apache.org/jira/browse/AVRO-1202
>             Project: Avro
>          Issue Type: Improvement
>          Components: doc
>            Reporter: Skye Wanderman-Milne
>            Assignee: Skye Wanderman-Milne
>              Labels: documentation
>             Fix For: 1.7.3
>
>         Attachments: AVRO-1202.0.patch, AVRO-1202.0.tar.gz, AVRO-1202.1.patch, AVRO-1202.1.tar.gz,
AVRO-1202.patch
>
>
> The Avro documentation is currently not very beginner-friendly -- it's hard to figure
out basics like code generation, de/serialization, etc. We should write a "Getting started"
guide and similar documentation for those new to Avro, as well as include some example code
with the docs.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Mime
View raw message