From 003114eb57815680eb5b29b14d2029394100c860 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Mon, 4 May 2020 08:18:11 -0600 Subject: [PATCH 1/3] add related links to influxdb template docs, resolves #1001 --- content/v2.0/influxdb-templates/create.md | 3 +++ content/v2.0/influxdb-templates/use.md | 16 ++++++++++++---- content/v2.0/reference/cli/influx/pkg/_index.md | 2 ++ .../reference/cli/influx/pkg/export/_index.md | 2 ++ .../v2.0/reference/cli/influx/pkg/export/all.md | 2 ++ 5 files changed, 21 insertions(+), 4 deletions(-) diff --git a/content/v2.0/influxdb-templates/create.md b/content/v2.0/influxdb-templates/create.md index a11f24f47..0093ffbaf 100644 --- a/content/v2.0/influxdb-templates/create.md +++ b/content/v2.0/influxdb-templates/create.md @@ -9,6 +9,9 @@ menu: identifier: Create an InfluxDB template weight: 103 v2.0/tags: [templates] +related: + - /v2.0/reference/cli/influx/pkg/export/ + - /v2.0/reference/cli/influx/pkg/export/all/ --- Use the InfluxDB user interface (UI) and the `influx pkg export` command to diff --git a/content/v2.0/influxdb-templates/use.md b/content/v2.0/influxdb-templates/use.md index 23931b605..380936c60 100644 --- a/content/v2.0/influxdb-templates/use.md +++ b/content/v2.0/influxdb-templates/use.md @@ -9,6 +9,8 @@ menu: name: Use templates weight: 102 v2.0/tags: [templates] +related: + - /v2.0/reference/cli/influx/pkg/ --- Use the `influx pkg` command to summarize, validate, and install templates from @@ -27,11 +29,18 @@ others in the InfluxData community. Install community templates directly from GitHub using a template's download URL or download the template. -{{% note %}} When attempting to access the community templates via the URL, the templates use the following -as the root of the URL: `https://raw.githubusercontent.com/influxdata/community-templates/master/`. +{{% note %}} When attempting to access the community templates via the URL, the templates use the following +as the root of the URL: + +```sh +https://raw.githubusercontent.com/influxdata/community-templates/master/ +``` For example, the Docker community template can be accessed via: -`https://raw.githubusercontent.com/influxdata/community-templates/master/docker/docker.yml`. + +```sh +https://raw.githubusercontent.com/influxdata/community-templates/master/docker/docker.yml +``` {{% /note %}} View InfluxDB Community Templates @@ -216,4 +225,3 @@ influx pkg -f /path/to/template.yml \ ``` _To add a secret after installing a template, see [Add secrets](/v2.0/security/secrets/manage-secrets/add/)._ - diff --git a/content/v2.0/reference/cli/influx/pkg/_index.md b/content/v2.0/reference/cli/influx/pkg/_index.md index 78aebafff..0b5ccc8ce 100644 --- a/content/v2.0/reference/cli/influx/pkg/_index.md +++ b/content/v2.0/reference/cli/influx/pkg/_index.md @@ -7,6 +7,8 @@ menu: parent: influx weight: 101 v2.0/tags: [templates] +related: + - /v2.0/influxdb-templates/use/ --- The `influx pkg` command manages InfluxDB templates. diff --git a/content/v2.0/reference/cli/influx/pkg/export/_index.md b/content/v2.0/reference/cli/influx/pkg/export/_index.md index 82204abcf..7d15e3af3 100644 --- a/content/v2.0/reference/cli/influx/pkg/export/_index.md +++ b/content/v2.0/reference/cli/influx/pkg/export/_index.md @@ -5,6 +5,8 @@ menu: v2_0_ref: parent: influx pkg weight: 101 +related: + - /v2.0/influxdb-templates/create/ --- The `influx pkg export` command exports existing resources as an InfluxDB template. diff --git a/content/v2.0/reference/cli/influx/pkg/export/all.md b/content/v2.0/reference/cli/influx/pkg/export/all.md index 70c668ae8..935cecc93 100644 --- a/content/v2.0/reference/cli/influx/pkg/export/all.md +++ b/content/v2.0/reference/cli/influx/pkg/export/all.md @@ -6,6 +6,8 @@ menu: v2_0_ref: parent: influx pkg export weight: 201 +related: + - /v2.0/influxdb-templates/create/ --- The `influx pkg export all` command exports all resources in an From 438ce04cc7cceb5bdb6a064a158955010debef37 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Mon, 4 May 2020 08:26:48 -0600 Subject: [PATCH 2/3] added links to template guides in influx pkg docs --- content/v2.0/reference/cli/influx/pkg/_index.md | 2 ++ content/v2.0/reference/cli/influx/pkg/export/_index.md | 2 ++ content/v2.0/reference/cli/influx/pkg/export/all.md | 2 ++ 3 files changed, 6 insertions(+) diff --git a/content/v2.0/reference/cli/influx/pkg/_index.md b/content/v2.0/reference/cli/influx/pkg/_index.md index 0b5ccc8ce..1cabeba62 100644 --- a/content/v2.0/reference/cli/influx/pkg/_index.md +++ b/content/v2.0/reference/cli/influx/pkg/_index.md @@ -12,6 +12,8 @@ related: --- The `influx pkg` command manages InfluxDB templates. +_For information about finding and using InfluxDB templates, see +[Use InfluxDB templates](/v2.0/influxdb-templates/use/)._ ## Usage ``` diff --git a/content/v2.0/reference/cli/influx/pkg/export/_index.md b/content/v2.0/reference/cli/influx/pkg/export/_index.md index 7d15e3af3..6faab6a96 100644 --- a/content/v2.0/reference/cli/influx/pkg/export/_index.md +++ b/content/v2.0/reference/cli/influx/pkg/export/_index.md @@ -10,6 +10,8 @@ related: --- The `influx pkg export` command exports existing resources as an InfluxDB template. +_For detailed examples of exporting InfluxDB templates, see +[Create an InfluxDB template](/v2.0/influxdb-templates/create/)._ ## Usage ``` diff --git a/content/v2.0/reference/cli/influx/pkg/export/all.md b/content/v2.0/reference/cli/influx/pkg/export/all.md index 935cecc93..6ce2b4786 100644 --- a/content/v2.0/reference/cli/influx/pkg/export/all.md +++ b/content/v2.0/reference/cli/influx/pkg/export/all.md @@ -12,6 +12,8 @@ related: The `influx pkg export all` command exports all resources in an organization as an InfluxDB template. +_For detailed examples of exporting InfluxDB templates, see +[Create an InfluxDB template](/v2.0/influxdb-templates/create/)._ ## Usage ``` From 52e58d3d5b57aee656ffb595217d14adea84f5ea Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Mon, 4 May 2020 08:28:37 -0600 Subject: [PATCH 3/3] added newline in note --- content/v2.0/influxdb-templates/use.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/v2.0/influxdb-templates/use.md b/content/v2.0/influxdb-templates/use.md index 380936c60..f556bb242 100644 --- a/content/v2.0/influxdb-templates/use.md +++ b/content/v2.0/influxdb-templates/use.md @@ -29,7 +29,8 @@ others in the InfluxData community. Install community templates directly from GitHub using a template's download URL or download the template. -{{% note %}} When attempting to access the community templates via the URL, the templates use the following +{{% note %}} +When attempting to access the community templates via the URL, the templates use the following as the root of the URL: ```sh