Skip to content

Add documentation for Hash Fields Expiration#347

Merged
zuiderkwast merged 22 commits into
valkey-io:mainfrom
ranshid:hash-field-expiraiton
Sep 5, 2025
Merged

Add documentation for Hash Fields Expiration#347
zuiderkwast merged 22 commits into
valkey-io:mainfrom
ranshid:hash-field-expiraiton

Conversation

@ranshid

@ranshid ranshid commented Aug 11, 2025

Copy link
Copy Markdown
Member

related to: valkey-io/valkey#2089

Signed-off-by: Ran Shidlansik <ranshid@amazon.com>
@ranshid

ranshid commented Aug 11, 2025

Copy link
Copy Markdown
Member Author

@valkey-io/core-team PTAL

@zuiderkwast zuiderkwast left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A first pass on this. Great docs in general!

Comment thread commands/hexpire.md Outdated
Comment thread commands/hexpire.md Outdated
Comment thread commands/hexpireat.md Outdated
Comment thread commands/hexpiretime.md Outdated
Comment thread commands/hexpiretime.md Outdated
Comment thread topics/notifications.md Outdated
Comment thread topics/notifications.md Outdated
Signed-off-by: Ran Shidlansik <ranshid@amazon.com>
Comment thread commands/hexpireat.md Outdated
Comment thread commands/hpexpire.md Outdated
Comment thread commands/hgetex.md Outdated
Comment thread commands/hpexpireat.md Outdated
ranshid and others added 2 commits August 11, 2025 17:33
Co-authored-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
Signed-off-by: Ran Shidlansik <ranshid@amazon.com>
Signed-off-by: Ran Shidlansik <ranshid@amazon.com>
Comment thread commands/hgetex.md Outdated
Co-authored-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
Signed-off-by: Ran Shidlansik <ranshid@amazon.com>
Comment thread commands/hexpire.md Outdated
Comment thread commands/hexpire.md Outdated
Comment thread commands/hexpire.md Outdated
Comment thread commands/hexpire.md Outdated
Comment thread commands/hexpire.md Outdated
Comment thread commands/hpersist.md Outdated
Comment thread commands/hgetex.md Outdated
Comment thread commands/hgetex.md Outdated
Comment thread commands/hexpiretime.md Outdated
Comment thread commands/hexpireat.md Outdated
ranshid and others added 9 commits August 12, 2025 07:26
Co-authored-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Ran Shidlansik <ranshid@amazon.com>
Co-authored-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Ran Shidlansik <ranshid@amazon.com>
Co-authored-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Ran Shidlansik <ranshid@amazon.com>
Co-authored-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Ran Shidlansik <ranshid@amazon.com>
Co-authored-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Ran Shidlansik <ranshid@amazon.com>
Co-authored-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Ran Shidlansik <ranshid@amazon.com>
Signed-off-by: Ran Shidlansik <ranshid@amazon.com>
Signed-off-by: Ran Shidlansik <ranshid@amazon.com>

@jsoref jsoref left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Generally which is doesn't add anything
  • Generally in case can be written as if (in case of emergency is an exception -- as we don't write if of...)

Comment thread commands/hpersist.md Outdated
Comment thread commands/hpexpire.md Outdated
Comment thread topics/notifications.md Outdated
Comment thread topics/notifications.md Outdated
Comment thread topics/notifications.md Outdated
Comment thread commands/hexpire.md Outdated
Comment thread topics/hashes.md Outdated
Co-authored-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
Co-authored-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Ran Shidlansik <ranshid@amazon.com>
@madolson madolson moved this to In Progress in Valkey 9.0 Aug 20, 2025

@madolson madolson left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly seems good to me.

Comment thread topics/hashes.md Outdated
Comment thread topics/hashes.md Outdated
Comment thread topics/hashes.md Outdated
Comment thread topics/hashes.md Outdated
Comment thread topics/notifications.md Outdated
Comment thread commands/hexpiretime.md Outdated
Comment thread commands/hexpire.md Outdated
Comment thread commands/hgetex.md Outdated
Comment thread commands/hexpireat.md Outdated
Comment thread commands/hgetex.md Outdated
ranshid and others added 4 commits August 26, 2025 08:47
Co-authored-by: Madelyn Olson <madelyneolson@gmail.com>
Signed-off-by: Ran Shidlansik <ranshid@amazon.com>
Signed-off-by: Ran Shidlansik <ranshid@amazon.com>
Signed-off-by: Ran Shidlansik <ranshid@amazon.com>

@zuiderkwast zuiderkwast left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Skimmed through the last changes. Some nits, but I think this is good enough to be merged. It's a lot of text and it can probably be polished further, but we can also improve it later.

Comment thread commands/hexpiretime.md Outdated
Comment thread topics/hashes.md Outdated

@zuiderkwast zuiderkwast left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Posted link fixes. Links from topics to commands need relative path.

Comment thread topics/hashes.md Outdated
Comment thread topics/hashes.md Outdated
Comment thread topics/hashes.md Outdated
Co-authored-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
Signed-off-by: Ran Shidlansik <ranshid@amazon.com>
@zuiderkwast

zuiderkwast commented Sep 4, 2025

Copy link
Copy Markdown
Contributor

I created a CI job to check for broken links: #355

If we merge that first, we can use it to verify this PR too, before we merge it. Can you approve it? (It just runs an existing script. I used that script earlier when we refactored the docs at the dawn of Valkey.)

@zuiderkwast zuiderkwast merged commit eb68ad8 into valkey-io:main Sep 5, 2025
@github-project-automation github-project-automation Bot moved this from In Progress to Done in Valkey 9.0 Sep 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants