Added ruby how-to examples - #300
Open
Aryex wants to merge 1 commit into
Open
Conversation
Signed-off-by: Alex Le <alex.le@improving.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Added Ruby documentation for Ruby 1.0.0 release. This covers only the how-to guides.
Related
#299
Content Changes
Ruby tabs added to:
installation,client-initialization.configure-lazy-connection,limit-inflight-requests,read-strategy,timeouts-and-reconnect-strategy,resilience-best-practices.send-batch-commands,execute-custom-commands,execute-custom-scripts,load-and-execute-functions.open-telemetry,tracking-resources.authentication,tls.modules-api/json-module,modules-api/search-module.Features the Ruby client does not yet support are intentionally omitted. Where a page has a section for an
unsupported feature, the Ruby tab is left out of that section only.
Implementation
Ruby examples were generated per page, then verified by executing every added
snippet against the published
valkey-glide-rb1.0.0.pre.rc2gem with livestandalone, cluster, and TLS servers (started via
cluster_manager.py).Testing
pnpm buildruns successfully (110 pages, internal links validated).pnpm formatapplied.1.0.0.pre.rc2gem acrossstandalone/cluster/TLS/auth.
modules-apipages were reviewed for API correctness against theRuby client source but not executed (require server modules); JSON/vector
method names and argument shapes were checked against
valkey-glide-rubyatv1.0.0-rc2.Checklist
Before submitting the PR make sure the following are checked:
--signoffflag.pnpm buildruns successfully.