Skip to content

Creating a getting started guide for bloom #310

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

zackcam
Copy link
Contributor

@zackcam zackcam commented Jun 9, 2025

Adding a getting started guide for bloom filters

This 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 configurations

We 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 change

After 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.

@zackcam
Copy link
Contributor Author

zackcam commented Jun 9, 2025

The two spell check errors I think aren't correct: reproducibility is a word and spelled correctly, while pre-built should be hyphenated. If people agree I will add them to the excluded words list

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant