From 30f7495a72db19c0e8d56e66436139e1a966e803 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 13 May 2025 16:05:42 -0500 Subject: [PATCH 1/4] chore(hugo): Update shortcodes and templates to avoid calling isset on --- layouts/_default/page-list.json | 16 ++++++------ layouts/partials/article/flux-contrib.html | 2 +- .../partials/article/flux-experimental.html | 2 +- layouts/partials/article/tags.html | 4 +-- layouts/partials/header/title.html | 6 ++--- layouts/partials/sidebar/nested-menu.html | 14 +++++----- layouts/shortcodes/children.html | 26 +++++++++---------- layouts/shortcodes/icon.html | 6 ++++- layouts/shortcodes/nav-icon.html | 5 +++- 9 files changed, 44 insertions(+), 37 deletions(-) diff --git a/layouts/_default/page-list.json b/layouts/_default/page-list.json index 507009897..e40823ffa 100644 --- a/layouts/_default/page-list.json +++ b/layouts/_default/page-list.json @@ -8,49 +8,49 @@ {{- if $index -}},{{- end }} { "name": {{ .Name | jsonify }}, - "url": {{ absURL (cond (isset .Params "url") .Params.url .URL) | jsonify }}, + "url": {{ absURL (default .URL .Params.url) | jsonify }}, "children": [ {{- range $index, $entry := .Children -}} {{- if $index -}},{{- end }} { "name": {{ .Name | jsonify }}, - "url": {{ absURL (cond (isset .Params "url") .Params.url .URL) | jsonify }}, + "url": {{ absURL (default .URL .Params.url) | jsonify }}, "children": [ {{- range $index, $entry := .Children -}} {{- if $index -}},{{- end }} { "name": {{ .Name | jsonify }}, - "url": {{ absURL (cond (isset .Params "url") .Params.url .URL) | jsonify }}, + "url": {{ absURL (default .URL .Params.url) | jsonify }}, "children": [ {{- range $index, $entry := .Children -}} {{- if $index -}},{{- end }} { "name": {{ .Name | jsonify }}, - "url": {{ absURL (cond (isset .Params "url") .Params.url .URL) | jsonify }}, + "url": {{ absURL (default .URL .Params.url) | jsonify }}, "children": [ {{- range $index, $entry := .Children -}} {{- if $index -}},{{- end }} { "name": {{ .Name | jsonify }}, - "url": {{ absURL (cond (isset .Params "url") .Params.url .URL) | jsonify }}, + "url": {{ absURL (default .URL .Params.url) | jsonify }}, "children": [ {{- range $index, $entry := .Children -}} {{- if $index -}},{{- end }} { "name": {{ .Name | jsonify }}, - "url": {{ absURL (cond (isset .Params "url") .Params.url .URL) | jsonify }}, + "url": {{ absURL (default .URL .Params.url) | jsonify }}, "children": [ {{- range $index, $entry := .Children -}} {{- if $index -}},{{- end }} { "name": {{ .Name | jsonify }}, - "url": {{ absURL (cond (isset .Params "url") .Params.url .URL) | jsonify }}, + "url": {{ absURL (default .URL .Params.url) | jsonify }}, "children": [ {{- range $index, $entry := .Children -}} {{- if $index -}},{{- end }} { "name": {{ .Name | jsonify }}, - "url": {{ absURL (cond (isset .Params "url") .Params.url .URL) | jsonify }}, + "url": {{ absURL (default .URL .Params.url) | jsonify }}, "children": [ {{ range .Children }} {{ end }} diff --git a/layouts/partials/article/flux-contrib.html b/layouts/partials/article/flux-contrib.html index dbd317e1d..6a0d1c749 100644 --- a/layouts/partials/article/flux-contrib.html +++ b/layouts/partials/article/flux-contrib.html @@ -13,7 +13,7 @@ {{ else if eq .Kind "section" }}
- {{ $packageTitle := cond (isset .Params "list_title") $.Params.list_title .Title }} + {{ $packageTitle := default .Title .Params.list_title }} {{ $packageName := replaceRE `^(.*)( package)` "$1$2" $packageTitle }}

The {{ $packageName | safeHTML }} is a user-contributed package diff --git a/layouts/partials/article/flux-experimental.html b/layouts/partials/article/flux-experimental.html index 3f951abff..9c3b75c50 100644 --- a/layouts/partials/article/flux-experimental.html +++ b/layouts/partials/article/flux-experimental.html @@ -13,7 +13,7 @@

{{ else if eq .Kind "section" }}
- {{ $packageTitle := cond (isset .Params "list_title") $.Params.list_title .Title }} + {{ $packageTitle := default .Title .Params.list_title }} {{ $packageName := replaceRE `^(.*)( package)` "$1$2" $packageTitle }}

The {{ $packageName | safeHTML }} is experimental and subject to change at any time. diff --git a/layouts/partials/article/tags.html b/layouts/partials/article/tags.html index 60b2f48ca..4c297c861 100644 --- a/layouts/partials/article/tags.html +++ b/layouts/partials/article/tags.html @@ -2,9 +2,9 @@ {{ $product := index $productPathData 0 }} {{ $version := index $productPathData 1 }} {{ $tagSet := print $product "/" $version "/tags" }} -{{ if isset .Params $tagSet }} +{{ with .Param $tagSet }}

- {{ range .Param $tagSet }} + {{ range . }} {{ $name := . }} {{ with $.Site.GetPage (printf "/%s/%s" $tagSet ($name | urlize)) }} {{ $name }} diff --git a/layouts/partials/header/title.html b/layouts/partials/header/title.html index e6b1c8910..0ef890d79 100644 --- a/layouts/partials/header/title.html +++ b/layouts/partials/header/title.html @@ -35,10 +35,10 @@ {{ else if eq $currentVersion nil}} {{ $scratch.Set "siteTitle" (print (index .Site.Data.products $product).name " Documentation") }} {{ else }} - {{ if (isset (index .Site.Data.products $product) "altname" ) }} - {{ $scratch.Set "siteTitle" (print (index .Site.Data.products $product).altname " Documentation") }} + {{ with (index .Site.Data.products $product).altname }} + {{ $scratch.Set "siteTitle" (print . " Documentation") }} {{ else }} - {{ $scratch.Set "siteTitle" (print (index .Site.Data.products $product).name " Documentation") }} + {{ $scratch.Set "siteTitle" (print (index $.Site.Data.products $product).name " Documentation") }} {{ end }} {{ end }} diff --git a/layouts/partials/sidebar/nested-menu.html b/layouts/partials/sidebar/nested-menu.html index feceb9ea8..0083b2a3e 100644 --- a/layouts/partials/sidebar/nested-menu.html +++ b/layouts/partials/sidebar/nested-menu.html @@ -4,37 +4,37 @@ {{ range $menu }}
  • {{ if .HasChildren }}{{ end }} - {{ .Name }} + {{ .Name }} {{ if .HasChildren }}
      {{ range .Children }}
    • {{ if .HasChildren }}{{ end }} - {{ .Name }} + {{ .Name }} {{ if .HasChildren }}
        {{ range .Children }}
      • {{ if .HasChildren }}{{ end }} - {{ .Name }} + {{ .Name }} {{ if .HasChildren }}
          {{ range .Children }}
        • {{ if .HasChildren }}{{ end }} - {{ .Name }} + {{ .Name }} {{ if .HasChildren }}
            {{ range .Children }}
          • {{ if .HasChildren }}{{ end }} - {{ .Name }} + {{ .Name }} {{ if .HasChildren }}
              {{ range .Children }}
            • {{ if .HasChildren }}{{ end }} - {{ .Name }} + {{ .Name }} {{ if .HasChildren }} @@ -42,7 +42,7 @@ {{ range .Children }}
            • {{ if .HasChildren }}{{ end }} - {{ .Name }} + {{ .Name }}
              • {{ end }} diff --git a/layouts/shortcodes/children.html b/layouts/shortcodes/children.html index 58a57fd1f..1bea94f94 100644 --- a/layouts/shortcodes/children.html +++ b/layouts/shortcodes/children.html @@ -18,9 +18,9 @@ {{ if eq $type "articles" }}
              {{ range $pages.ByWeight }} - {{ $title := cond ( isset .Params "list_title" ) (.Params.list_title | .RenderString) (.Title | .RenderString) }} - {{ $url := cond ( isset .Params "external_url" ) .Params.external_url .RelPermalink }} - {{ $target := cond ( isset .Params "external_url" ) "_blank" "" }} + {{ $title := default .Title .Params.list_title | .RenderString }} + {{ $url := default .RelPermalink .Params.external_url }} + {{ $target := cond (ne .Params.external_url nil) "_blank" "" }} {{ if eq $hlevel "h2"}}

              {{ $title }}

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

              {{ $title }}

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

              {{ $title }}

              @@ -69,7 +69,7 @@ {{ end }} {{ end }} - {{ if and (eq $readMore true) ( or (isset .Params "list_query_example") (isset .Params "list_code_example") ) }} + {{ if and (eq $readMore true) (or .Params.list_query_example .Params.list_code_example) }}

              Read more

              {{ end }} {{ if eq $hr true }} @@ -94,10 +94,10 @@
                {{ range $pages.ByWeight }} - {{ $title := cond ( isset .Params "list_title" ) (.Params.list_title | .RenderString) (.Title | .RenderString) }} - {{ $url := cond ( isset .Params "external_url" ) .Params.external_url .RelPermalink }} - {{ $target := cond ( isset .Params "external_url" ) "_blank" "" }} - {{ $note := cond ( isset .Params "list_note" ) (print "" .Params.list_note "") "" }} + {{ $title := default .Title .Params.list_title | .RenderString }} + {{ $url := default .RelPermalink .Params.external_url }} + {{ $target := cond (ne .Params.external_url nil) "_blank" "" }} + {{ $note := cond (ne .Params.list_note nil) (print "" .Params.list_note "") "" }}
              • {{ $title }} {{ $note | markdownify }}
                • {{ end }}
              @@ -108,10 +108,10 @@
                {{ range $pages.ByWeight }} - {{ $title := cond ( isset .Params "list_title" ) (.Params.list_title | .RenderString) (.Title | .RenderString)}} - {{ $url := cond ( isset .Params "external_url" ) .Params.external_url .RelPermalink }} - {{ $target := cond ( isset .Params "external_url" ) "_blank" "" }} - {{ $note := cond ( isset .Params "list_note" ) (print "" .Params.list_note "") "" }} + {{ $title := default .Title .Params.list_title | .RenderString}} + {{ $url := default .RelPermalink .Params.external_url }} + {{ $target := cond (ne .Params.external_url nil) "_blank" "" }} + {{ $note := cond (ne .Params.list_note nil) (print "" .Params.list_note "") "" }}
              1. {{ $title }} {{ $note | markdownify }}
                2. {{ end }}
              @@ -121,7 +121,7 @@
                {{ range $pages.ByWeight }} - {{ $title := cond ( isset .Params "list_title" ) (.Params.list_title | .RenderString) (.Title | .RenderString) }} + {{ $title := default .Title .Params.list_title | .RenderString }}
              • {{ $title }}
                • {{ end }}
              diff --git a/layouts/shortcodes/icon.html b/layouts/shortcodes/icon.html index 31da61945..1a386cc68 100644 --- a/layouts/shortcodes/icon.html +++ b/layouts/shortcodes/icon.html @@ -3,7 +3,11 @@ {{- $productPathData := findRE "[^/]+.*?" .Page.RelPermalink -}} {{- $product := index $productPathData 0 -}} {{- $productVersion := index $productPathData 1 | default "v0.0" -}} -{{- $defaultClockface := cond (isset (index .Site.Data.clockface $product) $productVersion) (index (index .Site.Data.clockface $product) $productVersion) (index (index .Site.Data.clockface $product) "default") }} + +{{- $defaultClockface := "" -}} +{{- with (index .Site.Data.clockface $product) -}} + {{- $defaultClockface = index . (cond (isset . $productVersion) $productVersion "default") -}} +{{- end -}} {{- $version := .Get 1 | default $defaultClockface -}} {{- if eq $version "v2" -}} diff --git a/layouts/shortcodes/nav-icon.html b/layouts/shortcodes/nav-icon.html index e81bfaef5..8b794b030 100644 --- a/layouts/shortcodes/nav-icon.html +++ b/layouts/shortcodes/nav-icon.html @@ -2,7 +2,10 @@ {{- $productPathData := findRE "[^/]+.*?" .Page.RelPermalink -}} {{- $product := index $productPathData 0 -}} {{- $productVersion := index $productPathData 1 | default "v0" -}} -{{- $defaultClockface := cond (isset (index .Site.Data.clockface $product) $productVersion) (index (index .Site.Data.clockface $product) $productVersion) (index (index .Site.Data.clockface $product) "default") }} +{{- $defaultClockface := "" -}} +{{- with (index .Site.Data.clockface $product) -}} + {{- $defaultClockface = default (index . "default") (index . $productVersion) -}} +{{- end -}} {{- $version := .Get 1 | default $defaultClockface -}} {{ if eq $version "v2" }} From bf6c9ab4b300f644e5e167d23c60f22f27d3fa40 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Mon, 19 May 2025 18:05:55 -0500 Subject: [PATCH 2/4] hotfix(clustered): fix product name and remove dupe file --- .../admin/tokens/database/revoke 2.md | 56 ------------------- .../clustered/admin/tokens/database/revoke.md | 2 +- 2 files changed, 1 insertion(+), 57 deletions(-) delete mode 100644 content/influxdb3/clustered/admin/tokens/database/revoke 2.md diff --git a/content/influxdb3/clustered/admin/tokens/database/revoke 2.md b/content/influxdb3/clustered/admin/tokens/database/revoke 2.md deleted file mode 100644 index 90a3a71c9..000000000 --- a/content/influxdb3/clustered/admin/tokens/database/revoke 2.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: Revoke a database token -description: > - Use the [`influxctl token revoke` command](/influxdb3/clustered/reference/cli/influxctl/token/revoke/) - to revoke a token from your InfluxDB cluster and disable all - permissions associated with the token. - Provide the ID of the token you want to revoke. -menu: - influxdb3_clustered: - parent: Database tokens -weight: 203 -list_code_example: | - ```sh - influxctl token revoke - ``` -aliases: - - /influxdb3/clustered/admin/tokens/delete/ - - /influxdb3/clustered/admin/tokens/database/delete/ ---- - -Use the [`influxctl token revoke` command](/influxdb3/clustered/reference/cli/influxctl/token/revoke/) -to revoke a database token from your {{< product-name omit=" Clustered" >}} cluster and disable -all permissions associated with the token. - -1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/#download-and-install-influxctl). -2. Run the [`influxctl token list` command](/influxdb3/clustered/reference/cli/influxctl/token/list) - to output tokens with their IDs. - Copy the **token ID** of the token you want to delete. - - ```sh - influxctl token list - ``` - -3. Run the `influxctl token revoke` command and provide the following: - - - Token ID to revoke - -4. Confirm that you want to revoke the token. - -{{% code-placeholders "TOKEN_ID" %}} -```sh -influxctl token revoke TOKEN_ID -``` -{{% /code-placeholders %}} - -> [!Warning] -> #### Revoking a token is immediate and cannot be undone -> -> Revoking a database token is a destructive action that takes place immediately -> and cannot be undone. -> -> #### Rotate revoked tokens -> -> After revoking a database token, any clients using the revoked token need to -> be updated with a new database token to continue to interact with your -> {{% product-name omit=" Clustered" %}} cluster. diff --git a/content/influxdb3/clustered/admin/tokens/database/revoke.md b/content/influxdb3/clustered/admin/tokens/database/revoke.md index a197d0192..90a3a71c9 100644 --- a/content/influxdb3/clustered/admin/tokens/database/revoke.md +++ b/content/influxdb3/clustered/admin/tokens/database/revoke.md @@ -19,7 +19,7 @@ aliases: --- Use the [`influxctl token revoke` command](/influxdb3/clustered/reference/cli/influxctl/token/revoke/) -to revoke a database token from your InfluxDB cluster and disable +to revoke a database token from your {{< product-name omit=" Clustered" >}} cluster and disable all permissions associated with the token. 1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/#download-and-install-influxctl). From e90e513f4769947355779755ccb14f7fff71209d Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 20 May 2025 09:35:08 -0500 Subject: [PATCH 3/4] chore(mono): update latest to 3.0.3 --- data/products.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/data/products.yml b/data/products.yml index c65516953..47c2d258e 100644 --- a/data/products.yml +++ b/data/products.yml @@ -6,7 +6,7 @@ influxdb3_core: versions: [core] list_order: 2 latest: core - latest_patch: 3.0.1 + latest_patch: 3.0.3 placeholder_host: localhost:8181 ai_sample_questions: - How do I install and run InfluxDB 3 Core? @@ -21,7 +21,7 @@ influxdb3_enterprise: versions: [enterprise] list_order: 2 latest: enterprise - latest_patch: 3.0.1 + latest_patch: 3.0.3 placeholder_host: localhost:8181 ai_sample_questions: - How do I install and run InfluxDB 3 Enterprise? From b79269b11a6439028e54d492aacfcd955c66314d Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 20 May 2025 11:10:38 -0500 Subject: [PATCH 4/4] fix(ent3): Remove 'enterprise' from /api/v3/configure/token/admin endpoint --- .../enterprise/admin/tokens/admin/create.md | 2 +- .../influxdb3-admin/tokens/admin/create.md | 11 ---------- .../tokens/admin/regenerate.md | 20 +------------------ 3 files changed, 2 insertions(+), 31 deletions(-) diff --git a/content/influxdb3/enterprise/admin/tokens/admin/create.md b/content/influxdb3/enterprise/admin/tokens/admin/create.md index c073c622d..64530b6ef 100644 --- a/content/influxdb3/enterprise/admin/tokens/admin/create.md +++ b/content/influxdb3/enterprise/admin/tokens/admin/create.md @@ -16,7 +16,7 @@ list_code_example: | ``` #### HTTP API ```bash - curl -X POST "http://{{< influxdb/host >}}/api/v3/enterprise/configure/token/admin" \ + curl -X POST "http://{{< influxdb/host >}}/api/v3/configure/token/admin" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' ``` diff --git a/content/shared/influxdb3-admin/tokens/admin/create.md b/content/shared/influxdb3-admin/tokens/admin/create.md index cba3c7def..093d5091a 100644 --- a/content/shared/influxdb3-admin/tokens/admin/create.md +++ b/content/shared/influxdb3-admin/tokens/admin/create.md @@ -35,7 +35,6 @@ across sessions, assign the token string to the `INFLUXDB3_AUTH_TOKEN` environme {{% tab-content %}} Use the following endpoint to create an admin token: -{{% show-in "core" %}} {{% api-endpoint method="POST" endpoint="/api/v3/configure/token/admin" api-ref="/influxdb3/version/api/v3/#operation/PostCreateAdminToken" %}} ```bash @@ -43,15 +42,5 @@ curl -X POST "http://{{< influxdb/host >}}/api/v3/configure/token/admin" \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' ``` -{{% /show-in %}} -{{% show-in "enterprise" %}} -{{% api-endpoint method="POST" endpoint="/api/v3/enterprise/configure/token/admin" api-ref="/influxdb3/version/api/v3/#operation/PostCreateAdminToken" %}} - -```bash -curl -X POST "http://{{< influxdb/host >}}/api/v3/{{< product-key >}}/configure/token/admin" \ ---header 'Accept: application/json' \ ---header 'Content-Type: application/json' -``` -{{% /show-in %}} {{% /tab-content %}} {{< /tabs-wrapper >}} diff --git a/content/shared/influxdb3-admin/tokens/admin/regenerate.md b/content/shared/influxdb3-admin/tokens/admin/regenerate.md index 8ab8b0b0e..d7c3f194e 100644 --- a/content/shared/influxdb3-admin/tokens/admin/regenerate.md +++ b/content/shared/influxdb3-admin/tokens/admin/regenerate.md @@ -56,36 +56,18 @@ The output contains the new token string and InfluxDB deactivates the previous t Use the following HTTP API endpoint: -{{% show-in "core" %}} {{% api-endpoint method="POST" endpoint="/api/v3/configure/token/admin/regenerate" api-ref="/influxdb3/version/api/v3/configure/token/admin/regenerate" %}} -{{% /show-in %}} - -{{% show-in "enterprise" %}} -{{% api-endpoint method="POST" endpoint="/api/v3/enterprise/configure/token/admin/regenerate" api-ref="/influxdb3/version/api/v3/enterprise/configure/token/admin" %}} -{{% /show-in %}} In your request, send an `Authorization` header with your current admin token string --for example: -{{% show-in "core" %}} {{% code-placeholders "ADMIN_TOKEN" %}} ```bash -curl -X POST "http://{{< influxdb/host >}}/api/v3/configure/token/admin" \ +curl -X POST "http://{{< influxdb/host >}}/api/v3/configure/token/admin/regenerate" \ --header "Authorization: Bearer ADMIN_TOKEN" \ --header "Accept: application/json" ``` {{% /code-placeholders %}} -{{% /show-in %}} - -{{% show-in "enterprise" %}} -{{% code-placeholders "ADMIN_TOKEN" %}} -```bash -curl -X POST "http://{{< influxdb/host >}}/api/v3/enterprise/configure/token/admin" \ - --header "Authorization: Bearer ADMIN_TOKEN" \ - --header "Accept: application/json" -``` -{{% /code-placeholders %}} -{{% /show-in %}} In your command, replace {{% code-placeholder-key %}}`ADMIN_TOKEN`{{% /code-placeholder-key %}} with the current token string.