DEV: support both redis-py and redisvl in TCEs (#495)

* Support both redis-py and redisvl in the same TCE (part 1)

* Support both redis-py and redisvl in the same TCE (part 2)

Author: dwdougherty

build/components/example.py

@@ -19,6 +19,7 @@
     'java': '//',
     'go': '//',
     'c#': '//',
+    'redisvl': '#'
 }
 
 class Example(object):

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", "Go", "C#"]
+clientsExamples = ["Python", "Node.js", "Java", "Go", "C#", "RedisVL"]
 searchService = "/convai/api/search-service"
 ratingsService = "/docusight/api/rate"
 
@@ -56,6 +56,14 @@ rdi_debezium_server_version = "2.3.0.Final"
 rdi_db_types = "cassandra|mysql|oracle|postgresql|sqlserver"
 rdi_cli_latest = "latest"
 
+[params.clientsConfig]
+"Python"={lang="python", quickstartSlug="python/redis-py"}
+"Node.js"={lang="javascript", quickstartSlug="nodejs"}
+"Java"={lang="java", quickstartSlug="java/jedis"}
+"Go"={lang="go", quickstartSlug="go"}
+"C#"={lang="C#", quickstartSlug="dotnet"}
+"RedisVL"={lang="python", quickstartSlug="python/redis-vl"}
+
 # Markup
 [markup]
   [markup.goldmark]

content/develop/connect/clients/python/_index.md

@@ -0,0 +1,26 @@
+---
+categories:
+- docs
+- develop
+- stack
+- oss
+- rs
+- rc
+- oss
+- kubernetes
+- clients
+hideListLinks: true
+description: Connect your application to a Redis database using Python and try an example
+linkTitle: Python
+title: Connect with Redis Python clients
+weight: 4
+---
+
+You have two choices of Python clients that you can use with Redis:
+
+-   [Redis Python library (redis-py)]({{< relref "/develop/connect/clients/python/redis-py" >}})
+-   [Redis vector library (RedisVL)]({{< relref "/develop/connect/clients/python/redis-vl" >}})
+
+You can also access Redis with an object-mapping client interface. See
+[RedisOM for Python]({{< relref "/integrate/redisom-for-python" >}})
+for more information.

content/develop/connect/clients/python.md renamed to content/develop/connect/clients/python/redis-py.md

@@ -10,8 +10,8 @@ categories:
 - kubernetes
 - clients
 description: Connect your Python application to a Redis database
-linkTitle: Python
-title: Python guide
+linkTitle: Redis Python library
+title: Redis Python library guide
 weight: 1
 ---
 

content/develop/connect/clients/python/redis-vl.md

@@ -0,0 +1,18 @@
+---
+categories:
+- docs
+- develop
+- stack
+- oss
+- rs
+- rc
+- oss
+- kubernetes
+- clients
+description: Connect your Python vector application to a Redis vector database
+linkTitle: Redis vector library
+title: Redis vector library guide
+weight: 1
+---
+
+See the [RedisVL Guide]({{< relref "/integrate/redisvl" >}}) for more information.

data/components/index.json

@@ -11,7 +11,8 @@
         "go_redis",
         "node_redis",
         "redis_py",
-        "jedis"
+        "jedis",
+        "redis_vl"
     ],
     "assets": [],
     "_assets": [

data/components/redis_vl.json

@@ -0,0 +1,15 @@
+{
+    "id": "redisvl",
+    "type": "client",
+    "name": "RedisVL",
+    "language": "RedisVL",
+    "repository": {
+        "git_uri": "https://github.com/redis/redis-vl-python"
+    },
+    "examples": {
+        "git_uri": "https://github.com/redis/redis-vl-python",
+        "dev_branch": "main",
+        "path": "doctests",
+        "pattern": "*.py"
+    }
+}

layouts/partials/tabbed-clients-example.html

@@ -15,10 +15,14 @@
     {{ $tabs = $tabs | append (dict "title" "redis-cli" "content" $redisCliContent "limit" $redisCommandsLineLimit) }}
 {{ end }}
 
-{{ $languages := index $.Site.Data.examples $id }}
-{{ range $language := $.Site.Params.clientsexamples }}
-    {{ $example := index $languages $language }}
-    {{ if and ($example) (or (eq $lang "") (eq $lang $language)) }}
+{{ $clientExamples := index $.Site.Data.examples $id }}
+{{ range $client := $.Site.Params.clientsexamples }}
+    {{ $example := index $clientExamples $client }}
+    {{ $clientConfig := index $.Site.Params.clientsconfig $client }}
+    {{ $language := index $clientConfig "lang" }}
+    {{ $quickstartSlug := index $clientConfig "quickstartSlug" }}
+
+    {{ if and ($example) (or (eq $lang "") (eq $lang $client)) }}
         {{ $examplePath := index $example "target" }}
         {{ $options := printf "linenos=false" }}
 
@@ -31,7 +35,7 @@
         {{ end }}
         {{ $params := dict "language" $language "contentPath" $examplePath "options" $options }}
         {{ $content := partial "tabs/source.html" $params }}
-        {{ $tabs = $tabs | append (dict "title" $language "content" $content "sourceUrl" (index $example "sourceUrl")) }}
+        {{ $tabs = $tabs | append (dict "title" $client "language" $language "quickstartSlug" $quickstartSlug "content" $content "sourceUrl" (index $example "sourceUrl")) }}
     {{ end }}
 {{ end }}
 

layouts/partials/tabs/wrapper.html

@@ -12,8 +12,7 @@
     {{ range $i, $tab := $tabs }}
         {{ $tid := printf "%s_%s" (replace (replace (index $tab "title") "#" "sharp") "." "") $id }}
         {{ $pid := printf "panel_%s" $tid }}
-        {{ $quickStartSlug := (replace (replace (index $tab "title") "." "") "C#" "dotnet" | lower) }}
-        <input tabindex="1" type="radio" name="{{ $id }}" id="{{ $tid }}" data-lang="{{ $quickStartSlug }}" class="radiotab w-0 h-0"
+        <input tabindex="1" type="radio" name="{{ $id }}" id="{{ $tid }}" data-lang="{{ index $tab "language" }}" class="radiotab w-0 h-0"
                {{ if eq $i 0 }}checked{{ end }}
         />
         <label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900
@@ -72,7 +71,8 @@
                     </a>
                 </div>
             {{ else }}
-              <a href='/docs/develop/connect/clients/{{ $quickStartSlug }}/' tabindex="1" class="rounded rounded-mx px-3 py-1 text-white text-xs
+              <!--<a href='/docs/latest/develop/connect/clients/{{ index $tab "quickstartSlug" }}/' tabindex="1" class="rounded rounded-mx px-3 py-1 text-white text-xs-->
+              <a href='/develop/connect/clients/{{ index $tab "quickstartSlug" }}/' tabindex="1" class="rounded rounded-mx px-3 py-1 text-white text-xs
                                 hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none
                                 focus:ring-2 focus:white focus:border-slate-500" title="{{$btnQuickStartText}}">
                 {{ index $tab "title" }} {{ $btnQuickStartText }}