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

Ryan Skraba updated AVRO-2393:
------------------------------
    Labels: documentation  (was: )

> C#: Add examples for new users
> ------------------------------
>
>                 Key: AVRO-2393
>                 URL: https://issues.apache.org/jira/browse/AVRO-2393
>             Project: Apache Avro
>          Issue Type: Improvement
>          Components: csharp
>            Reporter: Brian Lachniet
>            Assignee: Brian Lachniet
>            Priority: Minor
>              Labels: documentation
>             Fix For: 1.10.0
>
>
> Add examples of usage for the C# API. The goal of this documentation and/or 
> code examples is to make it easier for those new to the C# API to hit the 
> ground running.
> Ideas for example locations:
>  * In the README.md
>  ** (y) Highly and immediately visible
>  ** (n) Not automatically tested
>  ** (n) Not automatically built
>  * In specially designated "example" projects (for example, like 
> [confluent-kafka-dotnet|https://github.com/confluentinc/confluent-kafka-dotnet/tree/master/examples]
>  ** (n) Not immediately visible, harder to find. Would need to mention  in 
> README.md
>  ** (n) Not automatically tested
>  ** (y) Automatically built
>  * In unit tests designed especially for readability
>  ** (n) Not immediately visible, harder to find. Would need to mention in 
> README.md
>  ** (y) Automatically tested
>  ** (y) Automatically built



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Reply via email to