You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@avro.apache.org by "Doug Cutting (JIRA)" <ji...@apache.org> on 2012/11/09 19:34:14 UTC

[jira] [Commented] (AVRO-1202) Add "Getting started" guide to documentation

    [ https://issues.apache.org/jira/browse/AVRO-1202?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13494189#comment-13494189 ] 

Doug Cutting commented on AVRO-1202:
------------------------------------

A user guide would be great to have!

Topics might include:
- Concepts
 -- Schemas & Protocols
 -- Generic, Specific & Reflect APIs
 -- IDL
- Command line tools
- Maven plugins
- Reading and writing data files
- Writing MapReduce jobs
- Integration with other projects
 -- Pig
 -- Hive
 -- Flume
- RPC


                
> 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
>              Labels: documentation
>             Fix For: 1.7.3
>
>
> 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