Skip to content

Commit

Permalink
Merge branch 'main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
Sonichigo authored Nov 28, 2023
2 parents 40bfadf + 1052be2 commit 488f99c
Show file tree
Hide file tree
Showing 24 changed files with 3,897 additions and 683 deletions.
46 changes: 27 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,47 +79,55 @@ The command starts a local development server and opens a browser window.

```sh
git clone https://github.com/<GITHUB_USERNAME>/docs.git
```

<br/>

3. Go into the directory containing the project
## Go into the directory containing the project

```sh
cd docs
```

<br/>

4. Install all the dependencies
3. Install all the dependencies

```sh
yarn
```
yarn install

<br/>

5. Start the development server.
## Start the development server.

```sh
yarn start
```

6. To reformat:
4. To reformat:

```
```sh
yarn prettier --write '**/*.{js,md}'
```

When we merge your PR, a new build automatically occurs and your changes publish to [https://docs.keploy.io](https://docs.keploy.io).
5. Check the build status:

```sh
npm run build
```

> Note: if the Build is failing, fix the changes before making PR.
When we merge your PR, a new build automatically occurs and your changes publish to [https://keploy.io/docs](https://keploy.io/docs).

## How to Get Involved?

Keploy welcomes contributions to the docs website. If you have an idea for a new feature or a bug fix, please submit an issue or pull request. Our planned features can be found on our [Issue Tracker](https://github.com/keploy/keploy/issues/new/choose).

## Community support
## Community Support ❤️

### 🤔 Questions?

Reach out to us. We're here to help!

[![Slack](https://img.shields.io/badge/Slack-4A154B?style=for-the-badge&logo=slack&logoColor=white)](https://join.slack.com/t/keploy/shared_invite/zt-12rfbvc01-o54cOG0X1G6eVJTuI_orSA)
[![LinkedIn](https://img.shields.io/badge/linkedin-%230077B5.svg?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/company/keploy/)
[![YouTube](https://img.shields.io/badge/YouTube-%23FF0000.svg?style=for-the-badge&logo=YouTube&logoColor=white)](https://www.youtube.com/channel/UC6OTg7F4o0WkmNtSoob34lg)
[![Twitter](https://img.shields.io/badge/Twitter-%231DA1F2.svg?style=for-the-badge&logo=Twitter&logoColor=white)](https://twitter.com/Keployio)

We'd love to collaborate with you to make Keploy great. To get started:
### 💖 Let's Build Together!

- [Slack](https://join.slack.com/t/keploy/shared_invite/zt-12rfbvc01-o54cOG0X1G6eVJTuI_orSA) - Discussions with the community and the team.
- [GitHub](https://github.com/keploy/keploy/issues) - For bug reports and feature requests.
Whether you're a newbie coder or a wizard 🧙‍♀️, your perspective is golden. Take a peek at our:
2 changes: 1 addition & 1 deletion src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export default function Home() {
<main className="mx-auto max-w-screen-lg p-6 md:p-10">
<QuickStart />
{/*<GSoC/>*/}
{<Hacktoberfest />}
{/* {<Hacktoberfest />} */}
{/*<Intro />*/}
<Resources />
<Community />
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-2.0.0/keploy-explained/dev-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Generated test cases can be found inside the Keploy directory.
#### Generate Keploy Binary:

```shell
go build -o keploy && sudo mv keploy /usr/local/bin`
go build -o keploy && sudo mv keploy /usr/local/bin
```

#### Capturing Test Cases:
Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-2.0.0/quickstart/go-gin-mongo.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: samples-gin
title: Sample URL Shortener App (Golang)
sidebar_label: Golang - Gin + Mongo
sidebar_label: Gin + Mongo
description: The following sample app showcases how to use gin framework and the Keploy Platform.
tags:
- Gin Framework
Expand All @@ -16,7 +16,7 @@ keyword:

## Introduction

🪄 Dive into the world of URL shorteners and see how seamlessly Keploy integrates with [Gin](https://gin-gonic.com/) and [mongoDB](https://www.mongodb.com/). Buckle up, it's gonna be a fun ride! 🎢
🪄 Dive into the world of URL shorteners and see how seamlessly Keploy integrates with [Gin](https://gin-gonic.com/) and [MongoDB](https://www.mongodb.com/). Buckle up, it's gonna be a fun ride! 🎢

## Pre-Requisite 🛠️

Expand Down
Loading

0 comments on commit 488f99c

Please sign in to comment.