Skip to content

Add overwritten and type_changed KSN types to docs #1781

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

Closed
wants to merge 10 commits into from

Conversation

minchopaskal
Copy link
Contributor

Adding docs for the following PR: redis/redis#14141

Description

Added new keyspace notification event types

  • overwritten
  • type_changed

Updated docs for KSN and module KSN

mich-elle-luna and others added 8 commits June 24, 2025 10:57
- Add proper sizing and font weights to h3-h6 headings
- H3: text-xl (20px) + font-semibold for clear section breaks
- H4: text-lg (18px) + font-medium for subsections
- H5: text-base (16px) + font-medium for minor headings
- H6: text-sm (14px) + font-medium for smallest headings
- Consolidate duplicate h1 rules into single declaration
- Maintain existing h1 and h2 styling that works well

Fixes issue where h3 and h4 headings didn't look like proper headings on the site.
- Document that writing to destination (passive) replica causes data inconsistency
- Explain eviction/expiration only operates on active replica
- Detail memory management conflicts and replication failures
- Provide proper steps for transitioning passive to active database
- Include warning about syncer exit due to command failures

Addresses DOC-824
Co-authored-by: Rachel Elledge <86307637+rrelledge@users.noreply.github.com>
Improve heading 3 and heading 4 styles for better visual hierarchy
Add Active-Passive replication warnings to data eviction policies
@dwdougherty
Copy link
Collaborator

dwdougherty commented Jul 1, 2025

Hi @minchopaskal. Making changes directly to the modules-api-ref.md file won't work, as this file is generated from source code using the redis/redis:utils/generate-module-api-doc.rb script. You'll have to make changes to the Redis source code directly to modify API doc content. We run the API doc script every release, so any local changes will be overwritten.

Is the KSN page change for 8.2?

@minchopaskal
Copy link
Contributor Author

Ah, yes module docs are generated, I forgot. Docs are updated in the source code in the PR.

As for if this will be for 8.2 I have to defer to @YaacovHazan

Copy link
Collaborator

@dwdougherty dwdougherty left a comment

Choose a reason for hiding this comment

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

Just a couple of grammar fixes. Otherwise, LGTM.

@dwdougherty dwdougherty changed the base branch from main to feat-ros-8.2 July 1, 2025 16:47
@dwdougherty
Copy link
Collaborator

Closing. See this new PR.

@dwdougherty dwdougherty closed this Jul 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants