Adding functionality for the JSON module to have commands displayed on the Valkey Website

.github/workflows/zola-deploy.yml

@@ -40,11 +40,17 @@ jobs:
             repository: valkey-io/valkey-bloom
             path: valkey-bloom
 
+      - name: Checkout valkey-json
+        uses: actions/checkout@v4
+        with:
+            repository: valkey-io/valkey-json
+            path: valkey-json
+
       - name: Init commands, topics and clients
         run: |
           cd website
           ./build/init-topics-and-clients.sh ../valkey-doc/topics ../valkey-doc/clients
-          ./build/init-commands.sh ../valkey-doc/commands ../valkey/src/commands ../valkey-bloom/src/commands
+          ./build/init-commands.sh ../valkey-doc/commands ../valkey/src/commands ../valkey-bloom/src/commands ../valkey-json/commands
 
       - name: Build only
         uses: shalzz/[email protected]

README.md

@@ -1,7 +1,7 @@
 # Valkey.io website
 
 This repo contains the source for the valkey.io website (build scripts, template, blog posts, stylesheets, etc.).
-The build integrates content from [`valkey-io/valkey-doc`](https://github.com/valkey-io/valkey-doc) and the commands definitions from [`valkey-io/valkey`](https://github.com/valkey-io/valkey) and [`valkey-io/valkey-bloom`](https://github.com/valkey-io/valkey-bloom) (see [Build Locally](#build-locally) below for more details).
+The build integrates content from [`valkey-io/valkey-doc`](https://github.com/valkey-io/valkey-doc) and the commands definitions from [`valkey-io/valkey`](https://github.com/valkey-io/valkey), [`valkey-io/valkey-bloom`](https://github.com/valkey-io/valkey-bloom), and [`valkey-io/valkey-json`](https://github.com/valkey-io/valkey-json) (see [Build Locally](#build-locally) below for more details) 
 
 ## Contributing
 
@@ -64,7 +64,7 @@ Commit your changes to your local copy of `valkey-io/valkey-doc`.
 ### Building the command reference
 
 The command reference (i.e. `/commands/set/`, `/commands/get/`, `/commands/lolwut/`) sources information from `valkey-io/valkey`, `valkey-io/valkey-bloom`, and `valkey-io/valkey-doc`.
-`valkey-io/valkey` and `valkey-io/valkey-bloom` provides the command metadata (items like computational complexity, version history, arguments, etc) whilst `valkey-io/valkey-doc` provides the command description and the command reply.
+`valkey-io/valkey`, `valkey-io/valkey-bloom` and `valkey-io/valkey-json` provides the command metadata (items like computational complexity, version history, arguments, etc) whilst `valkey-io/valkey-doc` provides the command description and the command reply.
 
 ```mermaid
 flowchart TD
@@ -75,13 +75,13 @@ flowchart TD
     H --> J[Files: /resp2_replies.json,<br/>/resp3_replies.json] --> Z[Command Reply]
 ```
 
-Let's say that this repo and your local copy of `valkey-io/valkey-doc`, `valkey-io/valkey-bloom` and `valkey-io/valkey` reside in the same directories.
+Let's say that this repo and your local copy of `valkey-io/valkey-doc`, `valkey-io/valkey-bloom`, `valkey-io/valkey-json`, and `valkey-io/valkey` reside in the same directories.
 First, stop the `zola serve` process if you're running it.
 From the root directory of this repo run:
 
 ```shell
 # You should only need to run this once or when you add a new command.
-./build/init-commands.sh ../valkey-doc/commands ../valkey/src/commands ../valkey-bloom/src/commands
+./build/init-commands.sh ../valkey-doc/commands ../valkey/src/commands ../valkey-bloom/src/commands ../valkey-json/src/commands
 ```
 
 Then, restart Zola.

build-json-command-json

@@ -0,0 +1 @@
+../valkey-json/src/commands

build/init-commands.sh

@@ -29,9 +29,15 @@ if [ ! -d "$3" ]; then
     exit 1
 fi
 
+if [ ! -d "$4" ]; then
+    echo "The JSON module command JSON directory must exist and be a valid path"
+    exit 1
+fi
+
 ln -s $1 ./build-command-docs
 ln -s $2 ./build-command-json
 ln -s $3 ./build-bloom-command-json
+ln -s $4 ./build-json-command-json
 for fname in $(find $1 -maxdepth 1  -iname "*.md")
 do
     base=${fname##*/}
@@ -42,6 +48,8 @@ do
             metadata_path="/commands/$command.json in the 'valkey' repo"
         elif [ -f "$3/$command.json" ]; then
             metadata_path="/commands/$command.json in the 'valkey-bloom' repo"
+        elif [ -f "$4/$command.json" ]; then
+            metadata_path="/commands/$command.json in the 'valkey-json' repo"
         fi
         cat << EOF > "./content/commands/$command.md"
 +++

config.toml

@@ -22,6 +22,7 @@ highlight_code = true
 command_description_path = "../build-command-docs/"
 command_json_path = "../build-command-json/"
 command_bloom_json_path = "../build-bloom-command-json/"
+command_json_json_path = "../build-json-command-json/"
 client_json_path = "../build-clients/"
 doc_topic_path = "../build-topics/"
 

templates/command-page.html

@@ -9,7 +9,8 @@
 {% set command_description = load_data(path=config.extra.command_description_path ~ page.slug ~ ".md", required= false) %}
 {% set command_sources = [
     load_data(path= commands::command_json_path(slug= page.slug), required= false),
-    load_data(path= commands::command_bloom_json_path(slug= page.slug), required= false)
+    load_data(path= commands::command_bloom_json_path(slug= page.slug), required= false),
+    load_data(path= commands::command_json_json_path(slug= page.slug), required= false)
 ] %}
 
 {% set command_data = command_sources | filter(attribute="") | first %}
@@ -60,6 +61,10 @@
             {% set module_reply = load_data(path="../_data/modules.json", required=false) -%}
             <dt>Module:</dt>
             <dd><a href={{module_reply.valkey_bloom.repo}}>{{module_reply.valkey_bloom.name}}</a></dd>
+        {% elif "json." in page.slug %}
+            {% set module_reply = load_data(path="../_data/modules.json", required=false) -%}
+            <dt>Module:</dt>
+            <dd><a href={{module_reply.valkey_json.repo}}>{{module_reply.valkey_json.name}}</a></dd>
         {% endif %}
     <dl>
     <dl>

templates/commands.html

@@ -18,7 +18,8 @@
 {% for page in section.pages %}
     {% for json_path in [
         commands::command_json_path(slug=page.slug),
-        commands::command_bloom_json_path(slug=page.slug)
+        commands::command_bloom_json_path(slug=page.slug),
+        commands::command_json_json_path(slug=page.slug)
     ] %}
         {% set command_data = load_data(path= json_path, required= false) %}
         {% if command_data %}

templates/macros/command.html

@@ -56,6 +56,10 @@
 {{config.extra.command_bloom_json_path }}{{ slug }}.json
 {%- endmacro load_bloom_command_json -%}
 
+{%- macro command_json_json_path(slug) -%}
+{{config.extra.command_json_json_path }}{{ slug }}.json
+{%- endmacro load_json_command_json -%}
+
 {%- macro fix_links(content) -%}
 {{ content
     | regex_replace(pattern=`\]\(\.\./topics/(?P<fname>.*?).md#(?P<hash>.*?)\)`, rep=`](/topics/$fname#$hash)`)