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

Next steps on opmonlib documentation #13

Open
jcfreeman2 opened this issue Apr 29, 2021 · 0 comments
Open

Next steps on opmonlib documentation #13

jcfreeman2 opened this issue Apr 29, 2021 · 0 comments

Comments

@jcfreeman2
Copy link
Contributor

It looks like there's a decent amount of material, but some of it's outdated. E.g., there's a discussion of the InfoGatherer class, but that appears to no longer exist. There's a good amount of info on InfoCollector but not on InfoProvider or InfoManager; to the extent that I find their headers in the public include/ directory and therefore imagine they'll be used by user-developers, it would nice to see them also documented.

Home.md, which is the homepage on the Wiki (as opposed to the README.md) is basically a skeleton, so the good news is we don't need to worry about merging it into README.md and can just get rid of it

The README.md has an unfilled section titled "Building and running examples" which I imagine we'd still want to have written.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant