Skip to content

docs: added quickstart guide for S3-Keploy#564

Closed
kpriyanshu2003 wants to merge 3 commits intokeploy:mainfrom
kpriyanshu2003:s3-keploy
Closed

docs: added quickstart guide for S3-Keploy#564
kpriyanshu2003 wants to merge 3 commits intokeploy:mainfrom
kpriyanshu2003:s3-keploy

Conversation

@kpriyanshu2003
Copy link
Copy Markdown

What has changed?

  1. Ran npx prettier --write '**/*.{js,md}' for formatting
  2. Added docs in quick-start guide for S3-Keploy was missing.

This PR Resolves #2165

Type of change

Please delete options that are not relevant.

  • Documentation update (if none of the other choices apply).

How Has This Been Tested?

Yes, I have tested for the changes

  • npm run build was successful
  • Changes are visible as per expectations on the local build

Before:
image

After:
image
image

Checklist:

  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.

Copilot AI review requested due to automatic review settings June 18, 2025 17:39
Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

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

Thank you and congratulations 🎉 for opening your very first pull request in keploy

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds documentation for the new S3-Keploy quickstart sample and updates the site configuration accordingly.

  • Included the S3-Keploy sample in the versioned sidebar
  • Added a new MDX quickstart guide for Go Fiber + AWS S3 integration
  • Cleaned up formatting and style in STYLE.md and README.md

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
versioned_sidebars/version-3.0.0-sidebars.json Added "quickstart/samples-s3-keploy" to sidebar list
versioned_docs/version-3.0.0/quickstart/samples-go-fiber-s3.md New tutorial page for the Fiber + S3 sample
STYLE.md Minor formatting and list-style corrections
README.md Removed an extraneous blank line
Comments suppressed due to low confidence (2)

versioned_docs/version-3.0.0/quickstart/samples-go-fiber-s3.md:14

  • The frontmatter key keyword should be keywords to match other docs and ensure proper indexing.
keyword:

versioned_docs/version-3.0.0/quickstart/samples-go-fiber-s3.md:24

  • [nitpick] Consider toning down informal language and emojis in the introduction to maintain a professional and consistent documentation style.
🪄 Dive into the world of cloud storage management and see how seamlessly Keploy integrates with Fiber and AWS S3! Buckle up, it's gonna be a fun ride! 🎢

Signed-off-by: Kumar Priyanshu <az.priyanshu.rockstar@gmail.com>
Signed-off-by: Kumar Priyanshu <az.priyanshu.rockstar@gmail.com>
@kpriyanshu2003 kpriyanshu2003 changed the title S3 keploy docs: added quickstart guide for S3-Keploy Jun 18, 2025
@pratik-mahalle
Copy link
Copy Markdown
Contributor

Hey @kpriyanshu2003, Thank you for raising the pr. Our team will review it soon

Signed-off-by: Achanandhi M <110651321+Achanandhi-M@users.noreply.github.com>
Copy link
Copy Markdown
Member

@amaan-bhati amaan-bhati left a comment

Choose a reason for hiding this comment

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

Thank you for filling this documentation gap - the S3 quickstart covers the workflow thoroughly with good examples and a useful troubleshooting section.

Consider working through a few things:

Issues to be Considered

1. Unrelated formatting changes

The PR ran Prettier across the entire repo, reformatting files unrelated to this quickstart. Please revert those changes and keep the diff scoped to the S3 quickstart only.

2. Current version not covered

The guide is currently only added to version-3.0.0. Since the current version is what most users are on, consider adding the quickstart there as well.

3. Frontmatter typo

The frontmatter uses keyword (singular) where it should be keywords (plural) for consistency with other docs pages.

4. Emoji and informal tone

The documentation contains emojis and informal phrasing that is inconsistent with the professional tone of the rest of the Keploy docs. Please remove or minimize these.

5. Missing security note

The guide involves AWS credentials but there is no warning about never hardcoding them. Please add a clear note in the prerequisites section pointing users toward environment variables or IAM roles.

6. Not wired into the quickstart UI

There are no entries added to QuickStartFilter.js or QuickStartList.js, which means the guide will not appear in the quickstart discovery UI. Please follow the pattern from other recent quickstart PRs to make it discoverable.

Copy link
Copy Markdown
Member

@amaan-bhati amaan-bhati left a comment

Choose a reason for hiding this comment

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

Thank you for your contribution and for the time and energy you invested in this PR! We shared our review and feedback a few weeks ago and have not seen any updates since, so we are going to close this to keep the queue manageable.

If you would like to continue working on this, please feel free to reopen the PR after addressing the review feedback, or submit a new one - we would be happy to take another look. There are also plenty of other open issues across the repo where your help would be very welcome.

Thank you again for contributing to Keploy! Feel free to reach out on Slack if you have any questions, want clarification on the feedback, or are looking for something new to work on.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs]: add S3 sample app on documentation website

6 participants