Hello Avro world,

A while ago I had some frustration trying to understand a complex Avro
schema, a JSON file thousands of lines long, with many nested record
types. I ended up using regexes in vim to manually transform it into
something readable. I wondered: why isn't there something like
Javadoc, but for Avro schemas?

So I built the tool that I wanted: https://github.com/ept/avrodoc

Avrodoc is still at an early stage, but it already does the job of
giving you Javadoc-like browsable documentation for Avro schemata.
Check the demo on the website, try it yourself, and I'd love to hear
any feedback!

Martin

That's awesome!

Would you be interested in contributing this to Apache?

Doug

On Fri, Nov 9, 2012 at 7:05 AM, Martin Kleppmann <[EMAIL PROTECTED]> wrote:
> Hello Avro world,
>
> A while ago I had some frustration trying to understand a complex Avro
> schema, a JSON file thousands of lines long, with many nested record
> types. I ended up using regexes in vim to manually transform it into
> something readable. I wondered: why isn't there something like
> Javadoc, but for Avro schemas?
>
> So I built the tool that I wanted: https://github.com/ept/avrodoc
>
> Avrodoc is still at an early stage, but it already does the job of
> giving you Javadoc-like browsable documentation for Avro schemata.
> Check the demo on the website, try it yourself, and I'd love to hear
> any feedback!
>
> Martin

Thanks, I'd love to have it part of Apache! What would that involve in practice?

(Purely selfishly, I quite like working with git and Github rather
than svn and JIRA, but I'm happy to fit in with Apache's processes.)

Martin

On 9 November 2012 17:57, Doug Cutting <[EMAIL PROTECTED]> wrote:
> That's awesome!
>
> Would you be interested in contributing this to Apache?
>
> Doug
>
> On Fri, Nov 9, 2012 at 7:05 AM, Martin Kleppmann <[EMAIL PROTECTED]> wrote:
>> Hello Avro world,
>>
>> A while ago I had some frustration trying to understand a complex Avro
>> schema, a JSON file thousands of lines long, with many nested record
>> types. I ended up using regexes in vim to manually transform it into
>> something readable. I wondered: why isn't there something like
>> Javadoc, but for Avro schemas?
>>
>> So I built the tool that I wanted: https://github.com/ept/avrodoc
>>
>> Avrodoc is still at an early stage, but it already does the job of
>> giving you Javadoc-like browsable documentation for Avro schemata.
>> Check the demo on the website, try it yourself, and I'd love to hear
>> any feedback!
>>
>> Martin

Mostly what you've just done: given explicit permission for Apache to
incorporate your code.

On top of that it would be great if you could help figure out how to
integrate this into the source tree and build process. Please file a Jira
issue if you're able to help. We can iterate on patch files there.

Doug
On Nov 9, 2012 2:13 PM, "Martin Kleppmann" <[EMAIL PROTECTED]> wrote:

> Thanks, I'd love to have it part of Apache! What would that involve in
> practice?
>
> (Purely selfishly, I quite like working with git and Github rather
> than svn and JIRA, but I'm happy to fit in with Apache's processes.)
>
> Martin
>
> On 9 November 2012 17:57, Doug Cutting <[EMAIL PROTECTED]> wrote:
> > That's awesome!
> >
> > Would you be interested in contributing this to Apache?
> >
> > Doug
> >
> > On Fri, Nov 9, 2012 at 7:05 AM, Martin Kleppmann <[EMAIL PROTECTED]>
> wrote:
> >> Hello Avro world,
> >>
> >> A while ago I had some frustration trying to understand a complex Avro
> >> schema, a JSON file thousands of lines long, with many nested record
> >> types. I ended up using regexes in vim to manually transform it into
> >> something readable. I wondered: why isn't there something like
> >> Javadoc, but for Avro schemas?
> >>
> >> So I built the tool that I wanted: https://github.com/ept/avrodoc
> >>
> >> Avrodoc is still at an early stage, but it already does the job of
> >> giving you Javadoc-like browsable documentation for Avro schemata.
> >> Check the demo on the website, try it yourself, and I'd love to hear
> >> any feedback!
> >>
> >> Martin
>

Hey guys,
Just a thought:
For me as a user it would be more useful to operate on avro docs as I
operate on javadocs which means:
1) Having an IDE plugin like "javadoc view" in Eclipse
2) Having some tools integrated to Maven or Ant to generate the html docs
(I am not sure about this, but keeping it the way it is now for javadocs
seems useful)
I am not an expert on Avro, nor did I try the avrodoc tool, these are just
thoughts:)
But the tools looks great, I think I'll try it some day:)
On Sat, Nov 10, 2012 at 3:08 AM, Doug Cutting <[EMAIL PROTECTED]> wrote:

> Mostly what you've just done: given explicit permission for Apache to
> incorporate your code.
>
> On top of that it would be great if you could help figure out how to
> integrate this into the source tree and build process. Please file a Jira
> issue if you're able to help. We can iterate on patch files there.
>
> Doug
> On Nov 9, 2012 2:13 PM, "Martin Kleppmann" <[EMAIL PROTECTED]> wrote:
>
>> Thanks, I'd love to have it part of Apache! What would that involve in
>> practice?
>>
>> (Purely selfishly, I quite like working with git and Github rather
>> than svn and JIRA, but I'm happy to fit in with Apache's processes.)
>>
>> Martin
>>
>> On 9 November 2012 17:57, Doug Cutting <[EMAIL PROTECTED]> wrote:
>> > That's awesome!
>> >
>> > Would you be interested in contributing this to Apache?
>> >
>> > Doug
>> >
>> > On Fri, Nov 9, 2012 at 7:05 AM, Martin Kleppmann <[EMAIL PROTECTED]>
>> wrote:
>> >> Hello Avro world,
>> >>
>> >> A while ago I had some frustration trying to understand a complex Avro
>> >> schema, a JSON file thousands of lines long, with many nested record
>> >> types. I ended up using regexes in vim to manually transform it into
>> >> something readable. I wondered: why isn't there something like
>> >> Javadoc, but for Avro schemas?
>> >>
>> >> So I built the tool that I wanted: https://github.com/ept/avrodoc
>> >>
>> >> Avrodoc is still at an early stage, but it already does the job of
>> >> giving you Javadoc-like browsable documentation for Avro schemata.
>> >> Check the demo on the website, try it yourself, and I'd love to hear
>> >> any feedback!
>> >>
>> >> Martin
>>
>