e9bcee30fa
Besides minor language corrections, this tries in particular to provide some clarity about the `step` setting in the Prometheus range query and the `$__interval` variable: - First of all: They are both always the same. - What's really confusing (and arguably really un-helpful) is that the _Min time interval_ is multiplied by the resolution factor. Therefore, I just state the fact here now but don't add anything like "This should be the scrape interval" because it is not true (if resolution is `1/10`, a meaningful _Min time interval_ is generally a tenth of the scrape interval). - More helpful is the _Min step_ parameter, because it is not multiplied by the resolution factor (which I have now stated explicitly). Of course, the _Min time interval_ has to be set to something small so that the _Min step_ parameter can kick in. It would be good if we could also override the _Min time interval_ tool tip because that is where most people will look, and the current, very Graphite-centric tool tip is very confusing for the Prometheus query editor, in particular because it doesn't have any hint about the resolution factor being applied. See #21413. Signed-off-by: beorn7 <beorn@grafana.com> |
||
|---|---|---|
| .. | ||
| sources | ||
| .gitignore | ||
| logo-horizontal.png | ||
| Makefile | ||
| README.md | ||
| versions.json | ||
Building the docs locally
When you contribute to documentation, it is a good practice to build the docs on your local machine to make sure your changes appear as you expect. This README explains the process for doing that.
Requirements
Docker >= 2.1.0.3
Build the doc site
- In the command line, make sure you are in the docs folder:
cd docs. - Run
make docs. This launches a preview of the docs website athttp://localhost:3002/docs/grafana/latest/which will refresh automatically when changes to content in thesourcesdirectory are made.
Content guidelines
Edit content in the sources directory.
Using relref for internal links
Use the Hugo shortcode relref any time you are linking to other internal docs pages.
Edit the side menu
Edit sources/menu.yaml to make changes to the sidebar. Restart the make run command for changes to take effect.
Add images
Images are currently hosted in the grafana/website repo.
Deploy changes to grafana.com
When a PR is merged to master with changes in the docs directory, those changes are automatically synched to the grafana/website repo on the docs-grafana branch.
In order to make those changes live, open a PR in the website repo that merges the docs-grafana branch into master. Then follow the publishing guidelines in that repo.