Skip to content

Documentation Migration and Valkey Rebranding#58

Merged
jeremyprime merged 22 commits intovalkey-io:mainfrom
jeremyprime:docs-migration
Mar 10, 2026
Merged

Documentation Migration and Valkey Rebranding#58
jeremyprime merged 22 commits intovalkey-io:mainfrom
jeremyprime:docs-migration

Conversation

@jeremyprime
Copy link
Copy Markdown
Collaborator

@jeremyprime jeremyprime commented Jan 30, 2026

Summary

This PR migrates the existing Spring Data Redis docs from Antora (AsciiDoc) to Astro Starlight (Markdown), rebrands as Spring Data Valkey, and ensures Valkey GLIDE is the primary driver in the docs.

The styling from the Valkey GLIDE docs is applied to be consistent with other valkey.io docs.

All doc links in READMEs, schemas, etc. have also been updated.

Closes #14.

Review

See the rebranded docs for Spring Data Valkey here:
https://spring.valkey.io/

And compare the original Spring Data Redis docs:
https://docs.spring.io/spring-data/redis/reference/index.html

The overall structure was kept, but the pages were updated to fit the valkey.io styling and to make GLIDE the central driver in the docs.

Next Steps

Add a link under Java clients to point to the Spring Data Valkey repo and docs.

Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
@jeremyprime jeremyprime changed the title Documentation migration and Valkey rebranding Documentation Migration and Valkey Rebranding Jan 30, 2026
Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
@ikolomi
Copy link
Copy Markdown
Collaborator

ikolomi commented Mar 10, 2026

@jeremyprime

migrates the existing Spring Data Redis docs from Antora (AsciiDoc) to Astro Starlight (Markdown)

why are we doing it? it will make merging from the SDR not trivial

@jeremyprime
Copy link
Copy Markdown
Collaborator Author

@jeremyprime

migrates the existing Spring Data Redis docs from Antora (AsciiDoc) to Astro Starlight (Markdown)

why are we doing it? it will make merging from the SDR not trivial

The existing Spring Data Redis documentation uses Antora to publish to the spring.io website. The existing Valkey GLIDE documentation uses Astro Starlight to publish to GitHub Pages, so copied that process and styling to match.

We could learn Antora and use that instead. The tradeoff is easier merging (although never that easy considering the rebranding to Valkey and adding of GLIDE to the docs) vs alignment with valkey.io doc processes and styling.

@ikolomi
Copy link
Copy Markdown
Collaborator

ikolomi commented Mar 10, 2026

We could learn Antora and use that instead. The tradeoff is easier merging (although never that easy considering the rebranding to Valkey and addi

Do we get a real value from moving to Astro? - the merging with rebranding should be mainly trivial with Antora

@jeremyprime
Copy link
Copy Markdown
Collaborator Author

We could learn Antora and use that instead. The tradeoff is easier merging (although never that easy considering the rebranding to Valkey and addi

Do we get a real value from moving to Astro? - the merging with rebranding should be mainly trivial with Antora

Main benefit is consistency in styling and look across all Valkey doc sites. With Antora would look more like spring.io.

Copy link
Copy Markdown
Collaborator

@ikolomi ikolomi left a comment

Choose a reason for hiding this comment

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

Besides the comment i am missing the glide - specific page that we need to show off as the primary page that answer "What can Spring Data Valkey do that Spring Data Redis cannot?"

smt like:

docs/src/content/docs/valkey/valkey-glide-features.md :

Availability Zone Awareness

High-performance I/O (based on the WIP performance analysys)

Enhanced observability OTEL (maybe duplication but w/o details)

IAM

#68

Reliable pubsub (short explanation taken from VG wiki )

@ikolomi ikolomi added the documentation Improvements or additions to documentation label Mar 10, 2026
@ikolomi ikolomi added this to the 1.0 GA milestone Mar 10, 2026
@ikolomi
Copy link
Copy Markdown
Collaborator

ikolomi commented Mar 10, 2026

We could learn Antora and use that instead. The tradeoff is easier merging (although never that easy considering the rebranding to Valkey and addi

Do we get a real value from moving to Astro? - the merging with rebranding should be mainly trivial with Antora

Main benefit is consistency in styling and look across all Valkey doc sites. With Antora would look more like spring.io.

Well, this pretty much seals it. We will have to cope with this merge burden

@ikolomi
Copy link
Copy Markdown
Collaborator

ikolomi commented Mar 10, 2026

@jeremyprime I think there might be inconsistencies with the package names (as commented) please do a sweep

Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
@jeremyprime
Copy link
Copy Markdown
Collaborator Author

jeremyprime commented Mar 10, 2026

Besides the comment i am missing the glide - specific page that we need to show off as the primary page that answer "What can Spring Data Valkey do that Spring Data Redis cannot?"

smt like:

docs/src/content/docs/valkey/valkey-glide-features.md :

Availability Zone Awareness

High-performance I/O (based on the WIP performance analysys)

Enhanced observability OTEL (maybe duplication but w/o details)

IAM

#68

Reliable pubsub (short explanation taken from VG wiki )

I added a new page called Features in Overview section, it goes over these points and a couple others as to the advantages of Spring Data Valkey over Spring Data Redis.

@jeremyprime jeremyprime merged commit ce70c43 into valkey-io:main Mar 10, 2026
45 of 46 checks passed
@jeremyprime jeremyprime deleted the docs-migration branch March 10, 2026 20:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Development

Successfully merging this pull request may close these issues.

Full docs

2 participants