Torkel Ödegaard
fd21e0ba14
* POC: trying to see if there is a way to support objects in template interpolations * Added support for nested objects, and arrays * Added accessor cache * fixed unit tests * First take * Use links supplier in graph * Add field's index to cache items * Get field index from field cache * CHange FiledCacheItem to FieldWithIndex * Add refId to TimeSeries class * Make field link supplier work with _series, _field and _value vars * use field link supplier in graph * Fix yaxis settings * Update dashboard schema version and add migration for data links variables * Update snapshots * Update build in data link variables * FieldCache - idx -> index * Add current query results to panel editor * WIP Updated data links dropdown to display new variables * Fix build * Update variables syntac in field display, update migration * Field links supplier: review updates * Add data frame view and field name to TimeSeries for later inspection * Retrieve data frame from TimeSeries when clicking on plot graph * Use data frame's index instead of view * Retrieve data frame by index instead of view on TimeSeries * Update data links prism regex * Fix typecheck * Add value variables to suggestions list * UI update * Rename field to config in DisplayProcessorOptions * Proces single value of a field instead of entire data frame * Updated font size from 10px to 12px for auto complete * Replace fieldName with fieldIndex in TimeSeries * Don't use .entries() for iterating in field cache * Don't use FieldCache when retrieving field for datalinks in graph * Add value calculation variable to data links (#19031) * Add support for labels with dots in the name (#19033) * Docs update * Use field name instead of removed series.fieldName * Add test dashboard * Typos fix * Make visualization tab subscribe to query results * Added tags to dashboard so it shows up in lists * minor docs fix * Update singlestat-ish variables suggestions to contain series variables * Decrease suggestions update debounce * Enable whitespace characters(new line, space) in links and strip them when processing the data link * minor data links UI update * DataLinks: Add __from and __to variables suggestions to data links (#19093) * Add from and to variables suggestions to data links * Update docs * UI update and added info text * Change ESC global bind to bind (doesn't capture ESC on input) * Close datalinks suggestions on ESC * Remove unnecessary fragment
Building The Docs
To build the docs locally, you need to have docker installed. The docs are built using Hugo - a static site generator.
Prepare the Docker Image:
Git clone grafana/website repo. Run these commands in the root of that repo. Note that you may require sudo
when running make docs-build depending on how your system's docker
service is configured):
git clone https://github.com/grafana/website
cd website
make docs-build
Build the Documentation:
Now that the docker image has been prepared we can build the grafana docs and start a docs server.
If you have not cloned the Grafana repository already then:
cd ..
git clone https://github.com/grafana/grafana
Switch your working directory to the directory this file (README.md) is in.
cd grafana/docs
An AWS config file is required to build the docs Docker image and to publish the site to AWS. If you are building locally only and do not have any AWS credentials for docs.grafana.org then create an empty file named awsconfig in the current directory.
touch awsconfig
Then run (possibly with sudo):
make watch
This command will not return control of the shell to the user. Instead the command is now running a new docker container built from the image we created in the previous step.
Open localhost:3004 to view the docs.
Images & Content
All markdown files are located in this repo (main grafana repo). But all images are added to the https://github.com/grafana/website repo. So the process of adding images is a bit complicated.
First you need create a feature (PR) branch of https://github.com/grafana/website so you can make change. Then add the image to the /static/img/docs directory. Then make a commit that adds the image.
Then run:
make docs-build
This will rebuild the docs docker container.
To be able to use the image you have to quit (CTRL-C) the make watch command (that you run in the same directory as this README). Then simply rerun make watch, it will restart the docs server but now with access to your image.
Editing content
Changes to the markdown files should automatically cause a docs rebuild and live reload should reload the page in your browser.