From ab8e64238f3aa37b068df703d8f43dc0827d9cd5 Mon Sep 17 00:00:00 2001 From: Andy Stark Date: Thu, 5 Dec 2024 11:09:46 +0000 Subject: [PATCH 1/5] DOC-4623 attempted fix for tab issues --- build/components/example.py | 6 ++++++ config.toml | 8 ++++---- data/components/jedis.json | 8 ++++---- layouts/partials/tabbed-clients-example.html | 5 +++-- 4 files changed, 17 insertions(+), 10 deletions(-) diff --git a/build/components/example.py b/build/components/example.py index e2a0665924..855776dd1a 100644 --- a/build/components/example.py +++ b/build/components/example.py @@ -11,12 +11,18 @@ GO_OUTPUT = 'Output:' TEST_MARKER = { 'java': '@Test', + 'java-sync': '@Test', + 'java-async': '@Test', + 'java-reactive': '@Test', 'c#': '\[Fact\]|\[SkipIfRedis\(.*\)\]' } PREFIXES = { 'python': '#', 'node.js': '//', 'java': '//', + 'java-sync': '//', + 'java-async': '//', + 'java-reactive': '//', 'go': '//', 'c#': '//', 'redisvl': '#', diff --git a/config.toml b/config.toml index 3a7915a034..2602d4632d 100644 --- a/config.toml +++ b/config.toml @@ -45,7 +45,7 @@ tagManagerId = "GTM-TKZ6J9R" gitHubRepo = "https://github.com/redis/docs" # Display and sort order for client examples -clientsExamples = ["Python", "Node.js", "Java Sync", "Java Async", "Java Reactive", "Go", "C#", "RedisVL"] +clientsExamples = ["Python", "Node.js", "Java-Sync", "Java-Async", "Java-Reactive", "Go", "C#", "RedisVL"] searchService = "/convai/api/search-service" ratingsService = "/docusight/api/rate" @@ -59,9 +59,9 @@ rdi_cli_latest = "latest" [params.clientsConfig] "Python"={quickstartSlug="redis-py"} "Node.js"={quickstartSlug="nodejs"} -"Java sync"={quickstartSlug="jedis"} -"Java async"={quickstartSlug="lettuce"} -"Java reactive"={quickstartSlug="lettuce"} +"Java-sync"={quickstartSlug="jedis"} +"Java-async"={quickstartSlug="lettuce"} +"Java-reactive"={quickstartSlug="lettuce"} "Go"={quickstartSlug="go"} "C#"={quickstartSlug="dotnet"} "RedisVL"={quickstartSlug="redis-vl"} diff --git a/data/components/jedis.json b/data/components/jedis.json index 4aa154ab51..81bde0758d 100644 --- a/data/components/jedis.json +++ b/data/components/jedis.json @@ -2,14 +2,14 @@ "id": "jedis", "type": "client", "name": "jedis", - "language": "Java", - "label": "Java Sync", + "language": "Java-Sync", + "label": "Java-Sync", "repository": { "git_uri": "https://github.com/redis/jedis" }, "examples": { - "git_uri": "https://github.com/redis/jedis", - "dev_branch": "master", + "git_uri": "/Users/andrew.stark/Documents/Repos/forks/jedis", + "dev_branch": "DOC-4560-trans-pipe-examples", "path": "src/test/java/io/redis/examples", "pattern": "*.java" } diff --git a/layouts/partials/tabbed-clients-example.html b/layouts/partials/tabbed-clients-example.html index af7b22e6b5..157f033ea2 100644 --- a/layouts/partials/tabbed-clients-example.html +++ b/layouts/partials/tabbed-clients-example.html @@ -21,11 +21,11 @@ {{ $clientConfig := index $.Site.Params.clientsconfig $client }} {{ $language := index $example "language" }} {{ $quickstartSlug := index $clientConfig "quickstartSlug" }} - + {{ if and ($example) (or (eq $lang "") (eq $lang $client)) }} {{ $examplePath := index $example "target" }} {{ $options := printf "linenos=false" }} - + {{ if and (ne $step "") (isset $example "named_steps") (isset $example.named_steps $step) }} {{ $options = printf "%s,hl_lines=%s" $options (index $example.named_steps $step) }} {{ else }} @@ -33,6 +33,7 @@ {{ $options = printf "%s,hl_lines=%s" $options (delimit (index $example "highlight") " ") }} {{ end }} {{ end }} + {{ if hasPrefix $language "java" }}{{ $language = "java"}}{{ end }} {{ $params := dict "language" $language "contentPath" $examplePath "options" $options }} {{ $content := partial "tabs/source.html" $params }} {{ $tabs = $tabs | append (dict "title" $client "language" $client "quickstartSlug" $quickstartSlug "content" $content "sourceUrl" (index $example "sourceUrl")) }} From 40e11e3f92f2af7b77143cdb5d009d53a7bda8ac Mon Sep 17 00:00:00 2001 From: Andy Stark Date: Thu, 5 Dec 2024 11:29:15 +0000 Subject: [PATCH 2/5] DOC-4623 replaced local repo details with Github URLs --- data/components/jedis.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/data/components/jedis.json b/data/components/jedis.json index 81bde0758d..c7486b6f92 100644 --- a/data/components/jedis.json +++ b/data/components/jedis.json @@ -8,8 +8,8 @@ "git_uri": "https://github.com/redis/jedis" }, "examples": { - "git_uri": "/Users/andrew.stark/Documents/Repos/forks/jedis", - "dev_branch": "DOC-4560-trans-pipe-examples", + "git_uri": "https://github.com/redis/jedis", + "dev_branch": "master", "path": "src/test/java/io/redis/examples", "pattern": "*.java" } From 6c14b19e1ed966f14e77c6823867c4ff055c120a Mon Sep 17 00:00:00 2001 From: Andy Stark Date: Thu, 5 Dec 2024 11:48:07 +0000 Subject: [PATCH 3/5] DOC-4623 fixed other Java client names --- data/components/lettuce_async.json | 4 ++-- data/components/lettuce_reactive.json | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/data/components/lettuce_async.json b/data/components/lettuce_async.json index cc860f75c3..6d14943832 100644 --- a/data/components/lettuce_async.json +++ b/data/components/lettuce_async.json @@ -2,8 +2,8 @@ "id": "lettuce_async", "type": "client", "name": "lettuce_async", - "language": "Java", - "label": "Java Async", + "language": "Java-Async", + "label": "Java-Async", "repository": { "git_uri": "https://github.com/redis/lettuce" }, diff --git a/data/components/lettuce_reactive.json b/data/components/lettuce_reactive.json index b79aa9880b..07e33adb55 100644 --- a/data/components/lettuce_reactive.json +++ b/data/components/lettuce_reactive.json @@ -2,8 +2,8 @@ "id": "lettuce_reactive", "type": "client", "name": "lettuce_reactive", - "language": "Java", - "label": "Java Reactive", + "language": "Java-Reactive", + "label": "Java-Reactive", "repository": { "git_uri": "https://github.com/redis/lettuce" }, From 35bb3737a65dc51776fb8bb0e734c3ff1a87318a Mon Sep 17 00:00:00 2001 From: Andy Stark Date: Thu, 5 Dec 2024 12:50:47 +0000 Subject: [PATCH 4/5] DOC-4623 try to fix non-sticky Node.js tab --- layouts/partials/tabs/wrapper.html | 1 + 1 file changed, 1 insertion(+) diff --git a/layouts/partials/tabs/wrapper.html b/layouts/partials/tabs/wrapper.html index 7cecc0514f..7611705b51 100644 --- a/layouts/partials/tabs/wrapper.html +++ b/layouts/partials/tabs/wrapper.html @@ -13,6 +13,7 @@ {{ $tid := printf "%s_%s" (replace (replace (index $tab "title") "#" "sharp") "." "") $id }} {{ $pid := printf "panel_%s" $tid }} {{ $dataLang := replace (or (index $tab "language") "redis-cli") "C#" "dotnet" }} + {{ $dataLang := replace $dataLang "." "-" }} From d59601b14eabe374cd3c8bc4b15938f3b83128f8 Mon Sep 17 00:00:00 2001 From: Andy Stark Date: Thu, 5 Dec 2024 13:22:18 +0000 Subject: [PATCH 5/5] DOC-4623 possible new formatting for tabs bar --- layouts/partials/tabs/wrapper.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/layouts/partials/tabs/wrapper.html b/layouts/partials/tabs/wrapper.html index 7611705b51..bf9c18e536 100644 --- a/layouts/partials/tabs/wrapper.html +++ b/layouts/partials/tabs/wrapper.html @@ -17,7 +17,7 @@ -