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

Quickstart for grafana could use a simple example #135

Closed
skyreflectedinmirrors opened this issue Jun 6, 2023 · 3 comments
Closed

Quickstart for grafana could use a simple example #135

skyreflectedinmirrors opened this issue Jun 6, 2023 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@skyreflectedinmirrors
Copy link
Contributor

https://github.com/AMDResearch/omniperf/blob/a346db7646b0a935f4cac51d131b4a585f065c05/src/docs/getting_started.md?plain=1#L46

Similar to the other examples in this section, but here we give ~ no detail. At the very least, we should say something like "this requires installation specific connection details, see the Database discussion below for information about how to obtain these"

@coleramos425 coleramos425 added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 8, 2023
@coleramos425 coleramos425 self-assigned this Jun 21, 2023
@coleramos425 coleramos425 added this to the v.1.1.0 milestone Jun 21, 2023
@bcaddy
Copy link

bcaddy commented Jul 6, 2023

I'd like to second this. I'm an OLCF user trying to use Omniperf and even after reading the documentation I have absolutely no idea what I'm supposed to do to get grafana setup.

coleramos425 added a commit that referenced this issue Aug 14, 2023
Signed-off-by: coleramos425 <colramos@amd.com>
@coleramos425
Copy link
Collaborator

Thanks for the suggestion. I've added more details to the Grafana setup and usage sections. Please see those additions and let me know if anything is still unclear.

https://amdresearch.github.io/omniperf/installation.html

@bcaddy
Copy link

bcaddy commented Aug 17, 2023

This looks better. Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants