Is it me, or is the documentation for Variable syntax | Grafana documentation severely lacking in both clarity and content? How can one figure out how to use templates? Is there some hidden documentation somewhere?
Yeah, even I believe Grafana lacks detail documentation about its features. The only way to figure out its functionality is by trial and error.
Have you watched Torkel’s video on templating: http://docs.grafana.org/guides/screencasts/
More videos can be found here.
We are aware that we have some holes in the documentation and we will be working to make them better in the coming months. Templating will be at the top of the list.
1 Like
OK, to get back on track.
I apologize for letting my frustration spill over into a public mailing
list, especially since I haven’t been 13 in a very long time.
How can I help to remedy the documentation situation? I am perfectly
willing to put in the effort to write good documentation. But the problem
of how to start remains: how can one document what one does not understand?
I’ll go back to the page that caused the original outburst:
http://docs.grafana.org/features/datasources/prometheus/
Note that that page still refers to version 2.6, even though grafana is now
at version 4.2.
/ji
personnaly after having the same trouble you did I went into https://grafana.com/dashboards and download some examples to understand how to some of the community members did the templating.
I am currently rewriting & updating the templating docs as they are rightly abysmal. They have not seen updates and iterative improvements in over a year so in great need of a major overhaul. Will also try to update the templating sections for each data source.
Will post an update here when the updates are ready for review & feedback.
Templating docs are now updated.
http://docs.grafana.org/reference/templating/
It’s a major overhaul of the templating article and of the templating sections for each data source. The Prometheus docs were also given a minor update (not just the templating section).
Here is the diff of all the changes:
https://github.com/grafana/grafana/commit/0bab1fd088edf091dc6fd9fff5a6d548d9a36f5c
Any feedback would great.
1 Like