Category: Usage

moonglum commented

2024-03-30 15:54:51 +01:00

Owner

One thing that always frustrated me about the Redis documentation is that there are some really interesting patterns, but they are pretty hidden. I want us to promote them to a more prominent page in our documentation on redict.io. Let's put a “Usage” category in the navigation next to commands and modules. I would then remove the pattern from the command documentation, and instead link from the command to the pattern.

Patterns that have documentation:

Accessing the entire bitmap, Setting multiple Bits and Accessing Bitmap Ranges (commands/setbit.md)
Bulk Loading (docs/manual/patterns/bulk-loading.md)
Circular list (commands/rpoplpush.md, commands/lmove.md, commands/brpoplpush.md, and commands/blmove.md)
Counter (commands/incr.md)
Distributed Locks (docs/manual/patterns/distributed-locks.md)
Navigation session (commands/expire.md)
Rate Limiter in three variants (commands/incr.md)
Real-time Metrics using Bitmaps (commands/bitcount.md and commands/bitop.md)
Reliable queue (commands/rpoplpush.md, commands/lmove.md, commands/brpoplpush.md, and commands/blmove.md)
Secondary Indexing (docs/manual/patterns/indexes/index.md)
Time series (commands/append.md)
Twitter Clone (docs/manual/patterns/twitter-clone.md)
Weighted Random Selection of an Element (commands/zrangebyscore.md)

Happy to work on that, if we agree that this is a good idea. It also raises the question if I can just create those files in the redict.io repo, and remove them here.

One thing that always frustrated me about the Redis documentation is that there are some really interesting patterns, but they are pretty hidden. I want us to promote them to a more prominent page in our documentation on redict.io. Let's put a “Usage” category in the navigation next to commands and modules. I would then remove the pattern from the command documentation, and instead link from the command to the pattern. Patterns that have documentation: - [ ] Accessing the entire bitmap, Setting multiple Bits and Accessing Bitmap Ranges (`commands/setbit.md`) - [x] Bulk Loading (`docs/manual/patterns/bulk-loading.md`) - [ ] Circular list (`commands/rpoplpush.md`, `commands/lmove.md`, `commands/brpoplpush.md`, and `commands/blmove.md`) - [ ] Counter (`commands/incr.md`) - [x] Distributed Locks (`docs/manual/patterns/distributed-locks.md`) - [ ] Navigation session (`commands/expire.md`) - [ ] Rate Limiter in three variants (`commands/incr.md`) - [ ] Real-time Metrics using Bitmaps (`commands/bitcount.md` and `commands/bitop.md`) - [ ] Reliable queue (`commands/rpoplpush.md`, `commands/lmove.md`, `commands/brpoplpush.md`, and `commands/blmove.md`) - [x] Secondary Indexing (`docs/manual/patterns/indexes/index.md`) - [ ] Time series (`commands/append.md`) - [x] Twitter Clone (`docs/manual/patterns/twitter-clone.md`) - [ ] Weighted Random Selection of an Element (`commands/zrangebyscore.md`) Happy to work on that, if we agree that this is a good idea. It also raises the question if I can just create those files in the redict.io repo, and remove them here.