Create User Guide document

[ondrej-fabry]

This issue tracks progress of creating User Guide document for using GoVPP.

Here are few ideas for topics to cover:

• How to use Binary API generator (some of this already covered in docs/GENERATOR.md but might need updating)
• How to call VPP API - Channel vs Stream
• How to use generated RPC client
• How to use Stats interfaces - StatsAPI vs StatsProvider (posted by @VladoLavor in Create Troubleshooting Guide document #60)
• 🤔 ... add more ideas ...

[edwarnicke]

The very best thing we could do for usability is to get the *.api comments captured into the json files so we could then convert them to comments on the generated APIs. The usability, particularly to users who aren't in vpp code day in and day out would be huge.

[ondrej-fabry]

The very best thing we could do for usability is to get the *.api comments captured into the json files so we could then convert them to comments on the generated APIs. The usability, particularly to users who aren't in vpp code day in and day out would be huge.

Totally agree here. There is even open change request on Gerrit from Ole T. which adds support for this (no idea why not merged yet).

However, that is not really what this issue is about. This issue is about creating user guide document for using GoVPP - how to call VPP API and use Stats API in general. The specific API messages and their usage/comments are out of scope and can rather be tracked in another issue.

[dwallacelf]

There is even open change request on Gerrit from Ole T. which adds support for this (no idea why not merged yet).

I rebased gerrit change: vppapigen: include comments in json and pinged Ole about the status. He is fine with the patch but it has not been tested. @ondrej-fabry , can you please open a new issue & test that this patch works with GoVPP?