Skip to content

Commit 289b05a

Browse files
authored
Merge branch 'valkey-io:main' into main
2 parents 07539ee + 54bd9a5 commit 289b05a

File tree

15 files changed

+172
-60
lines changed

15 files changed

+172
-60
lines changed

.github/workflows/zola-deploy.yml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,17 @@ jobs:
4040
repository: valkey-io/valkey-bloom
4141
path: valkey-bloom
4242

43+
- name: Checkout valkey-json
44+
uses: actions/checkout@v4
45+
with:
46+
repository: valkey-io/valkey-json
47+
path: valkey-json
48+
4349
- name: Init commands, topics and clients
4450
run: |
4551
cd website
4652
./build/init-topics-and-clients.sh ../valkey-doc/topics ../valkey-doc/clients
47-
./build/init-commands.sh ../valkey-doc/commands ../valkey/src/commands ../valkey-bloom/src/commands
53+
./build/init-commands.sh ../valkey-doc/commands ../valkey/src/commands ../valkey-bloom/src/commands ../valkey-json/src/commands
4854
4955
- name: Build only
5056
uses: shalzz/[email protected]

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Valkey.io website
22

33
This repo contains the source for the valkey.io website (build scripts, template, blog posts, stylesheets, etc.).
4-
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).
4+
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)
55

66
## Contributing
77

@@ -64,7 +64,7 @@ Commit your changes to your local copy of `valkey-io/valkey-doc`.
6464
### Building the command reference
6565

6666
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`.
67-
`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.
67+
`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.
6868

6969
```mermaid
7070
flowchart TD
@@ -75,13 +75,13 @@ flowchart TD
7575
H --> J[Files: /resp2_replies.json,<br/>/resp3_replies.json] --> Z[Command Reply]
7676
```
7777

78-
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.
78+
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.
7979
First, stop the `zola serve` process if you're running it.
8080
From the root directory of this repo run:
8181

8282
```shell
8383
# You should only need to run this once or when you add a new command.
84-
./build/init-commands.sh ../valkey-doc/commands ../valkey/src/commands ../valkey-bloom/src/commands
84+
./build/init-commands.sh ../valkey-doc/commands ../valkey/src/commands ../valkey-bloom/src/commands ../valkey-json/src/commands
8585
```
8686

8787
Then, restart Zola.

build-json-command-json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../valkey-json/src/commands

build/init-commands.sh

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,15 @@ if [ ! -d "$3" ]; then
2929
exit 1
3030
fi
3131

32+
if [ ! -d "$4" ]; then
33+
echo "The JSON module command JSON directory must exist and be a valid path"
34+
exit 1
35+
fi
36+
3237
ln -s $1 ./build-command-docs
3338
ln -s $2 ./build-command-json
3439
ln -s $3 ./build-bloom-command-json
40+
ln -s $4 ./build-json-command-json
3541
for fname in $(find $1 -maxdepth 1 -iname "*.md")
3642
do
3743
base=${fname##*/}
@@ -42,6 +48,8 @@ do
4248
metadata_path="/commands/$command.json in the 'valkey' repo"
4349
elif [ -f "$3/$command.json" ]; then
4450
metadata_path="/commands/$command.json in the 'valkey-bloom' repo"
51+
elif [ -f "$4/$command.json" ]; then
52+
metadata_path="/commands/$command.json in the 'valkey-json' repo"
4553
fi
4654
cat << EOF > "./content/commands/$command.md"
4755
+++

config.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ highlight_code = true
2222
command_description_path = "../build-command-docs/"
2323
command_json_path = "../build-command-json/"
2424
command_bloom_json_path = "../build-bloom-command-json/"
25+
command_json_json_path = "../build-json-command-json/"
2526
client_json_path = "../build-clients/"
2627
doc_topic_path = "../build-topics/"
2728

sass/_valkey.scss

Lines changed: 78 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -345,33 +345,81 @@ p {
345345
}
346346

347347
.footer {
348-
border-top: 1px solid $grey-dk-100;
349-
background-color: $grey-lt-300;
348+
background-color: #1a2026;
350349
@include sans-serif;
351350
font-size: 1.4rem;
351+
color: #fff;
352+
padding: 2rem 0;
353+
354+
.icon-links {
355+
display: flex;
356+
flex-direction: column;
357+
gap: 15px;
358+
359+
@include respond-min(768px) {
360+
flex-direction: row;
361+
border: none;
362+
}
363+
364+
a {
365+
display: flex;
366+
align-items: center;
367+
color: #fff;
368+
369+
&:hover {
370+
color: #fff;
371+
text-decoration: underline;
372+
opacity: 0.8;
373+
}
374+
375+
img {
376+
margin-right: 5px;
377+
}
378+
}
379+
380+
}
352381

353382
.links {
354383
display: flex;
355-
flex-flow: row nowrap;
356-
justify-content: space-evenly;
357-
margin-bottom: 4em;
384+
flex-direction: column;
385+
gap: 15px;
386+
justify-content: flex-end;
387+
border-top: 1px solid rgba(255, 255, 255, 0.08);
388+
margin-top: 2rem;
389+
padding-top: 2rem;
390+
391+
@include respond-min(768px) {
392+
flex-direction: row;
393+
border: none;
394+
margin-top: 0;
395+
padding-top: 0;
396+
}
397+
398+
a {
399+
color: #fff;
400+
text-decoration: underline;
401+
402+
&:hover {
403+
opacity: 0.8;
404+
}
405+
}
358406
}
359407

360-
nav {
361-
font-size: 1.5rem;
362-
font-weight: 600;
408+
&_bottom {
409+
width: 100%;
410+
margin-top: 2rem;
411+
padding: 2rem;
363412

364-
h4 {
365-
font-weight: 400;
366-
@include sans-serif;
367-
font-size: 1.5rem;
413+
border-top: 1px solid rgba(255, 255, 255, 0.08);
414+
text-align: center;
415+
416+
p {
417+
max-width: 720px;
418+
margin: 8px auto;
368419
}
369420

370421
a {
371-
display: list-item;
372-
list-style: none;
373-
white-space: nowrap;
374-
margin-bottom: 1em;
422+
color: #6983ff;
375423

376424
&:hover {
377425
text-decoration: underline;
@@ -410,28 +458,35 @@ p {
410458

411459
.col {
412460
flex: 1 1 100%;
413-
padding: 0 2rem;
461+
padding-left: 2rem;
462+
padding-right: 2rem;
414463
}
415464

416465
.col-10 {
417-
flex: 1 1 83.33%;
466+
@include respond-min(768px) {
467+
flex: 1 1 83.33%;
468+
}
418469
}
419470

420471
.col-8 {
421-
flex: 1 1 66.66%;
472+
@include respond-min(768px) {
473+
flex: 1 1 66.66%;
474+
}
422475
}
423476

424477
.col-6 {
425-
flex: 1 1 50%;
478+
@include respond-min(768px) {
479+
flex: 1 1 50%;
480+
}
426481
}
427482

428483
.col-4 {
429-
flex: 1 1 33.33%;
484+
@include respond-min(768px) {
485+
flex: 1 1 33.33%;
486+
}
430487
}
431488

432489
.col_3 {
433-
flex: 1 1 100%;
434-
435490
@include respond-min(768px) {
436491
flex: 1 1 25%;
437492
}

static/img/IconGithub.svg

Lines changed: 3 additions & 0 deletions
Loading

static/img/IconLinkedin.svg

Lines changed: 3 additions & 0 deletions
Loading

static/img/IconMail.svg

Lines changed: 3 additions & 0 deletions
Loading

static/img/IconSlack.svg

Lines changed: 3 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)