Documentation Migration and Valkey Rebranding#58
Documentation Migration and Valkey Rebranding#58jeremyprime merged 22 commits intovalkey-io:mainfrom
Conversation
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>
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>
a96224b to
82a9aac
Compare
9aeae1b to
ba1c69b
Compare
Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
ba1c69b to
bde0db5
Compare
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>
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. |
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. |
ikolomi
left a comment
There was a problem hiding this comment.
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
Reliable pubsub (short explanation taken from VG wiki )
Well, this pretty much seals it. We will have to cope with this merge burden |
|
@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>
0c4cf64 to
330b2be
Compare
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. |
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.