Skip to content

Commit 2dc2232

Browse files
Sonichigoactions-user
authored andcommitted
feat: based on feedback iteration 2
Signed-off-by: Animesh Pathak <[email protected]>
1 parent be5f389 commit 2dc2232

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+438
-383
lines changed

Diff for: docusaurus.config.js

+10-9
Original file line numberDiff line numberDiff line change
@@ -138,23 +138,24 @@ module.exports = {
138138
{
139139
to: "/keploy-cloud/cloud-installation",
140140
label: "Enterprise",
141+
activeBasePath: "none",
141142
},
142143
{
143144
label: "Resources",
144145
items: [
145146
{
146-
label: 'Blogs',
147-
href:'https://keploy.io/blog',
147+
label: "Blogs",
148+
href: "https://keploy.io/blog",
148149
},
149150
{
150-
label: 'Contributing',
151-
href: '/keploy-explained/contribution-guide',
151+
label: "Contributing",
152+
href: "/keploy-explained/contribution-guide",
152153
},
153154
{
154-
label: 'FAQ',
155-
href:'/keploy-explained/faq/',
155+
label: "Glossary",
156+
href: "/concepts/reference/glossary/",
156157
},
157-
]
158+
],
158159
},
159160
{
160161
type: "docsVersionDropdown",
@@ -168,9 +169,9 @@ module.exports = {
168169
"aria-label": "GitHub repository",
169170
},
170171
{
171-
href: "https://app.keploy.io",
172+
href: "https://app.keploy.io/pricing",
172173
position: "right",
173-
label: 'Pricing'
174+
label: "Pricing",
174175
},
175176
// TODO : Add Blogging Section
176177
// {

Diff for: src/components/Community.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ export const Community = () => {
118118
<svg
119119
fill="currentColor"
120120
className="h-12 w-12 flex-none text-black"
121-
viewBox="0 0 48 48"
121+
viewBox="0 0 512 509.64"
122122
>
123123
<rect width="509.64" height="512" rx="120" />
124124
<path

Diff for: src/components/Intro.js

+20-18
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ function Frameworks() {
143143
data-tooltip="MongoDB"
144144
>
145145
<img
146-
className="h-8 w-8"
146+
className="h-8 w-8 transition hover:scale-110"
147147
src="/docs/img/mongodb-logo.svg"
148148
alt="Docker logo"
149149
/>
@@ -156,7 +156,7 @@ function Frameworks() {
156156
data-tooltip="HTTP"
157157
>
158158
<img
159-
className="h-8 w-8"
159+
className="h-8 w-8 transition hover:scale-110"
160160
src="/docs/img/http-logo.svg"
161161
alt="HTTP logo"
162162
/>
@@ -169,7 +169,7 @@ function Frameworks() {
169169
data-tooltip="PostgreSQL"
170170
>
171171
<img
172-
className="h-8 w-8"
172+
className="h-8 w-8 transition hover:scale-110"
173173
src="/docs/img/postgres-logo.svg"
174174
alt="PostgresSQL logo"
175175
/>
@@ -180,33 +180,33 @@ function Frameworks() {
180180
to={useBaseUrl("/dependencies/redis")}
181181
className="hover-label-container flex flex-col items-center justify-center space-y-1 p-6 text-center hover:underline"
182182
data-tooltip="Redis"
183-
>
183+
>
184184
<img
185-
className="h-8 w-8"
185+
className="h-8 w-8 transition hover:scale-110"
186186
src="/docs/img/redis-logo.svg"
187187
alt="Redis logo"
188188
/>
189189
</Link>
190190
</li>
191191
<li className="mt-5 flex flex-col space-y-3 text-lg">
192-
<Link
193-
className="hover-label-container flex flex-col items-center justify-center space-y-1 p-6 text-center "
194-
data-tooltip="MySQL"
192+
<Link
193+
className="hover-label-container flex flex-col items-center justify-center space-y-1 p-6 text-center "
194+
data-tooltip="MySQL"
195195
>
196196
<img
197-
className="h-8 w-8"
197+
className="h-8 w-8 transition hover:scale-110"
198198
src="/docs/img/mysql-logo.svg"
199199
alt="MySQL logo"
200200
/>
201201
</Link>
202202
</li>
203203
<li className="mt-5 flex flex-col space-y-3 text-lg">
204-
<Link
205-
className="hover-label-container flex flex-col items-center justify-center space-y-1 p-6 text-center "
206-
data-tooltip="DynamoDB"
204+
<Link
205+
className="hover-label-container flex flex-col items-center justify-center space-y-1 p-6 text-center "
206+
data-tooltip="DynamoDB"
207207
>
208208
<img
209-
className="h-8 w-8"
209+
className="h-8 w-8 transition hover:scale-110"
210210
src="/docs/img/dynamodb-logo.svg"
211211
alt="DynamoDB logo"
212212
/>
@@ -231,12 +231,14 @@ export const Intro = () => {
231231
return (
232232
<section className="mb-4 mt-12">
233233
<h2 className="mb-4 text-2xl font-semibold tracking-wide md:text-3xl">
234-
Getting Started ✨
234+
Getting Started ✨
235235
</h2>
236-
<p className="text-l text-gray-500">
237-
Get up and running with Keploy in just a few minutes by integrating it with your applications.
238-
Below are the quick-start guides for popular languages and frameworks.
239-
</p><br/>
236+
<p className="text-l text-gray-500">
237+
Get up and running with Keploy in just a few minutes by integrating it
238+
with your applications. Below are the quick-start guides for popular
239+
languages and frameworks.
240+
</p>
241+
<br />
240242
<div className="grid gap-6 sm:grid-cols-2 xl:gap-8">
241243
<Languages />
242244
<Frameworks />

Diff for: src/components/KeployCloud.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: src/components/Product.js

+216-104
Large diffs are not rendered by default.

Diff for: src/components/QuickStart.js

+17-7
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,26 @@ export const QuickStart = () => {
99
Keploy Documentation! 🚀
1010
</h1>
1111
<p className="text-l max-w-3xxl">
12-
Welcome to Keploy’s documentation! Whether you're new to backend testing or an experienced developer, this guide will help you get started with Keploy quickly and effectively.🗺️
12+
Welcome to Keploy’s documentation! Whether you're new to backend testing
13+
or an experienced developer, this guide will help you get started with
14+
Keploy quickly and effectively.🗺️
1315
</p>
1416

1517
<h2 className="mb-4 mt-8 text-2xl font-semibold tracking-wide md:text-3xl">
1618
What is Keploy? 🤔
1719
</h2>
1820
<p className="text-l max-w-3xxl">
19-
Keploy is an open-source backend testing tool that helps developers quickly create and run tests by capturing
20-
real user traffic. It generates test cases and data mocks to ensure your code is reliable and helps speed up your release cycle..🛠️
21-
<br/><br/>
22-
With features like API testing, unit test generation, and schema/PRD-based test automation, Keploy helps teams release faster while maintaining high reliability.
23-
It’s easy to use, extensible, and integrates seamlessly into CI/CD pipelines, making backend testing efficient and productive.
21+
Keploy is an open-source backend testing tool that helps developers
22+
quickly create and run tests by capturing real user traffic. It
23+
generates test cases and data mocks to ensure your code is reliable and
24+
helps speed up your release cycle..🛠️
25+
<br />
26+
<br />
27+
With features like API testing, unit test generation, and
28+
schema/PRD-based test automation, Keploy helps teams release faster
29+
while maintaining high reliability. It’s easy to use, extensible, and
30+
integrates seamlessly into CI/CD pipelines, making backend testing
31+
efficient and productive.
2432
</p>
2533
<h2 className="mt-8 text-2xl font-semibold tracking-wide md:text-3xl">
2634
Setup Guide 📗
@@ -65,7 +73,9 @@ export const QuickStart = () => {
6573
</Link>
6674
</div>
6775
<p className="text-l mt-6 text-gray-500">
68-
<b>⚠️ Important Note:</b> Keploy v2 is currently in Beta, and the best experience is on Linux. Docker support is experimental, and some limitations may apply.
76+
<b>⚠️ Important Note:</b> Keploy v2 is currently in Beta, and the best
77+
experience is on Linux. Docker support is experimental, and some
78+
limitations may apply.
6979
</p>
7080
</section>
7181
);

Diff for: src/css/custom.css

+18-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
font-size:18px;
1010
line-height: 1.6;
1111
--ifm-color-primary: #000;
12-
1312
--ifm-color-primary-lighter: #FFF;
1413
--ifm-color-primary: #ff914d;
1514
--ifm-color-primary-dark: #e67643;
@@ -87,6 +86,24 @@ html[data-theme="light"] {
8786
--ifm-card-shadow-color: rgba(0, 0, 0, 0.2); /* Dark shadow for light theme */
8887
}
8988

89+
html[data-theme='light'] .theme-doc-sidebar-container {
90+
border-right: 1px solid #676565;
91+
}
92+
93+
/* Sidebar border for dark theme */
94+
html[data-theme='dark'] .theme-doc-sidebar-container {
95+
border-right: 1px solid #676565;
96+
}
97+
98+
html[data-theme='light'] .col--3 {
99+
border-left: 1px solid #676565;
100+
}
101+
102+
/* TOC column border for dark theme */
103+
html[data-theme='dark'] .col--3 {
104+
border-left: 1px solid #676565;
105+
}
106+
90107
@font-face {
91108
font-family: "Roboto";
92109
src: url("../fonts/Roboto-Light.woff2");

Diff for: tailwind.config.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ module.exports = {
1414
"./src/theme/**/*.{js,ts,jsx,tsx}",
1515
],
1616
corePlugins: {
17-
preflight: false,
17+
preflight: false,
1818
},
1919
// corePlugins: {
2020
// // preflight: false, // to use Docusaurus base styles

Diff for: versioned_docs/version-2.0.0/ci-cd/github.md

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ tags:
1313
- cd
1414
- plugin
1515
---
16+
1617
<head>
1718
<title>Integrating with GitHub CI | Keploy Docs</title>
1819
<meta charSet="utf-8" />

Diff for: versioned_docs/version-2.0.0/ci-cd/gitlab.md

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ tags:
1313
- cd
1414
- plugin
1515
---
16+
1617
<head>
1718
<title>Integrating with GitLab CI | Keploy Docs</title>
1819
<meta charSet="utf-8" />

Diff for: versioned_docs/version-2.0.0/ci-cd/jenkins.md

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ tags:
1313
- cd
1414
- plugin
1515
---
16+
1617
<head>
1718
<title>Integrating with Jenkins | Keploy Docs</title>
1819
<meta charSet="utf-8" />

Diff for: versioned_docs/version-2.0.0/concepts/installation.md

+1-108
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ keywords:
2020
- installation-guide
2121
- server-setup
2222
---
23+
2324
<head>
2425
<title>Installation | Keploy Docs</title>
2526
<meta charSet="utf-8" />
@@ -70,111 +71,3 @@ Use "keploy [command] --help" for more information about a command.
7071
```
7172

7273
🎉 Wohoo! You are all set to use Keploy.
73-
74-
## Other Installation Methods
75-
76-
<details>
77-
<summary>Install using Docker</summary>
78-
79-
### Downloading and running Keploy in Docker
80-
81-
#### On macOS
82-
83-
Note : Keploy is not supported natively on MacOS, so you can follow the below method to run with docker
84-
85-
1. Open up a terminal window.
86-
87-
2. Create a bridge network in Docker using the following docker network create command:
88-
89-
```bash
90-
docker network create keploy-network
91-
```
92-
93-
3. Run the following command to start the Keploy container:
94-
95-
```bash
96-
alias keploy="docker run --name keploy-v2 -p 16789:16789 --network keploy-network --privileged --pid=host -v $(pwd):$(pwd) -w $(pwd) -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock --rm ghcr.io/keploy/keploy"
97-
```
98-
99-
</details>
100-
101-
<details>
102-
<summary>Downloading and running Keploy in Native</summary>
103-
104-
### Downloading and running Keploy in Native
105-
106-
**Prequisites:**
107-
108-
- Linux Kernel version 5.15 or higher
109-
- Run `uname -a` to verify the system architecture.
110-
- In case of Windows, use WSL with Ubuntu 20.04 LTS or higher.
111-
112-
<summary>Downloading and running Keploy On WSL/Linux AMD</summary>
113-
114-
#### On WSL/Linux AMD
115-
116-
1. Open the terminal Session.
117-
2. Run the following command to download and install Keploy:
118-
119-
```bash
120-
curl --silent --location "https://github.com/keploy/keploy/releases/latest/download/keploy_linux_amd64.tar.gz" | tar xz --overwrite -C /tmp
121-
sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy
122-
```
123-
124-
#### On WSL/Linux ARM
125-
126-
1. Open the terminal Session
127-
2. Run the following command to download and install Keploy:
128-
129-
```bash
130-
curl --silent --location "https://github.com/keploy/keploy/releases/latest/download/keploy_linux_arm64.tar.gz" | tar xz --overwrite -C /tmp
131-
sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy
132-
133-
```
134-
135-
> Note: Keploy is not supported on MacOS natively.
136-
137-
### Setting up the Docker Desktop for WSL 2
138-
139-
1. Install Docker Desktop for Windows from [here](https://docs.docker.com/desktop/windows/install/).
140-
141-
When developing on Windows with Docker Desktop and WSL 2, it's crucial to configure Docker Desktop to allow WSL 2 distributions to access the Docker daemon. This setup enables seamless integration between your Windows environment, WSL 2 Linux distros, and Docker.
142-
143-
By default, Docker Desktop may not be configured to work with all WSL 2 distros out of the box. Proper configuration ensures that you can run Docker commands from within your WSL 2 environment, allowing for a more native Linux development experience while leveraging the power of Windows.
144-
145-
> This setup is essential for Keploy to function correctly in a WSL 2 environment, as it needs to interact with the Docker daemon to manage containers and networks effectively.
146-
> For detailed instructions on how to configure `Docker Desktop` for WSL 2, please refer to the [official Docker documentation](https://docs.docker.com/desktop/wsl/).
147-
148-
</details>
149-
150-
<details>
151-
<summary>With Arkade</summary>
152-
153-
### With Arkade
154-
155-
1. Installing Arkade
156-
157-
```bash
158-
# Note: you can also run without `sudo` and move the binary yourself
159-
curl -sLS https://get.arkade.dev | sudo sh
160-
161-
arkade --help
162-
ark --help # a handy alias
163-
164-
# Windows users with Git Bash
165-
curl -sLS https://get.arkade.dev | sh
166-
```
167-
168-
2. Install Keploy
169-
170-
```bash
171-
arkade get keploy
172-
```
173-
174-
Or you can also download specific version of Keploy using the following command:
175-
176-
```bash
177-
178-
```
179-
180-
</details>

Diff for: versioned_docs/version-2.0.0/concepts/what-are-keploy-features.md

+1
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ keywords:
1717
- record replay test
1818
- mock mutations
1919
---
20+
2021
<head>
2122
<title>What are Keploy Features? | Keploy Docs</title>
2223
<meta charSet="utf-8" />

Diff for: versioned_docs/version-2.0.0/concepts/what-is-a-keploy-ebpf.md

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ keywords:
1010
- ebpf
1111
- Testing API
1212
---
13+
1314
<head>
1415
<title>What is Keploy eBPF | Keploy Docs</title>
1516
<meta charSet="utf-8" />

0 commit comments

Comments
 (0)