[AVRO-2393] C#: Add examples for new users

• Type: Improvement
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Component/s: csharp
• Labels: documentation
• Assignee: Brian Lachniet
• Reporter: Brian Lachniet
• Created: 11/May/19 03:10
• Updated: 29/May/20 15:38

Description

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
  •  Highly and immediately visible
  •  Not automatically tested
  •  Not automatically built
• In specially designated "example" projects (for example, like confluent-kafka-dotnet
  •  Not immediately visible, harder to find. Would need to mention  in README.md
  •  Not automatically tested
  •  Automatically built
• In unit tests designed especially for readability
  •  Not immediately visible, harder to find. Would need to mention in README.md
  •  Automatically tested
  •  Automatically built

Issue Links

• links to: GitHub Pull Request #518