feat: refactor valkey-docs clients/ directory #66

SoulPancake · 2024-04-25T18:12:45Z

Fixes #18

Signed-off-by: Anuragkillswitch <70265851+Anuragkillswitch@users.noreply.github.com>

SoulPancake · 2024-04-25T18:13:34Z

Mostly automated, @zuiderkwast
I have just revised it a little thinking of not modifying the description for redis stack ones
Can you take a look

SoulPancake · 2024-04-25T18:14:25Z

I will do some manual self-reviews

zuiderkwast

@SoulPancake Thanks!

We obviously can't change their names and their websites. I commented on those in the diff. (You have probably already fixed some of my comments.)

I'm starting to wonder whether it's a good idea just changing Redis to Valkey in these description.

@valkey-io/core-team We need to make a decision about what to do with these client descriptions.

The descriptions are changed to be mostly like this:

"name": "vRedis",
"description": "Valkey client using VB.NET.",

All of them probably work for Valkey, but they were originally written for Redis. They have Redis in their names and probably in their API.

I don't really know what we should do about then, but I'm considering some alternatives:

Change like this PR does, i.e. to say they're all Valkey clients
Keep the descriptions. They're Redis clients according to their authors. We can write on the webpage where we list all these Redis clients also work with Valkey. When there are clients which have Valkey in their names and APIs, then we can call those Valkey clients.
Write that they are Redis clients that also work for Valkey, in each client's description. (This may require more manual work to make sure the grammar is correct.)

Please advice.

zuiderkwast · 2024-04-25T18:55:56Z

clients/activex-com/gitlab.com/erik4/redis-com-client.json

@@ -1,6 +1,6 @@
 {
    "name": "Redis COM client",
-    "description": "A COM wrapper for StackExchange.Redis that allows using Redis from a COM environment like Classic ASP (ASP 3.0) using vbscript, jscript or any other COM capable language.",
+    "description": "A COM wrapper for StackExchange.Valkey that allows using Valkey from a COM environment like Classic ASP (ASP 3.0) using vbscript, jscript or any other COM capable language.",


StackExchange.Redis is the name of another client. I think you need to exclude Redis preceded by a dot.

zuiderkwast · 2024-04-25T18:59:14Z

clients/ballerina/github.com/ballerina-platform/module-ballerinax-redis.json

@@ -1,6 +1,6 @@
 {
    "name": "Ballerina Redis Client",
-    "description": "Official Redis client for Ballerina language with the support for Redis clusters, connection pooling and secure connections.",
+    "description": "Official Valkey client for Ballerina language with the support for Valkey clusters, connection pooling and secure connections.",


I don't think it's an "official valkey client". They themselves say it's a Redis client.

zuiderkwast · 2024-04-25T18:59:34Z

clients/bash/github.com/SomajitDey/redis-client.json

@@ -1,4 +1,4 @@
 {
    "name": "redis-client",
-    "description": "extensible client library for Bash scripting or command-line + connection pooling + redis-cli"
+    "description": "extensible client library for Bash scripting or command-line + connection pooling + valkey-cli"


This one provides a bash script that's actually called redis-cli.

zuiderkwast · 2024-04-25T19:02:46Z

clients/clojure/github.com/ptaoussanis/carmine.json

@@ -1,6 +1,6 @@
 {
    "name": "carmine",
-    "description": "Simple, high-performance Redis (2.0+) client for Clojure.",
+    "description": "Simple, high-performance Valkey (2.0+) client for Clojure.",


There is no Valkey 2.0. It probably works also for Redis so that's what they mean here. I'm not sure, maybe we can say it's a client for Valkey and Redis 2.0+.

zuiderkwast · 2024-04-25T19:04:02Z

clients/d/github.com/adilbaig/Tiny-Redis.json

-    "name": "Tiny Redis",
-    "description": "A Redis client for D2. Supports pipelining, transactions and Lua scripting",
-    "homepage": "http://adilbaig.github.io/Tiny-Redis/",
+    "name": "Tiny Valkey",


We can't change their name.

zuiderkwast · 2024-04-25T19:11:30Z

clients/python/github.com/AWS/GLIDE-for-Redis.json

@@ -1,4 +1,4 @@
 {
    "name": "GLIDE for Redis",
-    "description": "General Language Independent Driver for the Enterprise (GLIDE) for Redis is an advanced multi-language Redis client that is feature rich, highly performant, and built for reliability and operational stability. GLIDE for Redis is supported by AWS."
+    "description": "General Language Independent Driver for the Enterprise (GLIDE) for Valkey is an advanced multi-language Valkey client that is feature rich, highly performant, and built for reliability and operational stability. GLIDE for Valkey is supported by AWS."


Their name is "GLIDE for Redis", also inside the description.

zuiderkwast · 2024-04-25T19:12:22Z

clients/r/bitbucket.org/cmbce/r-package-rediscli.json

@@ -1,6 +1,6 @@
 {
    "name": "RedisCli",
-    "description": "Basic client passing a (batch of) command(s) to redis-cli, getting back a (list of) character vector(s).",
+    "description": "Basic client passing a (batch of) command(s) to valkey-cli, getting back a (list of) character vector(s).",


Are you sure it is actually passing commands to valkey-cli? I think valkey-cli didn't exist when this client was written.

zuiderkwast · 2024-04-25T19:12:47Z

clients/ruby/github.com/redis-rb/redis-client.json

@@ -1,4 +1,4 @@
 {
    "name": "redis-client",
-    "description": "Simple low level client for Redis 6+"
+    "description": "Simple low level client for Valkey 6+"


There's no Valkey 6

zuiderkwast · 2024-04-25T19:12:52Z

clients/ruby/github.com/redis-rb/redis-cluster-client.json

@@ -1,4 +1,4 @@
 {
    "name": "redis-cluster-client",
-    "description": "A simple client for Redis 6+ cluster"
+    "description": "A simple client for Valkey 6+ cluster"


There's no Valkey 6

zuiderkwast · 2024-04-25T19:13:40Z

clients/zig/github.com/kristoff-it/zig-okredis.json

@@ -1,6 +1,6 @@
 {
    "name": "OkRedis",
-    "description": "OkRedis is a zero-allocation client for Redis 6+ ",
+    "description": "OkRedis is a zero-allocation client for Valkey 6+ ",


There's no Valkey 6

SoulPancake · 2024-04-25T20:20:46Z

Should we mention Redis OSS in-place of Redis in these descriptions and add Valkey additionally to them?

enjoy-binbin

Write that they are Redis clients that also work for Valkey, in each client's description. (This may require more manual work to make sure the grammar is correct.)

I personally prefer this.

SoulPancake · 2024-04-26T14:16:10Z

A good bet for an automated way for this is

Not touch the names and names in descriptions ( will manually review once )
Let the description stay as it is but add " This is a Redis client that also works for Valkey."

What do you think?
Obviously a round of manual review can ensure there are no unexpected changes like my previous commit @zuiderkwast @enjoy-binbin

import os
import json

def modify_description(data):
    description = data['description']
    if 'valkey' in description.lower() or 'redis' in description.lower():
        if 'redis' in description.lower():
            additional_text = " This is a Redis client that also works for Valkey."
            if additional_text not in description:
                description += additional_text
        data['description'] = description
    return data

def process_json_files(directory):
    for root, dirs, files in os.walk(directory):
        for file in files:
            if file.endswith('.json'):
                file_path = os.path.join(root, file)
                with open(file_path, 'r+') as f:
                    data = json.load(f)
                    modified_data = modify_description(data)
                    f.seek(0)        # reset file position to the beginning.
                    json.dump(modified_data, f, indent=4)
                    f.truncate()     # remove remaining part of old data

zuiderkwast · 2024-04-26T19:46:24Z

I think adding "This is a Redis client that also works for Valkey." for every client is a little repetitive. We can just write at the top of the client list page that all Redis clients work with Valkey.

SoulPancake · 2024-04-26T19:49:13Z

Yea that's fair
In that case, we can essentially discard all changes here @zuiderkwast

zuiderkwast · 2024-04-26T21:05:54Z

In that case, we can essentially discard all changes here

Yes, but can you leave this PR open to wait for other peoples opinions?

feat: refactor valkey-docs clients/ directory

ab1e527

Signed-off-by: Anuragkillswitch <70265851+Anuragkillswitch@users.noreply.github.com>

zuiderkwast requested changes Apr 25, 2024

View reviewed changes

enjoy-binbin reviewed Apr 26, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: refactor valkey-docs clients/ directory #66

feat: refactor valkey-docs clients/ directory #66

SoulPancake commented Apr 25, 2024

SoulPancake commented Apr 25, 2024

SoulPancake commented Apr 25, 2024

zuiderkwast left a comment

zuiderkwast Apr 25, 2024

zuiderkwast Apr 25, 2024

zuiderkwast Apr 25, 2024

zuiderkwast Apr 25, 2024

zuiderkwast Apr 25, 2024

zuiderkwast Apr 25, 2024

zuiderkwast Apr 25, 2024

zuiderkwast Apr 25, 2024

zuiderkwast Apr 25, 2024

zuiderkwast Apr 25, 2024

SoulPancake commented Apr 25, 2024

enjoy-binbin left a comment

SoulPancake commented Apr 26, 2024

zuiderkwast commented Apr 26, 2024

SoulPancake commented Apr 26, 2024

zuiderkwast commented Apr 26, 2024

feat: refactor valkey-docs clients/ directory #66

Are you sure you want to change the base?

feat: refactor valkey-docs clients/ directory #66

Conversation

SoulPancake commented Apr 25, 2024

SoulPancake commented Apr 25, 2024

SoulPancake commented Apr 25, 2024

zuiderkwast left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SoulPancake commented Apr 25, 2024

enjoy-binbin left a comment

Choose a reason for hiding this comment

SoulPancake commented Apr 26, 2024

zuiderkwast commented Apr 26, 2024

SoulPancake commented Apr 26, 2024

zuiderkwast commented Apr 26, 2024