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

Sid S commented on AVRO-1420:
-----------------------------

I agree we shouldn't be cluttering the main repo with peripheral/supporting 
libraries and stuff. 

I also agree that we should be using a Maven counterpart to download the 
external dependencies at build time as a mechanism for the above clutter 
control.

What I differ on is NPandey since the defacto standard in the C# world is 
NuGet. Any developer interested in the C# version of Avro is 99% certain to be 
already using NuGet as part of their development workflow (like a Java dev uses 
NAnt or Maven). NuGet works on Linux, Mac (MonoDevelop) and Windows (Visual 
Studio). 

The only reason I manually added the Avro .DLLs to the HeloAvro GIT repo is 
because I recently noticed Avro currently doesn't have a NuGet package. 
Searching for Avro gives Microsoft's Avro Hadoop extension 
(http://www.nuget.org/packages/Microsoft.Hadoop.Avro/) which while fast has 
issues related to making every field optional/nullable which adds bloat/breaks 
on-wire compatibility. FYI, I've compared popular C# serializers at 
https://github.com/sidshetye/SerializersCompare#results

Anyway, before going too off topic on NuGet and other serializers, for this 
ticket on documentation, here is what I propose for the time being:

1. Feel free to link to the HelloAvro GitHub project so people can at least 
lookup and get started on "how to use" C# + Avro. My $0.02 would be:
1-a. You can copy-paste the code from 
https://github.com/sidshetye/HelloAvro/blob/master/SerializerAvro.cs
1-b. You can mention that the IDL => schema => auto-gen classes are illustrated 
in https://github.com/sidshetye/HelloAvro/blob/master/code-gen.bat 

2. I can file another ticket on getting Avro on NuGet (it's a very quick thing 
- make a NuGet author account on the NuGet portal, package the .DLL , upload 
the DLL - the latter two steps are one command line each) Info: 
http://docs.nuget.org/docs/creating-packages/creating-and-publishing-a-package 
but I'll put this in the ticket because it's a separate issue than this 
documentation one.

3. At a later date, we can optimize the HelloAvro to work completely off NuGet 
and mainline that into the main repo

What do you think?

Cheers
Sid



> C# documentation is completely empty/wiped out
> ----------------------------------------------
>
>                 Key: AVRO-1420
>                 URL: https://issues.apache.org/jira/browse/AVRO-1420
>             Project: Avro
>          Issue Type: Bug
>          Components: csharp, doc
>    Affects Versions: 1.7.5
>            Reporter: Sid S
>
> 1. Go to http://avro.apache.org/docs/current/api/csharp/index.html
> 2. Find blank page
> Note that this is the root page for C# documentation, went there looking for 
> basic hello world style documentation to get started.



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

Reply via email to