Adding functionality for the bloom module to have its commands displayed on the Valkey website #212
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…yed on the valkey website Signed-off-by: zackcam <[email protected]>
Signed-off-by: zackcam <[email protected]>
hpatro
approved these changes
Mar 29, 2025
KarthikSubbarao
approved these changes
Mar 31, 2025
madolson
reviewed
Apr 1, 2025
madolson
approved these changes
Apr 2, 2025
madolson
added a commit
to valkey-io/valkey-doc
that referenced
this pull request
Apr 29, 2025
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 --------- 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: Madelyn Olson <[email protected]> Co-authored-by: zackcam <[email protected]> Co-authored-by: KarthikSubbarao <[email protected]> Co-authored-by: Nikhil Manglore <[email protected]> Co-authored-by: Nikhil Manglore <[email protected]> Co-authored-by: Madelyn Olson <[email protected]> Co-authored-by: Copilot <[email protected]>
madolson
pushed a commit
that referenced
this pull request
Apr 29, 2025
…n the Valkey Website (#230) ### Description This PR will add the JSON commands on the Valkey website. Note that this PR was created off of a branch of the [bloom filter documentation PR](#212). Merge conflicts will occur if that PR needs to be changed so I will update accordingly. Example: <img width="958" alt="Screenshot 2025-04-02 at 5 10 01 PM" src="https://github.com/user-attachments/assets/0e4e7b6f-6a82-4757-a70f-e320dc9cae00" /> ### Check List - [ X] Commits are signed per the DCO using `--signoff` By submitting this pull request, I confirm that my contribution is made under the terms of the BSD-3-Clause License. --------- Signed-off-by: zackcam <[email protected]> Signed-off-by: Nikhil Manglore <[email protected]> Signed-off-by: Nikhil Manglore <[email protected]> Co-authored-by: zackcam <[email protected]>
zarkash-aws
pushed a commit
to zarkash-aws/valkey-io.github.io
that referenced
this pull request
Jun 12, 2025
…n the Valkey Website (valkey-io#230) ### Description This PR will add the JSON commands on the Valkey website. Note that this PR was created off of a branch of the [bloom filter documentation PR](valkey-io#212). Merge conflicts will occur if that PR needs to be changed so I will update accordingly. Example: <img width="958" alt="Screenshot 2025-04-02 at 5 10 01 PM" src="https://github.com/user-attachments/assets/0e4e7b6f-6a82-4757-a70f-e320dc9cae00" /> ### Check List - [ X] Commits are signed per the DCO using `--signoff` By submitting this pull request, I confirm that my contribution is made under the terms of the BSD-3-Clause License. --------- Signed-off-by: zackcam <[email protected]> Signed-off-by: Nikhil Manglore <[email protected]> Signed-off-by: Nikhil Manglore <[email protected]> Co-authored-by: zackcam <[email protected]> Signed-off-by: Shai Zarka <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related PR's
Bloom repo json command files: valkey-io/valkey-bloom#47
Valkey-doc repo: valkey-io/valkey-doc#233
Description
This PR will allow set the framework so that modules can have their commands displayed on the valkey website (By adding the bloom module commands in a way that can be easily expanded on). I have tried to make this future proof by using a for loop on the
commands.htmlpage which can be expanded by just adding any new folders we want to pull commands from. For thecommand-page.htmlI have used an array to hold the data from the multiple folders with commands and then get the first occurrence that isn't empty (i.e the command belongs to that folder).This will keep ability so that if the command doesn't exist we still have the same fallback.
Updated the
init-commands.shto create a link for the bloom commands as well and take in the bloom repository.I have updated the README as well to include the new repo that will be needed for the commands and the information change associated with now expecting commands from the bloom repo.
Lastly updated the github workflow as well to also now build and take in the bloom repo
For screenshots of the new documentation the two pr's above (valkey-io/valkey-doc#233 and valkey-io/valkey-bloom#47) have screenshots of all sections being added
Check List
--signoffBy submitting this pull request, I confirm that my contribution is made under the terms of the BSD-3-Clause License.