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

Polish "Grafana Dashboard" section #5662

Open
wants to merge 1 commit into
base: 1.12.x
Choose a base branch
from

Conversation

izeye
Copy link
Contributor

@izeye izeye commented Nov 14, 2024

This PR adds a note for a link to the GitHub repository for the Prometheus Grafana dashboard.

By the way, while working on this, the "Grafana Dashboard" section seems to contain a copy from the contents in the Grafana dashboard page, which is easy to get out of sync and is actually out of sync a bit already.

It might be better to remove the contents and have a link to the Grafana dashboard page only. Or if the GitHub repository has a proper README file later, it would be better to link to the README instead.

See gh-5661

/cc @mweirauch

@izeye izeye mentioned this pull request Nov 14, 2024
@jonatan-ivanov
Copy link
Member

jonatan-ivanov commented Nov 22, 2024

What do you think about deleting the whole section and doing something like this instead (probably on 1.12.x):

Grafana Dashboard

There are many third-party Grafana dashboards publicly available on GrafanaHub, see an example here.

NOTE: The dashboards are maintained by the community in their external GitHub repositories, so if you have an issue, it should be created in their respective GitHub repository.

@jonatan-ivanov jonatan-ivanov added doc-update A documentation update registry: prometheus A Prometheus Registry related issue labels Nov 22, 2024
@jonatan-ivanov jonatan-ivanov added this to the 1.13.9 milestone Nov 22, 2024
@izeye izeye changed the base branch from main to 1.12.x November 22, 2024 02:33
@izeye izeye changed the title Add note for a link to GitHub repository for Prometheus Grafana dashboard Polish "Grafana Dashboard" section Nov 22, 2024
@izeye
Copy link
Contributor Author

izeye commented Nov 22, 2024

@jonatan-ivanov Thanks for the feedback!

I updated as you suggested.

@izeye
Copy link
Contributor Author

izeye commented Nov 22, 2024

@mweirauch https://grafana.com/grafana/dashboards/4701-jvm-micrometer/ doesn't seem to have a link to the GitHub repo, so you might want to add one.

@mweirauch
Copy link
Contributor

@mweirauch https://grafana.com/grafana/dashboards/4701-jvm-micrometer/ doesn't seem to have a link to the GitHub repo, so you might want to add one.

@izeye Yes, I didn't come around to do it, yet. Thanks for the heads-up!

@mweirauch
Copy link
Contributor

@izeye The README over at grafana.com has been updated. Actually took some hours for the change to take effect.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-update A documentation update registry: prometheus A Prometheus Registry related issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants