-
Notifications
You must be signed in to change notification settings - Fork 84
Adds valkey-json module commands documentation to the website. #243
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
@roshkhatri is it ready to be reviewed ? |
Not yet |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
josn.mset.md is missing.
commands/json.arrappend.md
Outdated
JSON.ARRAPPEND <key> <path> <json> [json ...] | ||
``` | ||
|
||
* key - required, Redis key of document type |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not a redis key
topics/data-types.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
JSON should be added in this file as well.
resp3_replies.json
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
JSON resp3 reply needs to be added.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
High level looks good. This PR needs to be rebased once the Bloom PR is merged.
This PR can be rebased now. The bloom changes are merged in. Also, the spellchecker needs to get addressed You can add words here ^ to ignore them |
aa08875
to
95e7da0
Compare
as well Signed-off-by: zackcam <[email protected]> Signed-off-by: Nikhil Manglore <[email protected]>
…to generate bloom man pages Signed-off-by: zackcam <[email protected]> Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: zackcam <[email protected]> Signed-off-by: Nikhil Manglore <[email protected]>
…creation and spelling Signed-off-by: zackcam <[email protected]> Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: zackcam <[email protected]> Signed-off-by: Nikhil Manglore <[email protected]>
Making changes based on review comments Co-authored-by: KarthikSubbarao <[email protected]> Signed-off-by: zackcam <[email protected]> Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: zackcam <[email protected]> Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: Roshan Khatri <[email protected]> Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: Roshan Khatri <[email protected]> Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: Roshan Khatri <[email protected]>
Signed-off-by: Roshan Khatri <[email protected]>
LGTM now, I tested all the paths mentions manually to make sure everything work. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mostly looks good. Some minor comments.
Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: Roshan Khatri <[email protected]>
Signed-off-by: Roshan Khatri <[email protected]>
Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: Roshan Khatri <[email protected]>
@Nikhil-Manglore and I have update the PR PTAL and comment if needs anymore changes |
Signed-off-by: Nikhil Manglore <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds documentation for the valkey-json module commands to the website.
- Introduces markdown files for each new JSON command (e.g., JSON.RESP, JSON.OBJLEN, JSON.NUMMULTBY) with detailed examples.
- Updates the README to include the new VALKEY_JSON_ROOT and mentions the optional access to the valkey-json repo.
Reviewed Changes
Copilot reviewed 31 out of 32 changed files in this pull request and generated 2 comments.
Show a summary per file
File | Description |
---|---|
commands/json.resp.md | New documentation for JSON.RESP command with examples. |
commands/json.objlen.md | New documentation for JSON.OBJLEN command with usage examples. |
commands/json.objkeys.md | New examples for JSON.OBJKEYS command. |
commands/json.nummultby.md | Documentation for multiplying JSON numbers with NUMMULTBY. |
commands/json.numincrby.md | Documentation for incrementing JSON numbers with NUMINCRBY. |
commands/json.mset.md | Documentation for atomic multi-key JSON set with MSET. |
commands/json.mget.md | Documentation for multi-key JSON get with MGET. |
commands/json.get.md | JSON.GET command documentation with enhanced/restricted examples. |
commands/json.forget.md | Documentation for aliasing JSON.FORGET to JSON.DEL. |
commands/json.del.md | Documentation for deleting JSON values (JSON.DEL) with examples. |
commands/json.debug.md | Documentation for the JSON.DEBUG subcommands. |
commands/json.clear.md | Documentation for clearing JSON arrays/objects at a path. |
commands/json.arrtrim.md | Documentation for trimming JSON arrays with ARRTRIM. |
commands/json.arrpop.md | Documentation for popping JSON array values with ARRPOP. |
commands/json.arrlen.md | Documentation for getting the length of JSON arrays with ARRLEN. |
commands/json.arrinsert.md | Documentation for inserting into JSON arrays using ARRINSERT. |
commands/json.arrindex.md | Documentation for finding an element index in JSON arrays. |
commands/json.arrappend.md | Documentation for appending elements to JSON arrays with ARRAPPEND. |
README.md | README update to include new VALKEY_JSON_ROOT instructions. |
Files not reviewed (1)
- Makefile: Language not supported
Co-authored-by: Madelyn Olson <[email protected]> Signed-off-by: Nikhil Manglore <[email protected]>
Co-authored-by: Copilot <[email protected]> Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: Madelyn Olson <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, just waiting on Roshan to double check the doc build still works as expected.
Signed-off-by: Roshan Khatri <[email protected]>
Signed-off-by: Roshan Khatri <[email protected]>
The doc build now works as expected. |
One of the three PRs Required for module documentation to be included on the website
Related PRs:
valkey-io/valkey-json#42
Will wait for valkey-io/valkey-io.github.io#212 to het merged so we can use the framework to display documentation
We have merged the bloom changes in PR too as it depends on that, we would only review the changes related to JSON for this PR