DOC-3179: restructure and add content to RedisInsight #28
Conversation
Co-authored-by: Rachel Elledge <86307637+rrelledge@users.noreply.github.com>
…179-dwdougherty Start branch doc-3179-dwdougherty with both doc-3100* and doc-3110* branch content in place.
* Update introduction.md * Update intro.md * Update intro.md * Update introduction.md * Update introduction.md * Update intro.md * Update learn-more.md * Update learn-more.md * Update learn-more.md * Update learn-more.md * Update learn-more.md * Update learn-more.md * Update learn-more.md * Update learn-more.md * Update learn-more.md * Update learn-more.md * Update learn-more.md * Update learn-more.md * Update learn-more.md * Update learn-more.md * Update learn-more.md
|
@LiorKogan Hi Lior. Would you mind reviewing the JSON, probabilistic, and time series content? |
|
could you please fix links inside markdown files? |
|
|
||
| A count-min sketch is used to determine the frequency of events in a stream. You can query the count-min sketch to get an estimate of the frequency of any given event. | ||
|
|
||
| You can initialize the count-min sketch and specify a width (the number of counters in each array) and depth (the number of counter-arrays). |
There was a problem hiding this comment.
These parameters mean nothing to the novice user. We should refer here to an external source that explains them.
There was a problem hiding this comment.
Please provide an external reference.
|
|
||
| ``` | ||
|
|
||
| You can also initialize a count-min sketch by providing an acceptable error rate and probability for inflated (over) count for your use case: |
|
|
||
| A Top-K maintains a list of *K* most frequently seen items. | ||
|
|
||
| To get started, initialize a Top-K with a width (the number of counters kept in each array), depth (the number of arrays), and decay (the probability of reducing a counter in an occupied bucket). |
There was a problem hiding this comment.
Please add a reference to an external source that explains these terms (or mention that such a source is given below)
There was a problem hiding this comment.
Please provide an external reference.
|
|
||
| All the Redis operations implemented by single commands are atomic, including those that operate on more complex data structures. So, when you use a command that modifies the value of a key, any concurrent operations will also succeed. | ||
|
|
||
| ## Key expiration |
There was a problem hiding this comment.
Why is key expiration explained under strings? It refers to any key in Redis and should appear under a separate section.
There was a problem hiding this comment.
@ViktarStarastsenka Do you want me to remove this section altogether?
src/manifest.json
Outdated
| "type": "internal-link", | ||
| "id": "ds-json-intro", | ||
| "label": "Introduction", | ||
| "summary": "Store, update, and retrieve JSON values in a Redis database, similar to any other Redis data type.", |
There was a problem hiding this comment.
@LiorKogan , @dwdougherty , can you please check the summary for:
- JSON
- Strings
- Hashes
- Lists
- Sets
- Sorted sets
- Time series
- Probabilistic data structures
An example is attached below. For grouped tutorials (JSON, probabilistic, time series) I added the summary only for introductions (the summary can be added only per file, not per folder), I think other file names are self-explaining.
There was a problem hiding this comment.
- A Redis JSON is a Redis data structure for storing, querying, and manipulating a single JSON document.
- A Redis string, the most basic Redis data type, holds a sequence of bytes.
- A Redis list is a linked list of string values, often used to implement stacks and queues.
- A Redis hash is a collection of fields, where each field is a name-value pair. Both name and value are strings.
- A Redis set is an unordered collection of unique strings.
- A Redis sorted set is a collection of unique strings, ordered by each string's associated score.
There was a problem hiding this comment.
@ViktarStarastsenka Can you please paste that time series and the probabilistic structures?
| "id": "sq-exact-match", | ||
| "label": "Exact match (TAG queries)", | ||
| "args": { | ||
| "path": "/sq/exact-match.md" |
There was a problem hiding this comment.
@dwdougherty , please check the summary for search and query.
An example is attached below. The summary can be added only per file, so I added it only for the "introduction" file to display some context for users to try it, other files, imo, should be self-explaining.
I'll also ask Adriano to review it once he accepts the invitation.
There was a problem hiding this comment.
@ViktarStarastsenka Did you mean to attach an example here?
There was a problem hiding this comment.
I actually see it attached, but just in case:
There was a problem hiding this comment.
Weird... it didn't show the first time.
This definitely needs Adriano's eyes.
There was a problem hiding this comment.
as a summary and titles adjustments I will suggest:
- Introduction: Enable Redis as your main database performing structured queries without compromising your performance and simplicity
- Exact Match (
TAG queries): matching values in your datasets' attributes for secondary index use cases - Full Text Search (
fuzzy, wildcard...): leveraging advanced text search capabilities such as fuzzy, wildcard, synonyms, etc...to retrieve the most relevant datasets - Range Queries (
numeric): query on numeric fields that returns the values that are in between a given start and end value, such as prices, dates - Geospatial Queries (remove): simple point-based queries and beyond including more complex geometries like polygons. This allows for a more nuanced and detailed querying of spatial data.
- Vector Search(remove): efficient retrieval of similar data points in a vector store, enabling advanced applications such as recommendation systems, image and video search, natural language processing, and anomaly detection
- Combined Queries(remove): combine different query terms and options to create more complex and nuanced queries.
- Analytics and transformative(remove): aggregations in Redis allow you you to group, sort, and modify your result data, extracting analytical insights from it.
- Semantic Search(remove): pre-filtering using different conditions and predicates combining with generated embeddings, finding similarity between them according with chosen algorithm
There was a problem hiding this comment.
please align the wording with the "redis voice" @dwdougherty
| "label": "Working with JSON", | ||
| "id": "tf-intro", | ||
| "label": "Introduction", | ||
| "summary": "Trigger and execute JavaScript functions in the Redis process.", |
There was a problem hiding this comment.
@dwdougherty , please check the summary for trigger and functions.
An example is attached below. The summary can be added only per file, so I added it only for the "introduction" file to display some context for users to try it, other files, imo, should be self-explaining.
I'll also ask Thomas to review it once he accepts the invitation.
There was a problem hiding this comment.
LGTM, but Thomas should give it a look.
DOC-3179: restructure and add tutorial content to RedisInsight. It's nearly all brand new content.