Creating a getting started guide for bloom #310
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.
Adding a getting started guide for bloom filtersThis will include the following:- Manual Building / installation (Valkey Server start up + Module Load)- Valkey Extension Docker based startup- Examples of executing bloom commands- Snippet of executing bloom commands using a python script with valkey-py- Snippet / examples of using bloom configurationsWe will need to decide where we will show getting started guides as currently they are quite hidden in documentation. But for now I have put under tutorials and FAQ. If we want a more explicit/obvious place let me know and i will look at making that changeAfter discussion we have decided to move the getting started information from a separate page.
The sections we will now include is a tutorial, and a better explanation of the configs for bloom filter. We will save the extension and python example for separate pages that are yet to be created. When they are created I can add the sections from before to them.