Adding functionality for the bloom module to have its commands displayed on the Valkey website #212
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.html
page which can be expanded by just adding any new folders we want to pull commands from. For thecommand-page.html
I 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.sh
to 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
Check List
--signoff
By submitting this pull request, I confirm that my contribution is made under the terms of the BSD-3-Clause License.