Skip to content

DOC-5423: update the modules API page #1815

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 49 commits into from
Jul 7, 2025
Merged

DOC-5423: update the modules API page #1815

merged 49 commits into from
Jul 7, 2025

Conversation

dwdougherty
Copy link
Collaborator

@dwdougherty dwdougherty commented Jul 7, 2025 •
edited by jira bot
Loading

DOC-5423

There's nothing to review because this page is 100% generated from the redis/redis source code.

mich-elle-luna and others added 30 commits June 24, 2025 14:47
@mich-elle-luna
Improve rack-awareness documentation for Kubernetes
212c490 
- Add clear explanation of node labeling requirements for rack-awareness
- Emphasize that ALL eligible nodes must be labeled with chosen label
- Explain what eligible nodes are (nodes where RS pods can be scheduled)
- Suggest topology.kubernetes.io/zone as commonly available label
- Clarify that not all platforms have this label by default
- Update example to use current topology.kubernetes.io/zone instead of deprecated failure-domain.beta.kubernetes.io/zone
- Fix kubectl command formatting (add space after $)
- Add warning about operator failing if nodes are missing labels

Addresses DOC-1815
@mich-elle-luna @kaitlynmichael
Update content/operate/kubernetes/recommendations/node-selection.md
5f32e7a 
Co-authored-by: Kaitlyn Michael <[email protected]>
@mich-elle-luna @kaitlynmichael
Update content/operate/kubernetes/recommendations/node-selection.md
078f889 
Co-authored-by: Kaitlyn Michael <[email protected]>
@mich-elle-luna @kaitlynmichael
Update content/operate/kubernetes/recommendations/node-selection.md
4c60c23 
Co-authored-by: Kaitlyn Michael <[email protected]>
@mich-elle-luna @kaitlynmichael
Update content/operate/kubernetes/recommendations/node-selection.md
a2852d0 
Co-authored-by: Kaitlyn Michael <[email protected]>
@mich-elle-luna @kaitlynmichael
Update content/operate/kubernetes/recommendations/node-selection.md
d8f5200 
Co-authored-by: Kaitlyn Michael <[email protected]>
@paoloredis
Move redisvl documentation
4364b53
@paoloredis
Remove type integration
87060b7
@paoloredis
Add redisvl/_index.md
8996b22
@paoloredis
Fix relrefs
8aa37d3
@paoloredis
Add aliases
42b76a1
@paoloredis
Add missing aliases
0bba322
@andy-stark-redis
DOC-3967 moved/expanded keyspace page
bbd1b4c
@andy-stark-redis
DOC-3967 fixed links to keyspace page
46d364f
@andy-stark-redis
DOC-3967 moved transaction and pipeline pages to reference section
6ab6b8e
@andy-stark-redis
DOC-3967 moved patterns folder to clients
126e26f
@andy-stark-redis
DOC-3967 moved programmability folder into develop
ed9f7e6
@andy-stark-redis
DOC-3967 fixed links to programmability section
9380383
@andy-stark-redis
DOC-3967 added aliases to programmability pages
1f03dab
@andy-stark-redis
DOC-3967 moved pub/sub and keyspace notification pages
a3cd67a
@andy-stark-redis
DOC-3967 added missing aliases
9fde689
@cmilesb
RDI: Add Reboot step after parameter group step
427bf18
@mich-elle-luna
Merge pull request #1770 from redis/DOC-5395
4175764 
Move redisvl documentation
@kaitlynmichael @rrelledge
add link icon to section headers (#1755)
d165cb7 
* add link icon to section headers

* review suggestions

* toc embed fix

* Attempt to fix the broken on this page ToC for embedded content that includes headers

---------

Co-authored-by: Rachel Elledge <[email protected]>
@mich-elle-luna
Merge branch 'main' into DOC-1815
6f7d4ee
@kaitlynmichael
mention admission controller (#1791)
0a4da35
@mich-elle-luna
Merge pull request #1753 from redis/DOC-1815
d16adb1 
Improve rack-awareness documentation for Kubernetes
@kaitlynmichael
relref fix (#1793)
14e07ac
@redisdocsapp
Update content/operate/rc/api/api-reference/openapi.json
c59627b
@andy-stark-redis
Merge pull request #1784 from redis/DOC-3967-sidebar-improvements
21a3638 
DOC-3967 sidebar improvements
DevRockstarZ and others added 19 commits July 2, 2025 06:28
@DevRockstarZ
fix typo (#1795)
f184901
@andy-stark-redis
DOC-5419 added commands section
32fc680
@andy-stark-redis
DOC-5419 fixed dodgy link
63c57cf
@cmilesb
Merge pull request #1786 from redis/add-reboot-step
e5632d9 
RDI: Add Reboot step after parameter group step
@cmilesb
Merge pull request #1794 from redis/rc_api_sync
41a63d1 
update rc openapi spec
@rrelledge
RS: Adjusted best practices for scalable Redis query engine & add ben…
75c0df4 
…chmarks (#1687)

* DOC-4271 RS: Adjusted best practices for scalable Redis query engine & add benchmarks

* Style guide fix for indexes

* Fixed broken relrefs after AI/search reorg
@rrelledge
RS: Added missing module requirements to recover DB (#1679)
6623a74 
* DOC-4564 RS: Added missing module requirements to recover DB

* DOC-4564 Added rladmin command to identify module versions required by recoverable DBs

* DOC-4564 Copied missing module requirements to recover DB to RS 7.4 and 7.8 versions
@rrelledge
RS: Added DB port access requirement for Replica Of between different…
c159d32 
… RS clusters (#1650)

* DOC-3829 RS: Added DB port access requirement for Replica Of between different RS clusters

* Updated relrefs to correct versions
@mich-elle-luna
Update ai-videos.md
f0044e2
@mich-elle-luna
Fix search-and-query documentation aliases for backward compatibility
6f1b0af 
## Critical alias fixes to resolve 404 errors and incorrect redirects:

### Fixed broken basic-constructs aliases:
- field-and-type-options.md: Fixed alias to point to correct interact paths
- schema-definition.md: Fixed alias to point to correct interact paths
- configuration.md: Added missing interact aliases and fixed format

### Fixed directory redirect issues (_index.md files):
- Added trailing slash variants for all directory aliases
- Fixed indexing/ and query/ URLs that were redirecting to home page
- Updated: _index.md, indexing/_index.md, query/_index.md, advanced-concepts/_index.md, administration/_index.md, best-practices/_index.md, deprecated/_index.md

### Added missing aliases:
- index-mgmt-best-practices.md: Added missing interact alias
- aggregations-syntax.md: Added missing interact alias

### Root causes addressed:
- Aliases were incorrectly pointing to /ai/ paths instead of /interact/ paths
- Directory aliases needed both with/without trailing slash variants
- Some files missing interact aliases entirely

These fixes should resolve:
- 404 errors on basic-constructs URLs
- Directory URLs redirecting to home page instead of correct AI locations
- Missing backward compatibility for moved files

Addresses DOC-5428
@mich-elle-luna
Merge pull request #1800 from redis/add-new-videos
85f82c3 
Update ai-videos.md
@andy-stark-redis
Merge pull request #1797 from redis/DOC-5419-commands-section
ac3291f 
DOC-5419 added commands section
@paoloredis
Update redisvl workflow (#1802)
5c28113
@dwdougherty @andy-stark-redis
DEV: (RediSearch) doc expiration capabilities in Redis 8 (#1792)
93c3a03 
* DEV: (RediSearch) doc expiration capabilities in Redis 8

* Apply suggestions from code review

Co-authored-by: andy-stark-redis <[email protected]>

* Apply more suggestions from code review

---------

Co-authored-by: andy-stark-redis <[email protected]>
@mich-elle-luna
Merge pull request #1801 from redis/DOC-5428
ac374de 
DOC-5428 Fix search-and-query documentation aliases
@kaitlynmichael
add leading slash to alias (#1804)
5e1b0aa
@dwdougherty
Merge branch 'main' into feat-ros-8.2
691afdb
@dwdougherty
Merge branch 'feat-ros-8.2' of github.com:redis/docs into feat-ros-8.2
6e3e89d
@dwdougherty
DOC-5423: update the modules API page
c80c27f
@dwdougherty dwdougherty self-assigned this Jul 7, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 7, 2025

Staging links:
https://redis.io/docs/staging/DOC-5423/apis/
https://redis.io/docs/staging/DOC-5423/commands/cluster-info
https://redis.io/docs/staging/DOC-5423/commands/command
https://redis.io/docs/staging/DOC-5423/commands/eval
https://redis.io/docs/staging/DOC-5423/commands/eval_ro
https://redis.io/docs/staging/DOC-5423/commands/evalsha
https://redis.io/docs/staging/DOC-5423/commands/evalsha_ro
https://redis.io/docs/staging/DOC-5423/commands/expire
https://redis.io/docs/staging/DOC-5423/commands/fcall
https://redis.io/docs/staging/DOC-5423/commands/fcall_ro
https://redis.io/docs/staging/DOC-5423/commands/ft.aggregate
https://redis.io/docs/staging/DOC-5423/commands/ft.search
https://redis.io/docs/staging/DOC-5423/commands/function-delete
https://redis.io/docs/staging/DOC-5423/commands/function-dump
https://redis.io/docs/staging/DOC-5423/commands/function-flush
https://redis.io/docs/staging/DOC-5423/commands/function-kill
https://redis.io/docs/staging/DOC-5423/commands/function-list
https://redis.io/docs/staging/DOC-5423/commands/function-load
https://redis.io/docs/staging/DOC-5423/commands/function-restore
https://redis.io/docs/staging/DOC-5423/commands/function-stats
https://redis.io/docs/staging/DOC-5423/commands/hexpire
https://redis.io/docs/staging/DOC-5423/commands/hexpireat
https://redis.io/docs/staging/DOC-5423/commands/hpersist
https://redis.io/docs/staging/DOC-5423/commands/hpexpire
https://redis.io/docs/staging/DOC-5423/commands/hpexpireat
https://redis.io/docs/staging/DOC-5423/commands/info
https://redis.io/docs/staging/DOC-5423/commands/memory-usage
https://redis.io/docs/staging/DOC-5423/commands/psubscribe

@dwdougherty dwdougherty merged commit 58d847e into feat-ros-8.2 Jul 7, 2025
5 checks passed
@dwdougherty dwdougherty deleted the DOC-5423 branch July 7, 2025 15:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@dwdougherty dwdougherty

Labels
dev ros 8.2
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@dwdougherty @mich-elle-luna @paoloredis @andy-stark-redis @cmilesb @kaitlynmichael @DevRockstarZ @rrelledge