diff --git a/DOCS-SHORTCODES.md b/DOCS-SHORTCODES.md index de0104e5cb..ec3a592adf 100644 --- a/DOCS-SHORTCODES.md +++ b/DOCS-SHORTCODES.md @@ -146,7 +146,7 @@ Use the `{{< api-endpoint >}}` shortcode to generate a code block that contains - **method**: HTTP request method (get, post, patch, put, or delete) - **endpoint**: API endpoint - **api-ref**: Link the endpoint to a specific place in the API documentation -- **influxdb_host**: Specify which InfluxDB product host to use *if the `endpoint` contains the `influxdb/host` shortcode*. Uses the current InfluxDB product as default. Supports the following product values: +- **influxdb\_host**: Specify which InfluxDB product host to use *if the `endpoint` contains the `influxdb/host` shortcode*. Uses the current InfluxDB product as default. Supports the following product values: - oss - cloud - serverless @@ -737,16 +737,32 @@ InfluxDB 3 Enterprise and InfluxDB 3 Core support different kinds of tokens. The ### Code callouts -Use the `{{< code-callout >}}` shortcode to highlight and emphasize a specific piece of code (for example, a variable, placeholder, or value) in a code block. Provide the string to highlight in the code block. Include a syntax for the codeblock to properly style the called out code. +Use the `callout` code fence attribute to highlight and emphasize specific code (for example, a variable, placeholder, or value) in a code block. +Provide a regular expression pattern to match the text to highlight. +Use the optional `callout-color` attribute to specify the highlight color (defaults to `green`). -````md -{{< code-callout "03a2bbf46249a000" >}} +**Available colors:** `green` (default), `magenta`, `orange`, `delete`/`strike` -```sh +````md +```sh { callout="03a2bbf46249a000" } http://localhost:8086/orgs/03a2bbf46249a000/... ``` +```` + +With an explicit color: + +````md +```sh { callout="--host" callout-color="orange" } +influx query --host http://localhost:8086 +``` +```` -{{< /code-callout >}} +You can use both `callout` and `placeholders` attributes on the same code block: + +````md +```sh { placeholders="DATABASE_NAME" callout="--host" callout-color="magenta" } +influx query --host http://localhost:8086 --database DATABASE_NAME +``` ```` ### Placeholders in code samples diff --git a/content/influxdb/cloud/admin/organizations/view-orgs.md b/content/influxdb/cloud/admin/organizations/view-orgs.md index 41e2573c5d..5c0c8d9e6c 100644 --- a/content/influxdb/cloud/admin/organizations/view-orgs.md +++ b/content/influxdb/cloud/admin/organizations/view-orgs.md @@ -35,11 +35,9 @@ Use the InfluxDB UI or `influx` CLI to view your organization ID. After logging in to the InfluxDB UI, your organization ID appears in the URL. -{{< code-callout "03a2bbf46249a000" >}} -```sh +```sh { callout="03a2bbf46249a000" } https://cloud2.influxdata.com/orgs/03a2bbf46249a000/... ``` -{{< /code-callout >}} ### Organization ID in the CLI diff --git a/content/influxdb/cloud/reference/regions.md b/content/influxdb/cloud/reference/regions.md index bdb1355062..d09cb9d393 100644 --- a/content/influxdb/cloud/reference/regions.md +++ b/content/influxdb/cloud/reference/regions.md @@ -20,20 +20,16 @@ Use the URLs below to interact with your InfluxDB Cloud instances with the Request a cloud region -{{% note %}} -#### Regions with multiple clusters - -Some InfluxDB Cloud regions have multiple Cloud clusters, each with a unique URL. -To find your cluster URL, [log in to your InfluxDB Cloud organization](https://cloud2.influxdata.com) -and review your organization URL. The first subdomain identifies your -InfluxDB Cloud cluster. For example: - -{{< code-callout "us-west-2-1" >}} -```sh -https://us-west-2-1.aws.cloud2.influxdata.com/orgs/03a2bbf46249a000/... -``` -{{< /code-callout >}} - -{{% /note %}} +> [!Note] +> #### Regions with multiple clusters +> +> Some InfluxDB Cloud regions have multiple Cloud clusters, each with a unique URL. +> To find your cluster URL, [log in to your InfluxDB Cloud organization](https://cloud2.influxdata.> com) +> and review your organization URL. The first subdomain identifies your +> InfluxDB Cloud cluster. For example: +> +> ```sh { callout="us-west-2-1" } +> https://us-west-2-1.aws.cloud2.influxdata.com/orgs/03a2bbf46249a000/... +> ``` {{< cloud_regions >}} diff --git a/content/influxdb/cloud/visualize-data/dashboards/_index.md b/content/influxdb/cloud/visualize-data/dashboards/_index.md index a06dd2f766..99be1bdcf2 100644 --- a/content/influxdb/cloud/visualize-data/dashboards/_index.md +++ b/content/influxdb/cloud/visualize-data/dashboards/_index.md @@ -22,11 +22,9 @@ Use the InfluxDB UI or `influx` CLI to view your dashboard ID. When viewing a dashboard in the InfluxDB UI, your dashboard ID appears in the URL. -{{< code-callout "04b6b15034cc000" >}} -```sh +```sh { callout="04b6b15034cc000" } https://cloud2.influxdata.com/orgs/03a2bbf46249a000/dashboards/04b6b15034cc000/... ``` -{{< /code-callout >}} ### Dashboard ID in the CLI Use [`influx dashboards`](/influxdb/cloud/reference/cli/influx/dashboards/) to view a list of dashboards and IDs. diff --git a/content/influxdb/v1/administration/backup_and_restore.md b/content/influxdb/v1/administration/backup_and_restore.md index afdf31cd0f..5b0d5a081f 100644 --- a/content/influxdb/v1/administration/backup_and_restore.md +++ b/content/influxdb/v1/administration/backup_and_restore.md @@ -100,15 +100,13 @@ the legacy format. To create or restore from a backup or in the portable format, include the `-portable` flag with your backup command. -{{< code-callout "-portable" >}} -```sh +```sh { callout="-portable" } # Create a backup in the portable format influxd backup -portable /path/to/backup-destination # Restore from a portable backup influxd restore -portable /path/to/backup-destination ``` -{{< /code-callout >}} ### Determine your backup's format Use the directory structure of the backup directory to determine the format of the backup. diff --git a/content/influxdb/v2/admin/organizations/view-orgs.md b/content/influxdb/v2/admin/organizations/view-orgs.md index ba06adb45f..19b20bef6b 100644 --- a/content/influxdb/v2/admin/organizations/view-orgs.md +++ b/content/influxdb/v2/admin/organizations/view-orgs.md @@ -46,13 +46,9 @@ Use the InfluxDB UI or `influx` CLI to view your organization ID. ### Organization ID in the UI After logging in to the InfluxDB UI, your organization ID appears in the URL. - -{{< code-callout "03a2bbf46249a000" >}} -```sh +```sh { callout="03a2bbf46249a000" } http://localhost:8086/orgs/03a2bbf46249a000/... ``` -{{< /code-callout >}} - ### Organization ID in the CLI diff --git a/content/influxdb/v2/visualize-data/dashboards/_index.md b/content/influxdb/v2/visualize-data/dashboards/_index.md index 2efb73307c..dd06832022 100644 --- a/content/influxdb/v2/visualize-data/dashboards/_index.md +++ b/content/influxdb/v2/visualize-data/dashboards/_index.md @@ -21,12 +21,9 @@ Use the InfluxDB UI or `influx` CLI to view your dashboard ID. ### Dashboard ID in the UI When viewing a dashboard in the InfluxDB UI, your dashboard ID appears in the URL. - -{{< code-callout "04b6b15034cc000" >}} -```sh +```sh { callout="04b6b15034cc000" } http://localhost:8086/orgs/03a2bbf46249a000/dashboards/04b6b15034cc000/... ``` -{{< /code-callout >}} ### Dashboard ID in the CLI Use [`influx dashboards`](/influxdb/v2/reference/cli/influx/dashboards/) to view a list of dashboards and IDs. diff --git a/content/influxdb3/cloud-dedicated/process-data/visualize/superset.md b/content/influxdb3/cloud-dedicated/process-data/visualize/superset.md index 9e1d3be7e4..e9060fbf78 100644 --- a/content/influxdb3/cloud-dedicated/process-data/visualize/superset.md +++ b/content/influxdb3/cloud-dedicated/process-data/visualize/superset.md @@ -226,17 +226,13 @@ With Superset running, you're ready to [log in](#log-in-to-superset) and set up - **`?database`**: URL-encoded InfluxDB [database name](/influxdb3/cloud-dedicated/admin/databases/list/) - **`?token`**: InfluxDB [API token](/influxdb3/cloud-dedicated/get-started/setup/) with `READ` access to the specified database - {{< code-callout "<(domain|port|database-name|token)>" >}} -{{< code-callout "cluster-id\.influxdb\.io|443|example-database|example-token" >}} -```sh -# Syntax -datafusion+flightsql://:?database=&token= + ```sh { callout = "(<(domain|port|database-name|token)>)|cluster-id\.influxdb\.io|443|example-database|example-token"} + # Syntax + datafusion+flightsql://:?database=&token= -# Example -datafusion+flightsql://{{< influxdb/host >}}:443?database=example-database&token=example-token -``` -{{< /code-callout >}} - {{< /code-callout >}} + # Example + datafusion+flightsql://{{< influxdb/host >}}:443?database=example-database&token=example-token + ``` 6. Click **Test Connection** to ensure the connection works. 7. Click **Connect** to save the database connection. diff --git a/content/influxdb3/cloud-dedicated/query-data/execute-queries/client-libraries/python.md b/content/influxdb3/cloud-dedicated/query-data/execute-queries/client-libraries/python.md index 0ae8e82cbd..8481bbcc53 100644 --- a/content/influxdb3/cloud-dedicated/query-data/execute-queries/client-libraries/python.md +++ b/content/influxdb3/cloud-dedicated/query-data/execute-queries/client-libraries/python.md @@ -188,12 +188,9 @@ to install a recent version of the Python programming language for your system. {{< /tabs-wrapper >}} When a virtual environment is activated, the name displays at the beginning of your terminal command line--for example: - -{{% code-callout "(virtualenv-1)"%}} -```sh +```sh { callout="(virtualenv-1)" } (virtualenv-1) $ PROJECT_DIRECTORY ``` -{{% /code-callout %}} ## Query InfluxDB @@ -263,9 +260,7 @@ If using a non-POSIX-compliant operating system (such as Windows), specify the r The following example shows how to use the Python `certifi` package and client library options to pass the certificate path: -{{% code-placeholders "DATABASE_(NAME|TOKEN)" %}} -{{< code-callout "flight_client_options|tls_root_certs|(cert\b)" >}} -```py +```py { placeholders="DATABASE_(NAME|TOKEN)" callout="flight_client_options|tls_root_certs|(cert\b)" } from influxdb_client_3 import InfluxDBClient3, flight_client_options import certifi @@ -282,8 +277,6 @@ flight_client_options=flight_client_options( tls_root_certs=cert)) ... ``` -{{< /code-callout >}} -{{% /code-placeholders %}} For more information, see [`influxdb_client_3` query exceptions](/influxdb3/cloud-dedicated/reference/client-libraries/v3/python/#query-exceptions). diff --git a/content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md b/content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md index 61b38728d2..44b57a1221 100644 --- a/content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md +++ b/content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md @@ -200,16 +200,12 @@ The following steps summarize the [physical plan execution and data flow](#physi If your table doesn't contain data for the time range in your query, the physical plan starts with an `EmptyExec` leaf node--for example: -{{% code-callout "EmptyExec"%}} - -```sql +```sql { callout="EmptyExec" } ProjectionExec: expr=[temp@0 as temp] SortExec: expr=[time@1 ASC NULLS LAST] EmptyExec: produce_one_row=false ``` -{{% /code-callout %}} - ## Analyze a query plan for leading edge data The following sections guide you through analyzing a physical query plan for a typical time series use case--aggregating recently written (_leading edge_) data. @@ -621,14 +617,10 @@ The remaining ParquetExec_B expressions are similar to those in [ParquetExec_A]( If you compare [`file_group`](#file_groups) paths in [ParquetExec_A](#parquetexec_a) to those in [ParquetExec_B](#parquetexec_b), you'll notice that both contain files from the same partition: -{{% code-callout "b862a7e9b329ee6a4..." %}} - -```text +```text { callout="b862a7e9b329ee6a4..." } 1/1/b862a7e9b329ee6a4.../... ``` -{{% /code-callout %}} - The planner may distribute files from the same partition to different scan nodes for several reasons, including optimizations for handling [overlaps](#how-a-query-plan-distributes-data-for-scanning)--for example: - to separate non-overlapped files from overlapped files to minimize work required for deduplication (which is the case in this example) diff --git a/content/influxdb3/cloud-dedicated/write-data/best-practices/optimize-writes.md b/content/influxdb3/cloud-dedicated/write-data/best-practices/optimize-writes.md index c9e0bce648..f52d5a031a 100644 --- a/content/influxdb3/cloud-dedicated/write-data/best-practices/optimize-writes.md +++ b/content/influxdb3/cloud-dedicated/write-data/best-practices/optimize-writes.md @@ -112,9 +112,7 @@ When using the InfluxDB API `/api/v2/write` endpoint to write data, compress the data with `gzip` and set the `Content-Encoding` header to `gzip`--for example: {{% influxdb/custom-timestamps %}} -{{% code-placeholders "(DATABASE)_(TOKEN|NAME)" %}} -{{% code-callout "Content-Encoding: gzip" "orange" %}} -```bash +```bash { placeholders="(DATABASE)_(TOKEN|NAME)" callout="Content-Encoding: gzip" callout-color="orange" } echo "mem,host=host1 used_percent=23.43234543 1641024000 mem,host=host2 used_percent=26.81522361 1641027600 mem,host=host1 used_percent=22.52984738 1641031200 @@ -126,9 +124,6 @@ curl --request POST "https://{{< influxdb/host >}}/api/v2/write?org=ignored&buck --header "Content-Encoding: gzip" \ --data-binary @system.gzip ``` - -{{% /code-callout %}} -{{% /code-placeholders %}} {{% /influxdb/custom-timestamps %}} Replace the following: diff --git a/content/influxdb3/cloud-serverless/admin/organizations/view-orgs.md b/content/influxdb3/cloud-serverless/admin/organizations/view-orgs.md index 53d0e855fe..2f7d016279 100644 --- a/content/influxdb3/cloud-serverless/admin/organizations/view-orgs.md +++ b/content/influxdb3/cloud-serverless/admin/organizations/view-orgs.md @@ -21,8 +21,6 @@ If you belong to more than one organization with the same email address, you can After logging in to the InfluxDB UI, your organization ID appears in the URL--for example: -{{< code-callout "03a2bbf46249a000" >}} -```sh +```sh { callout="03a2bbf46249a000" } https://{{< influxdb/host >}}/orgs/03a2bbf46249a000/... ``` -{{< /code-callout >}} diff --git a/content/influxdb3/cloud-serverless/process-data/visualize/superset.md b/content/influxdb3/cloud-serverless/process-data/visualize/superset.md index edd90c13e7..c9bcfcc899 100644 --- a/content/influxdb3/cloud-serverless/process-data/visualize/superset.md +++ b/content/influxdb3/cloud-serverless/process-data/visualize/superset.md @@ -223,17 +223,13 @@ With Superset running, you're ready to [log in](#log-in-to-superset) and set up - **`?database`**: URL-encoded InfluxDB [bucket name](/influxdb3/cloud-serverless/admin/buckets/view-buckets/) - **`?token`**: InfluxDB [API token](/influxdb3/cloud-serverless/get-started/setup/) with `READ` access to the specified bucket - {{< code-callout "<(domain|port|database|token)>" >}} -{{< code-callout "us-east-1-1\.aws\.cloud2\.influxdata\.com|443|example-bucket|example-token" >}} -```sh -# Syntax -datafusion+flightsql://:?database=&token= + ```sh { callout="(<(domain|port|database|token)>)|us-east-1-1\.aws\.cloud2\.influxdata\.com|443|example-bucket|example-token"} + # Syntax + datafusion+flightsql://:?database=&token= -# Example -datafusion+flightsql://us-east-1-1.aws.cloud2.influxdata.com:443?database=example-bucket&token=example-token -``` -{{< /code-callout >}} - {{< /code-callout >}} + # Example + datafusion+flightsql://us-east-1-1.aws.cloud2.influxdata.com:443?database=example-bucket&token=example-token + ``` 6. Click **Test Connection** to ensure the connection works. 7. Click **Connect** to save the database connection. diff --git a/content/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/python.md b/content/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/python.md index da203588de..cad463ecd2 100644 --- a/content/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/python.md +++ b/content/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/python.md @@ -189,12 +189,10 @@ to install a recent version of the Python programming language for your system. {{< /tabs-wrapper >}} When a virtual environment is activated, the name displays at the beginning of your terminal command line--for example: - -{{% code-callout "(virtualenv-1)"%}} -```sh + +```sh { callout="(virtualenv-1)" } (virtualenv-1) $ PROJECT_DIRECTORY ``` -{{% /code-callout %}} ## Query InfluxDB @@ -264,9 +262,7 @@ If using a non-POSIX-compliant operating system (such as Windows), specify the r The following code sample shows how to use the Python `certifi` package and client library options to pass the certificate path: -{{% code-placeholders "BUCKET_NAME|API_TOKEN" %}} -{{< code-callout "flight_client_options|tls_root_certs|(cert\b)" >}} -```py +```py { placeholders="BUCKET_NAME|API_TOKEN" callout="flight_client_options|tls_root_certs|(cert\b)" } from influxdb_client_3 import InfluxDBClient3, flight_client_options import certifi @@ -275,15 +271,15 @@ cert = fh.read() fh.close() client = InfluxDBClient3( -host="{{< influxdb/host >}}", -token='API_TOKEN', -database='BUCKET_NAME', -flight_client_options=flight_client_options( -tls_root_certs=cert)) + host="{{< influxdb/host >}}", + token='API_TOKEN', + database='BUCKET_NAME', + flight_client_options=flight_client_options( + tls_root_certs=cert + ) +) ... ``` -{{< /code-callout >}} -{{% /code-placeholders %}} For more information, see [`influxdb_client_3` query exceptions](/influxdb3/cloud-serverless/reference/client-libraries/v3/python/#query-exceptions). diff --git a/content/influxdb3/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md b/content/influxdb3/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md index 1c6c264a57..211f97ea53 100644 --- a/content/influxdb3/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md +++ b/content/influxdb3/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md @@ -196,16 +196,12 @@ The following steps summarize the [physical plan execution and data flow](#physi If your table doesn't contain data for the time range in your query, the physical plan starts with an `EmptyExec` leaf node--for example: -{{% code-callout "EmptyExec"%}} - -```sql +```sql { callout="EmptyExec" } ProjectionExec: expr=[temp@0 as temp] SortExec: expr=[time@1 ASC NULLS LAST] EmptyExec: produce_one_row=false ``` -{{% /code-callout %}} - ## Analyze a query plan for leading edge data The following sections guide you through analyzing a physical query plan for a typical time series use case--aggregating recently written (_leading edge_) data. @@ -617,14 +613,10 @@ The remaining ParquetExec_B expressions are similar to those in [ParquetExec_A]( If you compare [`file_group`](#file_groups) paths in [ParquetExec_A](#parquetexec_a) to those in [ParquetExec_B](#parquetexec_b), you'll notice that both contain files from the same partition: -{{% code-callout "b862a7e9b329ee6a4..." %}} - -```text +```text { callout="b862a7e9b329ee6a4..." } 1/1/b862a7e9b329ee6a4.../... ``` -{{% /code-callout %}} - The planner may distribute files from the same partition to different scan nodes for several reasons, including optimizations for handling [overlaps](#how-a-query-plan-distributes-data-for-scanning)--for example: - to separate non-overlapped files from overlapped files to minimize work required for deduplication (which is the case in this example) diff --git a/content/influxdb3/cloud-serverless/reference/regions.md b/content/influxdb3/cloud-serverless/reference/regions.md index eaeb89b2e5..82f2bdda8a 100644 --- a/content/influxdb3/cloud-serverless/reference/regions.md +++ b/content/influxdb3/cloud-serverless/reference/regions.md @@ -38,11 +38,9 @@ Use the URLs below to interact with your InfluxDB Cloud Serverless instances wit > and review your organization URL. The first subdomain identifies your > InfluxDB Cloud Serverless cluster. For example: > -> {{< code-callout "us-west-2-1" >}} -```sh -https://us-west-2-1.aws.cloud2.influxdata.com/orgs/03a2bbf46249a000/... -``` -{{< /code-callout >}} +> ```sh { callout="us-west-2-1" } +> https://us-west-2-1.aws.cloud2.influxdata.com/orgs/03a2bbf46249a000/... +> ``` --> {{< cloud_regions type="iox-table" >}} diff --git a/content/influxdb3/cloud-serverless/write-data/best-practices/optimize-writes.md b/content/influxdb3/cloud-serverless/write-data/best-practices/optimize-writes.md index ed01029d2f..14f61ffeea 100644 --- a/content/influxdb3/cloud-serverless/write-data/best-practices/optimize-writes.md +++ b/content/influxdb3/cloud-serverless/write-data/best-practices/optimize-writes.md @@ -113,10 +113,8 @@ When using the InfluxDB API `/api/v2/write` endpoint to write data, compress the data with `gzip` and set the `Content-Encoding` header to `gzip`. {{% influxdb/custom-timestamps %}} -{{% code-placeholders "BUCKET_NAME|API_TOKEN|ORG_NAME" %}} -{{% code-callout "Content-Encoding: gzip" "orange" %}} -```bash +```bash { placeholders="BUCKET_NAME|API_TOKEN|ORG_NAME" callout="Content-Encoding: gzip" callout-color="orange" } echo "mem,host=host1 used_percent=23.43234543 1641024000 mem,host=host2 used_percent=26.81522361 1641027600 mem,host=host1 used_percent=22.52984738 1641031200 @@ -129,8 +127,6 @@ curl --request POST "https://{{< influxdb/host >}}/api/v2/write?org=ORG_NAME&buc --data-binary @system.gzip ``` -{{% /code-callout %}} -{{% /code-placeholders %}} {{% /influxdb/custom-timestamps %}} Replace the following: diff --git a/content/influxdb3/clustered/admin/upgrade.md b/content/influxdb3/clustered/admin/upgrade.md index 26ad743efb..a19f3199e1 100644 --- a/content/influxdb3/clustered/admin/upgrade.md +++ b/content/influxdb3/clustered/admin/upgrade.md @@ -56,14 +56,10 @@ kubectl get appinstances.kubecfg.dev influxdb -n influxdb -o jsonpath='{.spec.pa The package version number is at the end of the returned string (after `influxdb:`): -{{% code-callout "PACKAGE_VERSION" "orange" %}} - -``` +```sh { callout="PACKAGE_VERSION" callout-color="orange" } us-docker.pkg.dev/influxdb2-artifacts/clustered/influxdb:PACKAGE_VERSION ``` -{{% /code-callout %}} - ### Identify the version to upgrade to All available InfluxDB Clustered package versions are provided in the diff --git a/content/influxdb3/clustered/admin/users/add.md b/content/influxdb3/clustered/admin/users/add.md index f8d8d4a479..9958373f8a 100644 --- a/content/influxdb3/clustered/admin/users/add.md +++ b/content/influxdb3/clustered/admin/users/add.md @@ -63,10 +63,7 @@ other OAuth2 providers should work as well: {{% /code-tabs %}} {{% code-tab-content %}} -{{% code-callout "keycloak" "green" %}} -{{% code-placeholders "KEYCLOAK_(HOST|REALM|USER_ID)" %}} - -```yaml +```yaml { placeholders="KEYCLOAK_(HOST|REALM|USER_ID)" callout="keycloak" callout-color="green" } apiVersion: kubecfg.dev/v1alpha1 kind: AppInstance # ... @@ -86,9 +83,6 @@ spec: email: mcfly@influxdata.com ``` -{{% /code-placeholders %}} -{{% /code-callout %}} - Replace the following: - {{% code-placeholder-key %}}`KEYCLOAK_HOST`{{% /code-placeholder-key %}}: @@ -104,10 +98,7 @@ Replace the following: {{% /code-tab-content %}} {{% code-tab-content %}} -{{% code-callout "auth0" "green" %}} -{{% code-placeholders "AUTH0_(HOST|USER_ID)" %}} - -```yaml +```yaml { placeholders="AUTH0_(HOST|USER_ID)" callout="auth0" callout-color="green" } apiVersion: kubecfg.dev/v1alpha1 kind: AppInstance # ... @@ -127,9 +118,6 @@ spec: email: mcfly@influxdata.com ``` -{{% /code-placeholders %}} -{{% /code-callout %}} - Replace the following: - {{% code-placeholder-key %}}`AUTH0_HOST`{{% /code-placeholder-key %}}: @@ -142,10 +130,7 @@ Replace the following: {{% /code-tab-content %}} {{% code-tab-content %}} -{{% code-callout "azure" "green" %}} -{{% code-placeholders "AZURE_(USER|TENANT)_ID" %}} - -```yaml +```yaml { placeholders="AZURE_(USER|TENANT)_ID" callout="azure" callout-color="green" } apiVersion: kubecfg.dev/v1alpha1 kind: AppInstance # ... @@ -165,9 +150,6 @@ spec: email: mcfly@influxdata.com ``` -{{% /code-placeholders %}} -{{% /code-callout %}} - Replace the following: - {{% code-placeholder-key %}}`AZURE_TENANT_ID`{{% /code-placeholder-key %}}: @@ -208,10 +190,7 @@ other OAuth2 providers should work as well: {{% /code-tabs %}} {{% code-tab-content %}} -{{% code-callout "keycloak" "green" %}} -{{% code-placeholders "KEYCLOAK_(HOST|REALM|USER_ID)" %}} - -```yaml +```yaml { placeholders="KEYCLOAK_(HOST|REALM|USER_ID)" callout="keycloak" callout-color="green" } admin: # The identity provider to be used (such as "keycloak", "auth0", or "azure") # Note, use "azure" for Azure Active Directory @@ -229,9 +208,6 @@ admin: email: mcfly@influxdata.com ``` -{{% /code-placeholders %}} -{{% /code-callout %}} - Replace the following: - {{% code-placeholder-key %}}`KEYCLOAK_HOST`{{% /code-placeholder-key %}}: @@ -246,10 +222,7 @@ Replace the following: {{% /code-tab-content %}} {{% code-tab-content %}} -{{% code-callout "auth0" "green" %}} -{{% code-placeholders "AUTH0_(HOST|USER_ID)" %}} - -```yaml +```yaml { placeholders="AUTH0_(HOST|USER_ID)" callout="auth0" callout-color="green" } admin: # The identity provider to be used e.g. "keycloak", "auth0", "azure", etc # Note, use "azure" for Azure Active Directory. @@ -267,9 +240,6 @@ admin: email: mcfly@influxdata.com ``` -{{% /code-placeholders %}} -{{% /code-callout %}} - Replace the following: - {{% code-placeholder-key %}}`AUTH0_HOST`{{% /code-placeholder-key %}}: @@ -282,10 +252,7 @@ Replace the following: {{% /code-tab-content %}} {{% code-tab-content %}} -{{% code-callout "azure" "green" %}} -{{% code-placeholders "AZURE_(USER|TENANT)_ID" %}} - -```yaml +```yaml { placeholders="AZURE_(USER|TENANT)_ID" callout="azure" callout-color="green" } admin: # The identity provider to be used e.g. "keycloak", "auth0", "azure", etc # Note, use "azure" for Azure Active Directory. @@ -303,9 +270,6 @@ admin: email: mcfly@influxdata.com ``` -{{% /code-placeholders %}} -{{% /code-callout %}} - Replace the following: - {{% code-placeholder-key %}}`AZURE_TENANT_ID`{{% /code-placeholder-key %}}: diff --git a/content/influxdb3/clustered/install/secure-cluster/auth.md b/content/influxdb3/clustered/install/secure-cluster/auth.md index 57bb7a9a40..69c8e5034f 100644 --- a/content/influxdb3/clustered/install/secure-cluster/auth.md +++ b/content/influxdb3/clustered/install/secure-cluster/auth.md @@ -359,10 +359,7 @@ other OAuth2 providers should work as well: {{% /code-tabs %}} {{% code-tab-content %}} -{{% code-callout "keycloak" "green" %}} -{{% code-placeholders "KEYCLOAK_(HOST|REALM|USER_ID)" %}} - -```yaml +```yaml { placeholders="KEYCLOAK_(HOST|REALM|USER_ID)" callout="keycloak" callout-color="green" } apiVersion: kubecfg.dev/v1alpha1 kind: AppInstance # ... @@ -382,9 +379,6 @@ spec: email: mcfly@influxdata.com ``` -{{% /code-placeholders %}} -{{% /code-callout %}} - --- Replace the following: @@ -401,10 +395,7 @@ Replace the following: {{% /code-tab-content %}} {{% code-tab-content %}} -{{% code-callout "auth0" "green" %}} -{{% code-placeholders "AUTH0_(HOST|USER_ID)" %}} - -```yaml +```yaml { placeholders="AUTH0_(HOST|USER_ID)" callout="auth0" callout-color="green" } apiVersion: kubecfg.dev/v1alpha1 kind: AppInstance # ... @@ -424,9 +415,6 @@ spec: email: mcfly@influxdata.com ``` -{{% /code-placeholders %}} -{{% /code-callout %}} - --- Replace the following: @@ -441,10 +429,7 @@ Replace the following: {{% /code-tab-content %}} {{% code-tab-content %}} -{{% code-callout "azure" "green" %}} -{{% code-placeholders "AZURE_(USER|TENANT)_ID" %}} - -```yaml +```yaml { placeholders="AZURE_(USER|TENANT)_ID" allout="azure" callout-color="green" } apiVersion: kubecfg.dev/v1alpha1 kind: AppInstance # ... @@ -464,9 +449,6 @@ spec: email: mcfly@influxdata.com ``` -{{% /code-placeholders %}} -{{% /code-callout %}} - --- Replace the following: @@ -510,10 +492,7 @@ other OAuth2 providers should work as well: {{% /code-tabs %}} {{% code-tab-content %}} -{{% code-callout "keycloak" "green" %}} -{{% code-placeholders "KEYCLOAK_(HOST|REALM|USER_ID)" %}} - -```yaml +```yaml { placeholders="KEYCLOAK_(HOST|REALM|USER_ID)" callout="keycloak" callout-color="green" } admin: # The identity provider to be used e.g. "keycloak", "auth0", "azure", etc # Note for Azure Active Directory it must be exactly "azure" @@ -531,9 +510,6 @@ admin: email: mcfly@influxdata.com ``` -{{% /code-placeholders %}} -{{% /code-callout %}} - --- Replace the following: @@ -550,10 +526,7 @@ Replace the following: {{% /code-tab-content %}} {{% code-tab-content %}} -{{% code-callout "auth0" "green" %}} -{{% code-placeholders "AUTH0_(HOST|USER_ID)" %}} - -```yaml +```yaml { placeholders="AUTH0_(HOST|USER_ID)" callout="auth0" callout-color="green" } admin: # The identity provider to be used e.g. "keycloak", "auth0", "azure", etc # Note for Azure Active Directory it must be exactly "azure" @@ -571,9 +544,6 @@ admin: email: mcfly@influxdata.com ``` -{{% /code-placeholders %}} -{{% /code-callout %}} - --- Replace the following: @@ -588,10 +558,7 @@ Replace the following: {{% /code-tab-content %}} {{% code-tab-content %}} -{{% code-callout "azure" "green" %}} -{{% code-placeholders "AZURE_(USER|TENANT)_ID" %}} - -```yaml +```yaml { placeholders="AZURE_(USER|TENANT)_ID" callout="azure" callout-color="green" } admin: # The identity provider to be used e.g. "keycloak", "auth0", "azure", etc # Note for Azure Active Directory it must be exactly "azure" @@ -609,9 +576,6 @@ admin: email: mcfly@influxdata.com ``` -{{% /code-placeholders %}} -{{% /code-callout %}} - --- Replace the following: diff --git a/content/influxdb3/clustered/install/secure-cluster/tls.md b/content/influxdb3/clustered/install/secure-cluster/tls.md index 2d674b9538..34e9e2f378 100644 --- a/content/influxdb3/clustered/install/secure-cluster/tls.md +++ b/content/influxdb3/clustered/install/secure-cluster/tls.md @@ -93,15 +93,13 @@ InfluxDB installer operator. The operator lets you to add annotations {{% /expand %}} {{< /expand-wrapper >}} -{{% code-callout "ingress-tls|cluster-host\.com" "green" %}} - {{< code-tabs-wrapper >}} {{% code-tabs %}} [AppInstance](#) [Helm](#) {{% /code-tabs %}} {{% code-tab-content %}} -```yaml +```yaml { callout="ingress-tls|cluster-host\.com" callout-color="green" } apiVersion: kubecfg.dev/v1alpha1 kind: AppInstance # ... @@ -116,7 +114,7 @@ spec: ``` {{% /code-tab-content %}} {{% code-tab-content %}} -```yaml +```yaml { callout="ingress-tls|cluster-host\.com" callout-color="green" } ingress: hosts: - {{< influxdb/host >}} @@ -125,8 +123,6 @@ ingress: {{% /code-tab-content %}} {{< /code-tabs-wrapper >}} -{{% /code-callout %}} - ## Require HTTPS on the object store Some object store providers allow unsecure connections when accessing the object @@ -179,11 +175,9 @@ installing TLS certificates and ensuring secure connections. If currently using an unsecure connection to your Catalog store database, update your Catalog store data source name (DSN) to **remove the `sslmode=disable` query parameter**: -{{% code-callout "\?sslmode=disable" "magenta delete" %}} -```txt +```txt { callout="\?sslmode=disable" callout-color="magenta delete" } postgres://username:passw0rd@mydomain:5432/influxdb?sslmode=disable ``` -{{% /code-callout %}} ## Provide a custom certificate authority bundle {note="Optional"} diff --git a/content/influxdb3/clustered/install/set-up-cluster/configure-cluster/directly.md b/content/influxdb3/clustered/install/set-up-cluster/configure-cluster/directly.md index 2df4c29b7d..cea9b68c60 100644 --- a/content/influxdb3/clustered/install/set-up-cluster/configure-cluster/directly.md +++ b/content/influxdb3/clustered/install/set-up-cluster/configure-cluster/directly.md @@ -368,9 +368,7 @@ To configure ingress, provide values for the following fields in your > For more information, see Phase 4 of the InfluxDB Clustered installation > process, [Secure your cluster](/influxdb3/clustered/install/secure-cluster/). -{{% code-callout "ingress-tls|cluster-host\.com" "green" %}} - -```yaml +```yaml { callout="ingress-tls|cluster-host\.com" callout-color="green" } apiVersion: kubecfg.dev/v1alpha1 kind: AppInstance # ... @@ -384,8 +382,6 @@ ingress: tlsSecretName: ingress-tls ``` -{{% /code-callout %}} - #### Configure the object store To connect your InfluxDB cluster to your object store, provide the required @@ -650,19 +646,15 @@ Replace the following: {{% expand "View percent-encoded DSN example" %}} To use the following DSN containing special characters: -{{% code-callout "#" %}} -```txt +```txt { callout="#" } postgresql://postgres:meow#meow@my-fancy.cloud-database.party:5432/postgres ``` -{{% /code-callout %}} You must percent-encode the special characters in the connection string: -{{% code-callout "%23" %}} -```txt +```txt { callout="%23" } postgresql://postgres:meow%23meow@my-fancy.cloud-database.party:5432/postgres ``` -{{% /code-callout %}} {{% /expand %}} {{< /expand-wrapper >}} @@ -674,11 +666,9 @@ postgresql://postgres:meow%23meow@my-fancy.cloud-database.party:5432/postgres > If your PostgreSQL-compatible instance runs without TLS or SSL, you must include > the `sslmode=disable` parameter in the DSN. For example: > -> {{% code-callout "sslmode=disable" %}} -``` -postgres://username:passw0rd@mydomain:5432/influxdb?sslmode=disable -``` -{{% /code-callout %}} +> ```txt { callout="sslmode=disable" } +> postgres://username:passw0rd@mydomain:5432/influxdb?sslmode=disable +> ``` #### Configure local storage for ingesters diff --git a/content/influxdb3/clustered/install/set-up-cluster/configure-cluster/use-helm.md b/content/influxdb3/clustered/install/set-up-cluster/configure-cluster/use-helm.md index c32cd8b0b3..3134660415 100644 --- a/content/influxdb3/clustered/install/set-up-cluster/configure-cluster/use-helm.md +++ b/content/influxdb3/clustered/install/set-up-cluster/configure-cluster/use-helm.md @@ -369,17 +369,13 @@ To configure ingress, provide values for the following fields in your > For more information, see Phase 4 of the InfluxDB Clustered installation > process, [Secure your cluster](/influxdb3/clustered/install/secure-cluster/). - {{% code-callout "ingress-tls|cluster-host\.com" "green" %}} - -```yaml +```yaml { callout="ingress-tls|cluster-host\\.com" callout-color="green" } ingress: hosts: - {{< influxdb/host >}} tlsSecretName: ingress-tls ``` -{{% /code-callout %}} - #### Configure the object store To connect your InfluxDB cluster to your object store, provide the required @@ -623,19 +619,15 @@ Replace the following: {{% expand "View percent-encoded DSN example" %}} To use the following DSN containing special characters: -{{% code-callout "#" %}} -```txt +```txt { callout="#" } postgresql://postgres:meow#meow@my-fancy.cloud-database.party:5432/postgres ``` -{{% /code-callout %}} You must percent-encode the special characters in the connection string: -{{% code-callout "%23" %}} -```txt +```txt { callout="%23" } postgresql://postgres:meow%23meow@my-fancy.cloud-database.party:5432/postgres ``` -{{% /code-callout %}} {{% /expand %}} {{< /expand-wrapper >}} @@ -647,11 +639,9 @@ postgresql://postgres:meow%23meow@my-fancy.cloud-database.party:5432/postgres > If your PostgreSQL-compatible instance runs without TLS or SSL, you must include > the `sslmode=disable` parameter in the DSN. For example: > -> {{% code-callout "sslmode=disable" %}} -``` -postgres://username:passw0rd@mydomain:5432/influxdb?sslmode=disable -``` -{{% /code-callout %}} +> ```sh { callout="sslmode=disable" } +> postgres://username:passw0rd@mydomain:5432/influxdb?sslmode=disable +> ``` #### Configure local storage for ingesters diff --git a/content/influxdb3/clustered/process-data/visualize/superset.md b/content/influxdb3/clustered/process-data/visualize/superset.md index df7552fbfb..479d92f1b2 100644 --- a/content/influxdb3/clustered/process-data/visualize/superset.md +++ b/content/influxdb3/clustered/process-data/visualize/superset.md @@ -227,17 +227,14 @@ With Superset running, you're ready to [log in](#log-in-to-superset) and set up - **`?database`**: URL-encoded InfluxDB [database name](/influxdb3/clustered/admin/databases/list/) - **`?token`**: InfluxDB [API token](/influxdb3/clustered/get-started/setup/) with `READ` access to the specified database - {{< code-callout "<(domain|port|database-name|token)>" >}} -{{< code-callout "cluster-id\.influxdb\.io|443|example-database|example-token" >}} -```sh -# Syntax -datafusion+flightsql://:?database=&token= -# Example -datafusion+flightsql://{{< influxdb/host >}}:443?database=example-database&token=example-token -``` -{{< /code-callout >}} - {{< /code-callout >}} + ```sh { callout="(<(domain|port|database-name|token)>)|cluster-id\.influxdb\.io|443|example-database|example-token" } + # Syntax + datafusion+flightsql://:?database=&token= + + # Example + datafusion+flightsql://{{< influxdb/host >}}:443?database=example-database&token=example-token + ``` 6. Click **Test Connection** to ensure the connection works. 7. Click **Connect** to save the database connection. diff --git a/content/influxdb3/clustered/query-data/execute-queries/client-libraries/python.md b/content/influxdb3/clustered/query-data/execute-queries/client-libraries/python.md index c64e2f6817..b69f6bc416 100644 --- a/content/influxdb3/clustered/query-data/execute-queries/client-libraries/python.md +++ b/content/influxdb3/clustered/query-data/execute-queries/client-libraries/python.md @@ -182,12 +182,10 @@ to install a recent version of the Python programming language for your system. {{< /tabs-wrapper >}} When a virtual environment is activated, the name displays at the beginning of your terminal command line--for example: - -{{% code-callout "(virtualenv-1)"%}} -```sh + +```sh { callout="(virtualenv-1)" } (virtualenv-1) $ PROJECT_DIRECTORY ``` -{{% /code-callout %}} ## Query InfluxDB @@ -257,9 +255,7 @@ If using a non-POSIX-compliant operating system (such as Windows), specify the r The following example shows how to use the Python `certifi` package and client library options to pass the certificate path: -{{% code-placeholders "DATABASE_(NAME|TOKEN)" %}} -{{< code-callout "flight_client_options|tls_root_certs|(cert\b)" >}} -```py +```py { placeholders="DATABASE_(NAME|TOKEN)" callout="flight_client_options|tls_root_certs|(cert\b)" } from influxdb_client_3 import InfluxDBClient3, flight_client_options import certifi @@ -275,8 +271,6 @@ flight_client_options=flight_client_options( tls_root_certs=cert)) ... ``` -{{< /code-callout >}} -{{% /code-placeholders %}} For more information, see [`influxdb_client_3` query exceptions](/influxdb3/clustered/reference/client-libraries/v3/python/#query-exceptions). diff --git a/content/influxdb3/clustered/query-data/troubleshoot-and-optimize/analyze-query-plan.md b/content/influxdb3/clustered/query-data/troubleshoot-and-optimize/analyze-query-plan.md index 7f26589812..33ea81a7d6 100644 --- a/content/influxdb3/clustered/query-data/troubleshoot-and-optimize/analyze-query-plan.md +++ b/content/influxdb3/clustered/query-data/troubleshoot-and-optimize/analyze-query-plan.md @@ -200,16 +200,12 @@ The following steps summarize the [physical plan execution and data flow](#physi If your table doesn't contain data for the time range in your query, the physical plan starts with an `EmptyExec` leaf node--for example: -{{% code-callout "EmptyExec"%}} - -```sql +```sql { callout="EmptyExec" } ProjectionExec: expr=[temp@0 as temp] SortExec: expr=[time@1 ASC NULLS LAST] EmptyExec: produce_one_row=false ``` -{{% /code-callout %}} - ## Analyze a query plan for leading edge data The following sections guide you through analyzing a physical query plan for a typical time series use case--aggregating recently written (_leading edge_) data. @@ -621,14 +617,10 @@ The remaining ParquetExec_B expressions are similar to those in [ParquetExec_A]( If you compare [`file_group`](#file_groups) paths in [ParquetExec_A](#parquetexec_a) to those in [ParquetExec_B](#parquetexec_b), you'll notice that both contain files from the same partition: -{{% code-callout "b862a7e9b329ee6a4..." %}} - -```text +```text { callout="b862a7e9b329ee6a4..." } 1/1/b862a7e9b329ee6a4.../... ``` -{{% /code-callout %}} - The planner may distribute files from the same partition to different scan nodes for several reasons, including optimizations for handling [overlaps](#how-a-query-plan-distributes-data-for-scanning)--for example: - to separate non-overlapped files from overlapped files to minimize work required for deduplication (which is the case in this example) diff --git a/content/influxdb3/clustered/write-data/best-practices/optimize-writes.md b/content/influxdb3/clustered/write-data/best-practices/optimize-writes.md index 6b1624a185..a3c8e43674 100644 --- a/content/influxdb3/clustered/write-data/best-practices/optimize-writes.md +++ b/content/influxdb3/clustered/write-data/best-practices/optimize-writes.md @@ -113,9 +113,8 @@ When using the InfluxDB API `/api/v2/write` endpoint to write data, compress the data with `gzip` and set the `Content-Encoding` header to `gzip`--for example: {{% influxdb/custom-timestamps %}} -{{% code-placeholders "(DATABASE)_(TOKEN|NAME)" %}} -{{% code-callout "Content-Encoding: gzip" "orange" %}} -```bash + +```bash { placeholders="(DATABASE)_(TOKEN|NAME)" callout="Content-Encoding: gzip" callout-color="orange" } echo "mem,host=host1 used_percent=23.43234543 1641024000 mem,host=host2 used_percent=26.81522361 1641027600 mem,host=host1 used_percent=22.52984738 1641031200 @@ -128,8 +127,6 @@ curl --request POST "https://{{< influxdb/host >}}/api/v2/write?org=ignored&buck --data-binary @system.gzip ``` -{{% /code-callout %}} -{{% /code-placeholders %}} {{% /influxdb/custom-timestamps %}} Replace the following: diff --git a/content/influxdb3/enterprise/performance-preview/_index.md b/content/influxdb3/enterprise/performance-preview/_index.md index fc788582e4..02a5d1628b 100644 --- a/content/influxdb3/enterprise/performance-preview/_index.md +++ b/content/influxdb3/enterprise/performance-preview/_index.md @@ -66,8 +66,7 @@ Key improvements include: Include the `--use-pacha-tree` flag in your [`influxdb3 serve` startup command](/influxdb3/enterprise/get-started/setup/): -{{< code-callout "--use-pacha-tree" >}} -```bash +```bash { callout="--use-pacha-tree" } influxdb3 serve \ --node-id host01 \ --cluster-id cluster01 \ @@ -75,7 +74,6 @@ influxdb3 serve \ --data-dir ~/.influxdb3 \ --use-pacha-tree ``` -{{< /code-callout >}} You can also enable the preview with an environment variable: diff --git a/content/influxdb3/explorer/install.md b/content/influxdb3/explorer/install.md index 09b972a19b..ac18e5ac98 100644 --- a/content/influxdb3/explorer/install.md +++ b/content/influxdb3/explorer/install.md @@ -396,10 +396,9 @@ To configure Explorer to trust self-signed or custom CA certificates when connec [Docker](#) [Docker Compose](#) {{% /code-tabs %}} - {{% code-tab-content %}} -{{< code-callout "NODE_EXTRA_CA_CERTS" >}} -```bash + +```bash { callout="NODE_EXTRA_CA_CERTS" } docker run --detach \ --name influxdb3-explorer \ --restart unless-stopped \ @@ -413,12 +412,11 @@ docker run --detach \ influxdata/influxdb3-ui:{{% latest-patch %}} \ --mode=admin ``` -{{< /code-callout >}} -{{% /code-tab-content %}} +{{% /code-tab-content %}} {{% code-tab-content %}} -{{< code-callout "NODE_EXTRA_CA_CERTS" >}} -```yaml + +```yaml { callout="NODE_EXTRA_CA_CERTS" } # docker-compose.yml version: '3.8' @@ -440,7 +438,7 @@ services: NODE_EXTRA_CA_CERTS: /ca-certs/your-ca.pem restart: unless-stopped ``` -{{< /code-callout >}} + {{% /code-tab-content %}} {{< /code-tabs-wrapper >}} diff --git a/content/shared/influxdb3-visualize/superset.md b/content/shared/influxdb3-visualize/superset.md index dbe0baaa20..89e01ecdb6 100644 --- a/content/shared/influxdb3-visualize/superset.md +++ b/content/shared/influxdb3-visualize/superset.md @@ -214,17 +214,13 @@ a database connection. - **`?database`**: URL-encoded [database](/influxdb3/version/admin/databases/) name - **`?token`**: {{< product-name >}} {{% token-link %}} - {{< code-callout "<(domain|port|database-name|token)>" >}} -{{< code-callout "localhost|8181|example-database|example-token" >}} -```sh -# Syntax -datafusion+flightsql://:?database=&token= + ```sh { callout="(<(domain|port|database-name|token)>)|localhost|8181|example-database|example-token" } + # Syntax + datafusion+flightsql://:?database=&token= -# Example -datafusion+flightsql://{{< influxdb/host >}}?database=example-database&token=example-token -``` -{{< /code-callout >}} - {{< /code-callout >}} + # Example + datafusion+flightsql://{{< influxdb/host >}}?database=example-database&token=example-token + ``` 6. Click **Test Connection** to ensure the connection works. 7. Click **Connect** to save the database connection. diff --git a/content/shared/influxdb3-write-guides/best-practices/optimize-writes.md b/content/shared/influxdb3-write-guides/best-practices/optimize-writes.md index fe7dd9da67..75e03f3476 100644 --- a/content/shared/influxdb3-write-guides/best-practices/optimize-writes.md +++ b/content/shared/influxdb3-write-guides/best-practices/optimize-writes.md @@ -140,9 +140,8 @@ When using the InfluxDB API `/api/v2/write` endpoint to write data, compress the data with `gzip` and set the `Content-Encoding` header to `gzip`--for example: {{% influxdb/custom-timestamps %}} -{{% code-placeholders "(AUTH|DATABASE)_(TOKEN|NAME)" %}} -{{% code-callout "Content-Encoding: gzip" "orange" %}} -```bash + +```bash { placeholders="(AUTH|DATABASE)_(TOKEN|NAME)" callout="Content-Encoding: gzip" callout-color="orange" } echo "mem,host=host1 used_percent=23.43234543 1641024000 mem,host=host2 used_percent=26.81522361 1641027600 mem,host=host1 used_percent=22.52984738 1641031200 @@ -155,8 +154,6 @@ curl --request POST "https://{{< influxdb/host >}}/api/v2/write?org=ignored&buck --data-binary @system.gzip ``` -{{% /code-callout %}} -{{% /code-placeholders %}} {{% /influxdb/custom-timestamps %}} Replace the following: diff --git a/content/shared/sql-reference/join.md b/content/shared/sql-reference/join.md index f2f288a088..7fa3a6e446 100644 --- a/content/shared/sql-reference/join.md +++ b/content/shared/sql-reference/join.md @@ -247,8 +247,7 @@ If a column exists on both sides of the join and is used in the `SELECT`, sides of the join have a `time` column and you want to explicitly select a time column, you must specifiy which side of the join to use the time column from: -{{% code-callout "prod_line.time" "green" %}} -``` +```sql { callout="prod_line.time" callout-color="green" } SELECT prod_line.time, produced, @@ -258,4 +257,3 @@ FROM INNER JOIN errors ON -- ... ``` -{{% /code-callout %}} diff --git a/content/telegraf/controller/configs/use.md b/content/telegraf/controller/configs/use.md index 3ee8638964..830f6c6395 100644 --- a/content/telegraf/controller/configs/use.md +++ b/content/telegraf/controller/configs/use.md @@ -84,12 +84,10 @@ values—for example: ##### Set the parameter value in the configuration URL -{{% code-callout "agent_id=my-agent-123" "magenta" %}} -```bash +```bash { callout="agent_id=my-agent-123" callout-color="magenta" } telegraf \ --config "http://localhost:8888/api/configs/xxxxxx/toml?agent_id=my-agent-123" ``` -{{% /code-callout %}} > [!Important] > If you request a configuration without providing values for required diff --git a/layouts/_default/_markup/render-codeblock.html b/layouts/_default/_markup/render-codeblock.html index a46f2e0f72..275a9f733b 100644 --- a/layouts/_default/_markup/render-codeblock.html +++ b/layouts/_default/_markup/render-codeblock.html @@ -1,13 +1,20 @@ {{ $result := transform.HighlightCodeBlock . }} -{{ if .Attributes.placeholders }} - {{ $elReplace := print "
$0
" }} - {{ $highlightedCode := highlight .Inner .Type }} - {{ $withPlaceholders := replaceRE .Attributes.placeholders $elReplace $highlightedCode }} - {{ $withPlaceholders | safeHTML }} -{{ else }} +{{- if or .Attributes.placeholders .Attributes.callout -}} + {{ $code := highlight .Inner .Type }} + {{- if .Attributes.placeholders -}} + {{ $placeholderReplace := print "
$0
" }} + {{ $code = replaceRE .Attributes.placeholders $placeholderReplace $code }} + {{- end -}} + {{- if .Attributes.callout -}} + {{ $color := index .Attributes "callout-color" | default "green" }} + {{ $calloutReplace := print "$0" }} + {{ $code = replaceRE .Attributes.callout $calloutReplace $code }} + {{- end -}} + {{ $code | safeHTML }} +{{- else -}} {{- $wrapped := string $result.Wrapped -}} {{- if in $wrapped "tc-dynamic-values" -}} {{- $wrapped = replace $wrapped "tc-dynamic-values" "tc-dynamic-values\" data-component=\"tc-dynamic-values" -}} {{- end -}} {{ $wrapped | safeHTML }} -{{ end }} +{{- end -}} diff --git a/layouts/shortcodes/code-callout.html b/layouts/shortcodes/code-callout.html deleted file mode 100644 index 1b21aa5a93..0000000000 --- a/layouts/shortcodes/code-callout.html +++ /dev/null @@ -1,6 +0,0 @@ -{{- $regex := .Get 0 -}} -{{- $color := .Get 1 | default "green" -}} -{{- $elReplace := print "$0" -}} -{{- $code := .Inner | markdownify -}} -{{- $codeCallout := replaceRE $regex $elReplace $code -}} -{{ $codeCallout | safeHTML }} diff --git a/layouts/shortcodes/influxdb/host.html b/layouts/shortcodes/influxdb/host.html index 82f295ebca..41e257ce96 100644 --- a/layouts/shortcodes/influxdb/host.html +++ b/layouts/shortcodes/influxdb/host.html @@ -1,2 +1,2 @@ {{- $productData := partial "product/get-data.html" . -}} -{{ $productData.placeholder_host | default "localhost:8086" }} +{{ $productData.placeholder_host | default "localhost:8086" -}}