From 92b45fac16fd6ff7f5e446683dc9eec067035f3f Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Thu, 26 Sep 2024 12:07:10 -0500 Subject: [PATCH] fix(v1): Make stable-version OSS-specific. Update API notes. --- .../reference/client-libraries/v2/_index.md | 4 ++-- .../reference/client-libraries/v2/_index.md | 7 +++---- .../reference/client-libraries/v2/_index.md | 4 ++-- .../v1/about_the_project/release-notes.md | 2 +- content/influxdb/v1/concepts/glossary.md | 2 +- content/influxdb/v1/guides/query_data.md | 2 +- content/influxdb/v1/tools/api.md | 5 ++++- content/influxdb/v1/tools/api_client_libraries.md | 15 ++++++++------- .../v2/api-guide/client-libraries/_index.md | 5 ----- layouts/partials/article/stable-version.html | 2 +- 10 files changed, 23 insertions(+), 25 deletions(-) diff --git a/content/influxdb/cloud-dedicated/reference/client-libraries/v2/_index.md b/content/influxdb/cloud-dedicated/reference/client-libraries/v2/_index.md index a1754ddc2..279ef36c1 100644 --- a/content/influxdb/cloud-dedicated/reference/client-libraries/v2/_index.md +++ b/content/influxdb/cloud-dedicated/reference/client-libraries/v2/_index.md @@ -1,7 +1,7 @@ --- title: InfluxDB v2 API client libraries description: > - InfluxDB v2 client libraries use InfluxDB `/api/v2` endpoints and work with [InfluxDB 2.0 API compatibility endpoints](/influxdb/v1/tools/api/#influxdb-20-api-compatibility-endpoints). + InfluxDB v2 client libraries use InfluxDB `/api/v2` endpoints and work with [InfluxDB 2.x API compatibility endpoints](/influxdb/v1/tools/api/#influxdb-2x-api-compatibility-endpoints). View the list of available client libraries. weight: 101 menu: @@ -25,7 +25,7 @@ prepend: ## Client libraries for InfluxDB 2.x and 1.8+ InfluxDB client libraries are language-specific tools that integrate with InfluxDB APIs. -InfluxDB v2 client libraries use InfluxDB `/api/v2` endpoints and work with [InfluxDB 2.0 API compatibility endpoints](/influxdb/v1/tools/api/#influxdb-20-api-compatibility-endpoints). +InfluxDB v2 client libraries use InfluxDB `/api/v2` endpoints and work with [InfluxDB 2.x API compatibility endpoints](/influxdb/v1/tools/api/#influxdb-2x-api-compatibility-endpoints). Functionality varies among client libraries. InfluxDB client libraries are maintained by the InfluxDB community. diff --git a/content/influxdb/cloud-serverless/reference/client-libraries/v2/_index.md b/content/influxdb/cloud-serverless/reference/client-libraries/v2/_index.md index 67b783049..5cfd07120 100644 --- a/content/influxdb/cloud-serverless/reference/client-libraries/v2/_index.md +++ b/content/influxdb/cloud-serverless/reference/client-libraries/v2/_index.md @@ -1,7 +1,7 @@ --- title: InfluxDB v2 API client libraries description: > - InfluxDB v2 client libraries use InfluxDB `/api/v2` endpoints and work with [InfluxDB 2.0 API compatibility endpoints](/influxdb/v1/tools/api/#influxdb-20-api-compatibility-endpoints). + InfluxDB v2 client libraries use InfluxDB `/api/v2` endpoints and work with [InfluxDB 2.x API compatibility endpoints](/influxdb/v1/tools/api/#influxdb-2x-api-compatibility-endpoints). View the list of available client libraries. weight: 101 menu: @@ -25,11 +25,10 @@ prepend: ## Client libraries for InfluxDB 2.x and 1.8+ InfluxDB client libraries are language-specific tools that integrate with InfluxDB APIs. -InfluxDB v2 client libraries use InfluxDB `/api/v2` endpoints and work with [InfluxDB 2.0 API compatibility endpoints](/influxdb/v1/tools/api/#influxdb-20-api-compatibility-endpoints). +InfluxDB v2 client libraries use InfluxDB `/api/v2` endpoints and work with [InfluxDB 2.x API compatibility endpoints](/influxdb/v1/tools/api/#influxdb-2x-api-compatibility-endpoints). Functionality varies among client libraries. -These client libraries are in active development and may not be feature-complete. - +InfluxDB client libraries are maintained by the InfluxDB community. For specifics about a client library, see the library's GitHub repository. {{< children depth="999" type="list" >}} diff --git a/content/influxdb/clustered/reference/client-libraries/v2/_index.md b/content/influxdb/clustered/reference/client-libraries/v2/_index.md index 0be0dff52..3b1ba8b31 100644 --- a/content/influxdb/clustered/reference/client-libraries/v2/_index.md +++ b/content/influxdb/clustered/reference/client-libraries/v2/_index.md @@ -1,7 +1,7 @@ --- title: InfluxDB v2 API client libraries description: > - InfluxDB v2 client libraries use InfluxDB `/api/v2` endpoints and work with [InfluxDB 2.0 API compatibility endpoints](/influxdb/v1/tools/api/#influxdb-20-api-compatibility-endpoints). + InfluxDB v2 client libraries use InfluxDB `/api/v2` endpoints and work with [InfluxDB 2.x API compatibility endpoints](/influxdb/v1/tools/api/#influxdb-2x-api-compatibility-endpoints). View the list of available client libraries. weight: 101 menu: @@ -25,7 +25,7 @@ prepend: ## Client libraries for InfluxDB 2.x and 1.8+ InfluxDB client libraries are language-specific tools that integrate with InfluxDB APIs. -InfluxDB v2 client libraries use InfluxDB `/api/v2` endpoints and work with [InfluxDB 2.0 API compatibility endpoints](/influxdb/v1/tools/api/#influxdb-20-api-compatibility-endpoints). +InfluxDB v2 client libraries use InfluxDB `/api/v2` endpoints and work with [InfluxDB 2.x API compatibility endpoints](/influxdb/v1/tools/api/#influxdb-2x-api-compatibility-endpoints). Functionality varies among client libraries. InfluxDB client libraries are maintained by the InfluxDB community. diff --git a/content/influxdb/v1/about_the_project/release-notes.md b/content/influxdb/v1/about_the_project/release-notes.md index a7f8c6f8c..32f6c4d81 100644 --- a/content/influxdb/v1/about_the_project/release-notes.md +++ b/content/influxdb/v1/about_the_project/release-notes.md @@ -163,7 +163,7 @@ This release updates support for the Flux language and queries. To learn about F #### Forward compatibility -- [InfluxDB 2.0 API compatibility endpoints](/influxdb/v1/tools/api/#influxdb-20-api-compatibility-endpoints) are now part of the InfluxDB 1.x line. +- [InfluxDB 2.x API compatibility endpoints](/influxdb/v1/tools/api/#influxdb-2x-api-compatibility-endpoints) are now part of the InfluxDB 1.x line. This allows you to leverage the new InfluxDB 2.0 [client libraries](/influxdb/v1/tools/api_client_libraries/) for both writing and querying data with Flux. Take advantage of the latest client libraries while readying your implementation for a move to InfluxDB 2.0 Cloud when you're ready to scale. diff --git a/content/influxdb/v1/concepts/glossary.md b/content/influxdb/v1/concepts/glossary.md index da30c706b..22668d937 100644 --- a/content/influxdb/v1/concepts/glossary.md +++ b/content/influxdb/v1/concepts/glossary.md @@ -27,7 +27,7 @@ Related entries: [InfluxDB line protocol](/influxdb/v1/concepts/glossary/#influx ## bucket -A bucket is a named location where time series data is stored in **InfluxDB 2.0**. In InfluxDB 1.8+, each combination of a database and a retention policy (database/retention-policy) represents a bucket. Use the [InfluxDB 2.0 API compatibility endpoints](/influxdb/v1/tools/api#influxdb-2-0-api-compatibility-endpoints) included with InfluxDB 1.8+ to interact with buckets. +A bucket is a named location where time series data is stored in **InfluxDB 2.0**. In InfluxDB 1.8+, each combination of a database and a retention policy (database/retention-policy) represents a bucket. Use the [InfluxDB 2.x API compatibility endpoints](/influxdb/v1/tools/api#influxdb-2-0-api-compatibility-endpoints) included with InfluxDB 1.8+ to interact with buckets. ## continuous query (CQ) diff --git a/content/influxdb/v1/guides/query_data.md b/content/influxdb/v1/guides/query_data.md index 8194804ef..b60adb5bc 100644 --- a/content/influxdb/v1/guides/query_data.md +++ b/content/influxdb/v1/guides/query_data.md @@ -54,7 +54,7 @@ The header row defines column labels for the table. The `cpu` [measurement](/inf ### Flux Check out the [Get started with Flux](/influxdb/v2/query-data/get-started/) to learn more about building queries with Flux. -For more information about querying data with the InfluxDB API using Flux, see the [API reference documentation](/influxdb/v1/tools/api/#influxdb-2-0-api-compatibility-endpoints). +For more information about querying data with the InfluxDB API using Flux, see the [API reference documentation](/influxdb/v1/tools/api/#influxdb-2x-api-compatibility-endpoints). ## Query data with InfluxQL diff --git a/content/influxdb/v1/tools/api.md b/content/influxdb/v1/tools/api.md index e304ee67b..ff2121920 100644 --- a/content/influxdb/v1/tools/api.md +++ b/content/influxdb/v1/tools/api.md @@ -22,8 +22,11 @@ the [InfluxDB v2 client libraries](/influxdb/v1/tools/api_client_libraries/), [Telegraf](https://docs.influxdata.com/telegraf/v1/), or the client of your choice. +{{% note %}} If you're getting started with InfluxDB v1, we recommend using the -InfluxDB v1 client libraries and InfluxQL for [InfluxDB v3 compatibility](#influxdb-v3-compatibility). +InfluxDB v1 client libraries and InfluxQL for +[InfluxDB v3 compatibility](/influxdb/v1/tools/api/#influxdb-v3-compatibility). +{{% /note %}} The following sections assume your InfluxDB instance is running on `localhost` port `8086` and HTTPS is not enabled. diff --git a/content/influxdb/v1/tools/api_client_libraries.md b/content/influxdb/v1/tools/api_client_libraries.md index 36483663a..e030250c8 100644 --- a/content/influxdb/v1/tools/api_client_libraries.md +++ b/content/influxdb/v1/tools/api_client_libraries.md @@ -13,15 +13,16 @@ menu: v2: /influxdb/v2/api-guide/client-libraries/ --- -InfluxDB client libraries are language-specific packages that integrate with the InfluxDB 2.0 API and support both **InfluxDB 1.8+** and **InfluxDB 2.0**. +InfluxDB v2 client libraries are language-specific packages that integrate +with the InfluxDB v2 API and support both **InfluxDB 1.8+** and **InfluxDB 2.x**. {{% note %}} -We recommend using the new client libraries on this page to leverage the new -read (via Flux) and write APIs and prepare for conversion to InfluxDB v2 and -InfluxDB Cloud. -For more information, see [InfluxDB 2.0 API compatibility endpoints](/influxdb/v1/tools/api/#influxdb-2-0-api-compatibility-endpoints). -Client libraries for [InfluxDB 1.7 and earlier](/influxdb/v1/tools/api_client_libraries/) -may continue to work, but are not maintained by InfluxData. +If you're getting started with InfluxDB v1, we recommend using the +InfluxDB v1 client libraries and InfluxQL for +[InfluxDB v3 compatibility](/influxdb/v1/tools/api/#influxdb-v3-compatibility). + +For more information about API and client library compatibility, see the +[InfluxDB v1 API reference](/influxdb/v1/tools/api/). {{% /note %}} ## Client libraries diff --git a/content/influxdb/v2/api-guide/client-libraries/_index.md b/content/influxdb/v2/api-guide/client-libraries/_index.md index 697dcdbc5..fed8999ef 100644 --- a/content/influxdb/v2/api-guide/client-libraries/_index.md +++ b/content/influxdb/v2/api-guide/client-libraries/_index.md @@ -19,9 +19,4 @@ influxdb/v2/tags: [client libraries] InfluxDB client libraries are language-specific packages that integrate with the InfluxDB v2 API. The following **InfluxDB v2** client libraries are available: -{{% note %}} -These client libraries are in active development and may not be feature-complete. -This list will continue to grow as more client libraries are released. -{{% /note %}} - {{< children type="list" >}} diff --git a/layouts/partials/article/stable-version.html b/layouts/partials/article/stable-version.html index 0794eb6a1..28e7f27a6 100644 --- a/layouts/partials/article/stable-version.html +++ b/layouts/partials/article/stable-version.html @@ -1,6 +1,6 @@ {{ $productPathData := findRE "[^/]+.*?" .RelPermalink }} {{ $product := index $productPathData 0 }} -{{ $productName := (index .Site.Data.products $product).name }} +{{ $productName := cond (isset (index .Site.Data.products $product) "altname") (index .Site.Data.products $product).altname (index .Site.Data.products $product).name }} {{ $currentVersion := index $productPathData 1 }} {{ $latestV2 := index (.Site.Data.products.influxdb.versions) 0 }}