From 179f3e99b3c0820086e4a270e39c330b10d8614d Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Mon, 20 Apr 2020 10:07:50 -0600 Subject: [PATCH 1/4] added sample and demo data docs to write data section --- content/v2.0/write-data/sample-data/_index.md | 45 +++++++++++++++++++ .../v2.0/write-data/sample-data/demo-data.md | 35 +++++++++++++++ 2 files changed, 80 insertions(+) create mode 100644 content/v2.0/write-data/sample-data/_index.md create mode 100644 content/v2.0/write-data/sample-data/demo-data.md diff --git a/content/v2.0/write-data/sample-data/_index.md b/content/v2.0/write-data/sample-data/_index.md new file mode 100644 index 000000000..9e4496078 --- /dev/null +++ b/content/v2.0/write-data/sample-data/_index.md @@ -0,0 +1,45 @@ +--- +title: Sample data +description: > + Use sample data to familiarize yourself with time series data and InfluxDB. + InfluxData provides many sample time series datasets to use with InfluxDB + and InfluxDB Cloud. +menu: + v2_0: + parent: Write data +weight: 105 +--- + +Use sample data to familiarize yourself with time series data and InfluxDB. +InfluxData provides many sample time series datasets to use with **InfluxDB** and **InfluxDB Cloud**. + +{{< children >}} + +--- + +### Air sensor sample data +The air sensor sample data is designed to represent an "Internet of Things" (IoT) use case + by simulating temperature, humidity, and carbon monoxide levels for multiple rooms in a building. +The dataset also includes a relational SQL dataset with meta information about sensors in each room. + + + View air sensor sample data + + +_Used in [Query SQL data sources](/v2.0/query-data/flux/sql/)._ + +--- + +### Bird migration sample data +This sample data is adapted from the [Movebank: Animal Tracking](https://www.kaggle.com/pulkit8595/movebank-animal-tracking) +dataset available on [kaggle.com](https://kaggle.com). +The dataset as a whole represents animal migratory movements throughout 2019. +The data schema meets the requirements of the +[Flux Geo package](https://v2.docs.influxdata.com/v2.0/reference/flux/stdlib/experimental/geo/#geo-schema-requirements) +which contains tools for working with geo-temporal data. + + + View bird migration sample data + + +_Used in [Work with geo-temporal data](/v2.0/query-data/flux/geo/)._ diff --git a/content/v2.0/write-data/sample-data/demo-data.md b/content/v2.0/write-data/sample-data/demo-data.md new file mode 100644 index 000000000..cbe69ad14 --- /dev/null +++ b/content/v2.0/write-data/sample-data/demo-data.md @@ -0,0 +1,35 @@ +--- +title: InfluxDB Cloud demo data +description: > + Use **InfluxDB Cloud** demo data buckets for quick access to different types of sample data. +menu: + v2_0: + name: Demo data + parent: Sample data +weight: 201 +cloud_all: true +v2.0/tags: [sample data] +--- + +Use **InfluxDB Cloud** demo data buckets for quick and easy access to different types of sample data. +Choose from the following: + +- **Website Monitoring** + _placholder – short description of this data_ +- _More coming soon_ + +## Enable demo data buckets +_placholder – How do users enable the demo data buckets?_ + +## Add a demo data bucket +**{{< cloud-name "short" >}}** provides demo data buckets... + +1. In the navigation menu on the left, click **Data (Load Data)** > **Buckets**. + + {{< nav-icon "data" >}} + +2. Click **{{< icon "plus" >}} Add Demo Data** and select the demo data bucket to add. +3. The Demo Data bucket appears in your list of buckets. + +## Storage and network charges +_placeholder - Are users charged for using demo data and do rate limits apply?_ From 7c351e0409f7315dc583674d8803a2e4229d65d0 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Thu, 30 Apr 2020 14:47:08 -0600 Subject: [PATCH 2/4] added information to demo data doc --- .../v2.0/write-data/sample-data/demo-data.md | 47 ++++++++++++++----- 1 file changed, 36 insertions(+), 11 deletions(-) diff --git a/content/v2.0/write-data/sample-data/demo-data.md b/content/v2.0/write-data/sample-data/demo-data.md index cbe69ad14..6488f3b15 100644 --- a/content/v2.0/write-data/sample-data/demo-data.md +++ b/content/v2.0/write-data/sample-data/demo-data.md @@ -7,23 +7,27 @@ menu: name: Demo data parent: Sample data weight: 201 -cloud_all: true v2.0/tags: [sample data] +products: [cloud] --- -Use **InfluxDB Cloud** demo data buckets for quick and easy access to different types of sample data. -Choose from the following: +Use **InfluxDB Cloud** demo data buckets for quick and easy access to different +types of demo data that let you explore and familiarize yourself with InfluxDB Cloud. + +- [Add a demo data bucket](#add-a-demo-data-bucket) +- [Explore demo data](#explore-demo-data) +- [Visualize demo data](#visualize-demo-data) +- [Demo data pricing and restrictions](#demo-data-pricing-and-restrictions) + +## Demo data sets +Choose from the following demo data sets: - **Website Monitoring** - _placholder – short description of this data_ -- _More coming soon_ + Explore, visualize, and monitor HTTP response metrics from InfluxData websites. -## Enable demo data buckets -_placholder – How do users enable the demo data buckets?_ +_More demo data options coming soon._ ## Add a demo data bucket -**{{< cloud-name "short" >}}** provides demo data buckets... - 1. In the navigation menu on the left, click **Data (Load Data)** > **Buckets**. {{< nav-icon "data" >}} @@ -31,5 +35,26 @@ _placholder – How do users enable the demo data buckets?_ 2. Click **{{< icon "plus" >}} Add Demo Data** and select the demo data bucket to add. 3. The Demo Data bucket appears in your list of buckets. -## Storage and network charges -_placeholder - Are users charged for using demo data and do rate limits apply?_ +## Explore demo data +Use the [Data Explorer](https://v2.docs.influxdata.com/v2.0/visualize-data/explore-metrics/) +to query and visualize data in demo data buckets. + +In the navigation menu on the left, click **Explore (Data Explorer)**. + +{{< nav-icon "explore" >}} + +## Visualize demo data +When adding a demo data bucket, InfluxDB Cloud provides a pre-built dashboard for the demo data. + +**To view a demo data dashboard:** + +1. In the navigation menu on the left, click **Boards (Dashboards)**. + + {{< nav-icon "dashboards" >}} + +2. Click the name of the dashboard that corresponds to your demo data bucket. + +## Demo data pricing and restrictions +- InfluxDB Cloud demo data buckets are **free to use** and are **_not_ subject to + [Free Plan](/v2.0/account-management/pricing-plans/#free-plan) rate limits**. +- Demo data buckets are **read-only**. You cannot write data into demo data buckets. From 197e2d0094b9b114a331c4a5831b15770c34d31b Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Thu, 30 Apr 2020 17:04:28 -0600 Subject: [PATCH 3/4] added demo data section to getting started --- content/v2.0/get-started.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/content/v2.0/get-started.md b/content/v2.0/get-started.md index 21ef2a565..dc25fc8f2 100644 --- a/content/v2.0/get-started.md +++ b/content/v2.0/get-started.md @@ -458,6 +458,10 @@ For details, see [Scrape data](/v2.0/write-data/scrape-data/). For information about using the InfluxDB v2 API, `influx` CLI, and client libraries to write data, see [Write data to InfluxDB](/v2.0/write-data/). +#### Demo data +If using **{{< cloud-name "short" >}}**, [add a demo data bucket](/v2.0/write-data/sample-data/demo-data/) +for quick, _free_ access to time series data. + ### Query data Query data using Flux, the UI, and the `influx` command line interface. From f87bc9b32255bd772955c26d0bf5906cc5aeaad1 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Thu, 14 May 2020 14:51:33 -0600 Subject: [PATCH 4/4] updated sample and demo data docs to address PR feedback --- content/v2.0/get-started.md | 2 +- content/v2.0/write-data/sample-data/_index.md | 26 ++++++++++------- .../v2.0/write-data/sample-data/demo-data.md | 29 ++++++++++--------- layouts/shortcodes/children.html | 6 +++- 4 files changed, 37 insertions(+), 26 deletions(-) diff --git a/content/v2.0/get-started.md b/content/v2.0/get-started.md index 7a0050dfb..1b7e98de4 100644 --- a/content/v2.0/get-started.md +++ b/content/v2.0/get-started.md @@ -460,7 +460,7 @@ see [Write data to InfluxDB](/v2.0/write-data/). #### Demo data If using **{{< cloud-name "short" >}}**, [add a demo data bucket](/v2.0/write-data/sample-data/demo-data/) -for quick, _free_ access to time series data. +for quick, **free** access to time series data. ### Query data diff --git a/content/v2.0/write-data/sample-data/_index.md b/content/v2.0/write-data/sample-data/_index.md index 9e4496078..7893961b1 100644 --- a/content/v2.0/write-data/sample-data/_index.md +++ b/content/v2.0/write-data/sample-data/_index.md @@ -13,13 +13,20 @@ weight: 105 Use sample data to familiarize yourself with time series data and InfluxDB. InfluxData provides many sample time series datasets to use with **InfluxDB** and **InfluxDB Cloud**. -{{< children >}} +{{< children hlevel="h2" >}} --- +## Sample data sets +The following sample data sets are used as examples in [InfluxDB query guides](/v2.0/query-data/flux) +and can be used with **InfluxDB OSS** or **InfluxDB Cloud**. + +- [Air sensor sample data](#air-sensor-sample-data) +- [Bird migration sample data](#bird-migration-sample-data) + ### Air sensor sample data -The air sensor sample data is designed to represent an "Internet of Things" (IoT) use case - by simulating temperature, humidity, and carbon monoxide levels for multiple rooms in a building. +Air sensor sample data represents an "Internet of Things" (IoT) use case by simulating +temperature, humidity, and carbon monoxide levels for multiple rooms in a building. The dataset also includes a relational SQL dataset with meta information about sensors in each room. @@ -28,15 +35,12 @@ The dataset also includes a relational SQL dataset with meta information about s _Used in [Query SQL data sources](/v2.0/query-data/flux/sql/)._ ---- - ### Bird migration sample data -This sample data is adapted from the [Movebank: Animal Tracking](https://www.kaggle.com/pulkit8595/movebank-animal-tracking) -dataset available on [kaggle.com](https://kaggle.com). -The dataset as a whole represents animal migratory movements throughout 2019. -The data schema meets the requirements of the -[Flux Geo package](https://v2.docs.influxdata.com/v2.0/reference/flux/stdlib/experimental/geo/#geo-schema-requirements) -which contains tools for working with geo-temporal data. +Bird migration data is adapted from the +[Movebank: Animal Tracking data set on Kaggle](https://www.kaggle.com/pulkit8595/movebank-animal-tracking) +and represents animal migratory movements throughout 2019. +Use the [Flux Geo package](https://v2.docs.influxdata.com/v2.0/reference/flux/stdlib/experimental/geo/#geo-schema-requirements) +to query and analyze the geo-temporal data in this sample data set. View bird migration sample data diff --git a/content/v2.0/write-data/sample-data/demo-data.md b/content/v2.0/write-data/sample-data/demo-data.md index 6488f3b15..2e98e3977 100644 --- a/content/v2.0/write-data/sample-data/demo-data.md +++ b/content/v2.0/write-data/sample-data/demo-data.md @@ -1,7 +1,7 @@ --- title: InfluxDB Cloud demo data description: > - Use **InfluxDB Cloud** demo data buckets for quick access to different types of sample data. + Use **InfluxDB Cloud** demo data buckets for quick, **free** access to different types of sample data. menu: v2_0: name: Demo data @@ -16,8 +16,14 @@ types of demo data that let you explore and familiarize yourself with InfluxDB C - [Add a demo data bucket](#add-a-demo-data-bucket) - [Explore demo data](#explore-demo-data) -- [Visualize demo data](#visualize-demo-data) -- [Demo data pricing and restrictions](#demo-data-pricing-and-restrictions) +- [View demo data dashboards](#view-demo-data-dashboards) + +{{% note %}} +#### Free to use and read-only +- InfluxDB Cloud demo data buckets are **free to use** and are **_not_ subject to + [Free Plan](/v2.0/account-management/pricing-plans/#free-plan) rate limits**. +- Demo data buckets are **read-only**. You cannot write data into demo data buckets. +{{% /note %}} ## Demo data sets Choose from the following demo data sets: @@ -25,14 +31,13 @@ Choose from the following demo data sets: - **Website Monitoring** Explore, visualize, and monitor HTTP response metrics from InfluxData websites. -_More demo data options coming soon._ ## Add a demo data bucket 1. In the navigation menu on the left, click **Data (Load Data)** > **Buckets**. {{< nav-icon "data" >}} -2. Click **{{< icon "plus" >}} Add Demo Data** and select the demo data bucket to add. +2. Click **{{< icon "plus" >}} Add Demo Data**, and then select the demo data bucket to add. 3. The Demo Data bucket appears in your list of buckets. ## Explore demo data @@ -43,10 +48,8 @@ In the navigation menu on the left, click **Explore (Data Explorer)**. {{< nav-icon "explore" >}} -## Visualize demo data -When adding a demo data bucket, InfluxDB Cloud provides a pre-built dashboard for the demo data. - -**To view a demo data dashboard:** +## View demo data dashboards +After adding a demo data bucket, view the pre-built dashboard specific to the demo data set: 1. In the navigation menu on the left, click **Boards (Dashboards)**. @@ -54,7 +57,7 @@ When adding a demo data bucket, InfluxDB Cloud provides a pre-built dashboard fo 2. Click the name of the dashboard that corresponds to your demo data bucket. -## Demo data pricing and restrictions -- InfluxDB Cloud demo data buckets are **free to use** and are **_not_ subject to - [Free Plan](/v2.0/account-management/pricing-plans/#free-plan) rate limits**. -- Demo data buckets are **read-only**. You cannot write data into demo data buckets. +{{% note %}} +#### Other sample data sets +See [Sample data](/v2.0/write-data/sample-data) for more sample InfluxDB data sets. +{{% /note %}} diff --git a/layouts/shortcodes/children.html b/layouts/shortcodes/children.html index 7cdeffe84..4c7773297 100644 --- a/layouts/shortcodes/children.html +++ b/layouts/shortcodes/children.html @@ -1,5 +1,6 @@ {{ $type := .Get "type" | default "articles" }} {{ $show := .Get "show" | default "all" }} +{{ $hlevel := .Get "hlevel" | default "h3"}} {{ $readMore := .Get "readmore" | default false }} {{ $hr := .Get "hr" | default false }} @@ -19,7 +20,10 @@ {{ $title := cond ( isset .Params "list_title" ) .Params.list_title .Title }} {{ $url := cond ( isset .Params "external_url" ) .Params.external_url .RelPermalink }} {{ $target := cond ( isset .Params "external_url" ) "_blank" "" }} -

{{ $title }}

+ {{ if eq $hlevel "h2"}}

{{ $title }}

+ {{ else if eq $hlevel "h3"}}

{{ $title }}

+ {{ else if eq $hlevel "h4"}}

{{ $title }}

+ {{end}}

{{- if .Description }}{{- .Description | markdownify -}} {{ else }}{{- .Summary | markdownify -}}