Add Ruby + PostgreSQL quickstart guide #772
Conversation
- Created comprehensive quickstart documentation for Ruby (Sinatra) with PostgreSQL - Added Ruby language support to QuickStartFilter with gem icon - Registered Ruby quickstart in QuickStartList for both Docker and Local setups - Updated sidebar navigation to include Ruby category - Build verified successfully with no errors
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive Ruby (Sinatra) + PostgreSQL quickstart documentation to the Keploy documentation site, demonstrating how to use Keploy for automated API testing with Ruby applications.
Changes:
- Created a new Ruby + PostgreSQL quickstart guide with both Docker Compose and local setup instructions, including complete CRUD API examples and Keploy record/replay workflows
- Added Ruby language support to the QuickStart filter with the Ruby gem icon (color #CC342D)
- Registered the quickstart in QuickStartList.js with entries for both Docker and Local environments
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| versioned_docs/version-4.0.0/quickstart/ruby-sinatra-postgres.md | New comprehensive quickstart guide covering Ruby/Sinatra with PostgreSQL integration, including setup, recording, and testing instructions for both Docker and local environments |
| src/components/QuickStartFilter.js | Added Ruby language option with FaGem icon to enable filtering quickstarts by Ruby |
| src/components/QuickStartList.js | Added two entries (Docker and Local) for the Ruby + Postgres quickstart with proper links and descriptions |
| versioned_sidebars/version-4.0.0-sidebars.json | Added Ruby category under QuickStarts section with reference to the new samples-ruby documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| import InstallReminder from '@site/src/components/InstallReminder'; | ||
| import SectionDivider from '@site/src/components/SectionDivider'; |
There was a problem hiding this comment.
The ProductTier component is missing. Almost all other quickstart guides in the codebase include this component to indicate which Keploy tiers and offerings support the quickstart. For consistency with other guides, this should be added after the imports and before the Introduction section. Based on the pattern seen in other open-source compatible quickstarts (like C#, Django, FastAPI), it should likely be: <ProductTier tiers="Open Source, Enterprise" offerings="Self-Hosted, Dedicated" />
| import InstallReminder from '@site/src/components/InstallReminder'; | ||
| import SectionDivider from '@site/src/components/SectionDivider'; |
There was a problem hiding this comment.
The import statement for ProductTier component is missing. Looking at other quickstart guides in the codebase (e.g., csharp-dotnet-postgres.md:24, python-django-sql.md:32), ProductTier should be imported alongside other components. Add import ProductTier from '@site/src/components/ProductTier'; with the other import statements.
|
|
||
| ## Running App Locally on Linux/WSL 🐧 | ||
|
|
||
| We'll be running our sample application locally on Linux/WSL. There are 2 ways you can run this application: |
There was a problem hiding this comment.
The statement "There are 2 ways you can run this application:" is misleading because only one way (local setup) is presented in this section. This text should either be removed or corrected to say "We'll be running our sample application locally on Linux/WSL." to match the actual content structure.
| We'll be running our sample application locally on Linux/WSL. There are 2 ways you can run this application: | |
| We'll be running our sample application locally on Linux/WSL. |
|
I opened this PR by mistake. |
1 participant
Add Ruby + PostgreSQL Quickstart Guide
📝 Description
This PR adds a comprehensive quickstart guide for Ruby (Sinatra) with PostgreSQL integration, demonstrating how to use Keploy for automated API testing with Ruby applications.
🎯 Changes Made
✅ Created new quickstart documentation:
ruby-sinatra-postgres.md✅ Added Ruby language support to
QuickStartFilter.js✅ Registered quickstart in
QuickStartList.js✅ Updated sidebar navigation in
version-4.0.0-sidebars.json🔗 Related Repository
Sample application repository: https://github.com/Nsanjayboruds/keploy-ruby-postgresql-quickstart
✅ Pre-submission Checklist
npm run buildsuccessful)📸 Preview
The quickstart covers:
🙏 Additional Notes
This is my first contribution to Keploy docs. Looking forward to feedback and happy to make any requested changes!