Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create User Guide document #71

Closed
ondrej-fabry opened this issue Oct 19, 2022 · 3 comments · Fixed by #110
Closed

Create User Guide document #71

ondrej-fabry opened this issue Oct 19, 2022 · 3 comments · Fixed by #110
Assignees
Labels
docs Documentation & Examples
Milestone

Comments

@ondrej-fabry
Copy link
Member

ondrej-fabry commented Oct 19, 2022

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

Here are few ideas for topics to cover:

@ondrej-fabry ondrej-fabry added docs Documentation & Examples help wanted labels Oct 19, 2022
@edwarnicke
Copy link
Contributor

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
Copy link
Member Author

ondrej-fabry commented Oct 24, 2022

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.

@ondrej-fabry ondrej-fabry added this to the v0.8.0 milestone Nov 15, 2022
@dwallacelf
Copy link
Collaborator

dwallacelf commented Dec 19, 2022

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?

@ondrej-fabry ondrej-fabry linked a pull request Feb 23, 2023 that will close this issue
@sknat sknat closed this as completed in #110 Mar 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation & Examples
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

4 participants