opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-09-26 10:04:14 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
grafana/docs
History
Marcus Andersson 0c8390cea2 Templating: global/system variables should be properly replaced in templated values. (#27394) 
* Fixed so we try to use the variables in the redux store to replace values in template variables.

* First draft of working version.

* Including fieldPath when adding :text format.

* cleaned up code by introducing helper function.

* some minor refactoring.

* Added tests and support for multi variables.

* added test and code to handle the All scenario of a multivariable.

* fixed according to feedback.

* added docs.

* added text format to gdev dashboard.

* updated e2e tests.

* make sure we use the same function for formatting och variable lable.

* increased the number to 22.

* changed label for tests to be All.

* existing format should be respected.
2020-09-14 08:05:51 +02:00
..
sources
Templating: global/system variables should be properly replaced in templated values. (#27394)
2020-09-14 08:05:51 +02:00
.gitignore
Docs: Add minimal hugo build, update docs README (#20905)
2019-12-13 15:47:28 +01:00
logo-horizontal.png
Added back logo file (#21198)
2019-12-19 09:09:48 -08:00
Makefile
Docs: What's new in 7.2 (#27462)
2020-09-09 16:59:34 +02:00
README.md
Docs: update loki links, readme (#26548)
2020-08-06 12:40:12 -07:00
versions.json
docs: update versions (#20635)
2019-11-25 15:40:27 +01:00

README.md

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

  1. In the command line, make sure you are in the docs folder: cd docs.
  2. Run make docs. This launches a preview of the docs website at http://localhost:3002/docs/grafana/latest/ which will refresh automatically when changes to content in the sources directory 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. Stop and rerun the make docs 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/sources directory, those changes are automatically synched to the grafana/website repo and published to the staging site.

Generally, someone from marketing will publish to production each day, so as long as the sync is successful your docs edits will be published. Alternatively, you can refer to publishing to production if you'd like to do it yourself.