[
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.0.tar.gz
AVRO-1202.0.patch
Here's what I have so far. I've written rough drafts of "Getting started" pages
for Java and Python, and created an "examples" directory containing the code
from the guides. So far the guides go over a very basic schema, the Maven
plugin, code generation using avro-tools, and basic data file reading/writing.
Personally, I don't think we should add much more material to these pages -- I
like the idea of a short, self-contained example that just gets you up and
running (a "5-minute intro"). I do think we should add (and link to) other
pages going over the topics Doug suggests.
I'm just learning Avro myself as I write this guide, so any feedback is
appreciated! In particular, I'm not sure how best to include the example code
-- I created a Maven project for the Java example in order to give an example
POM and to make it easy to build and run, but I could also give
code/instructions for downloading the required jars and compiling the code
manually.
My immediate next steps are writing an MR page and a more complete schema
example.
I've included a patch as well as a .tar.gz containing the new HTML files and
the example code directory for convenience.
> 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
>
> Attachments: AVRO-1202.0.patch, AVRO-1202.0.tar.gz
>
>
> 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
