Skip to content

Commit

Permalink
Update Docs > fix typos
Browse files Browse the repository at this point in the history
Signed-off-by: Manuel Fontan <mfontangarcia@slack-corp.com>
  • Loading branch information
Manuel Fontan committed Feb 18, 2021
1 parent bb62e15 commit 628ee0b
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
@@ -1,4 +1,4 @@
/** This is a helper library to load grafonet dashboards using the mixin metadata stored in `config.libshonnet` */
/** This is a helper library to load grafonnet dashboards using the mixin metadata stored in `config.libshonnet` */

local grafonnet_helper = import 'grafonnet_helper.libsonnet';

Expand Down
Expand Up @@ -152,7 +152,7 @@ local getTargets(config) =
//When the datasource is not prometheus(elastic, graphite) config file
//include calls to graphite.target() and elasticsearch.target().
//see webapp_config.lisonnet
//TODO Update this method to decouple grafonet code from the configuration files.
//TODO Update this method to decouple grafonnet code from the configuration files.
//Legacy configuration files include prometheus.target() calls.
//TODO update legacy config files to use {'expr':'Prom query' ...} format,
config.targets
Expand Down Expand Up @@ -260,8 +260,8 @@ local getRow(c) =
// \__ \ | | | | (_| | | __/\__ \ || (_| | |_
// |___/_|_| |_|\__, |_|\___||___/\__\__,_|\__|
// |___/
//The default value should include all the parameters that are overriden by the objects that extend the default.
//Default values match grafonet defaults > https://github.com/grafana/grafonnet-lib/blob/master/grafonnet/singlestat.libsonnet
//The default value should include all the parameters that are overridden by the objects that extend the default.
//Default values match grafonnet defaults > https://github.com/grafana/grafonnet-lib/blob/master/grafonnet/singlestat.libsonnet

local default_singlestat = {
colors: [
Expand Down
Expand Up @@ -5,7 +5,7 @@
local grafonnet_helper = import './grafonnet_helper.libsonnet';

/**
* Builds grapPanel using grafonet and the configuration from `mysql_config.libsonnet`
* Builds grapPanel using grafonnet and the configuration from `mysql_config.libsonnet`
*
* @name mysql_helper.getPanel
*
Expand Down
Expand Up @@ -6,7 +6,7 @@ local grafonnet_helper = import './grafonnet_helper.libsonnet';

{
/**
* Builds grapPanel using grafonet and the configuration from `vtgate_config.libsonnet`
* Builds grapPanel using grafonnet and the configuration from `vtgate_config.libsonnet`
*
* @name vtgate_helper.getPanel
*
Expand All @@ -18,7 +18,7 @@ local grafonnet_helper = import './grafonnet_helper.libsonnet';
getPanel(config):: grafonnet_helper.getPanel(config),

/**
* Builds a singlestat using grafonet and the configuration from `vtgate_config.libsonnet`
* Builds a singlestat using grafonnet and the configuration from `vtgate_config.libsonnet`
*
* @name vtgate_helper.getSingleStat
*
Expand Down
Expand Up @@ -5,7 +5,7 @@ local grafonnet_helper = import './grafonnet_helper.libsonnet';

{
/**
* Builds grapPanel using grafonet and the configuration from `vttablet_config.libsonnet`
* Builds grapPanel using grafonnet and the configuration from `vttablet_config.libsonnet`
*
* @name vttablet_helper.getPanel
*
Expand All @@ -16,13 +16,13 @@ local grafonnet_helper = import './grafonnet_helper.libsonnet';
*/
getPanel(config):: grafonnet_helper.getPanel(config),
/**
* Builds grapPanel using grafonet and the configuration from `vttablet_config.libsonnet`
* Builds singlestat using grafonnet and the configuration from `vttablet_config.libsonnet`
*
* @name vttablet_helper.getPanel
*
* @param `config`: The singlestat configuration from vttablet_config file.
*
* @return A new graphPanel with the configuration specified in `vttablet_config.libsonnet`
* @return A new singlestat with the configuration specified in `vttablet_config.libsonnet`
*
*/
getSingleStat(config):: grafonnet_helper.getSingleStat(config),
Expand Down

0 comments on commit 628ee0b

Please sign in to comment.