Skip to content

Commit 420f280

Browse files
committed
feat: based on feedback iteration 2
Signed-off-by: Animesh Pathak <[email protected]>
1 parent be5f389 commit 420f280

File tree

15 files changed

+169
-253
lines changed

15 files changed

+169
-253
lines changed

docusaurus.config.js

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,7 @@ module.exports = {
138138
{
139139
to: "/keploy-cloud/cloud-installation",
140140
label: "Enterprise",
141+
activeBasePath: "none",
141142
},
142143
{
143144
label: "Resources",
@@ -151,8 +152,8 @@ module.exports = {
151152
href: '/keploy-explained/contribution-guide',
152153
},
153154
{
154-
label: 'FAQ',
155-
href:'/keploy-explained/faq/',
155+
label: 'Glossary',
156+
href:'/concepts/reference/glossary/',
156157
},
157158
]
158159
},
@@ -168,7 +169,7 @@ 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",
173174
label: 'Pricing'
174175
},

src/components/Community.js

Lines changed: 1 addition & 1 deletion
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

src/components/Intro.js

Lines changed: 6 additions & 6 deletions
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
/>
@@ -182,7 +182,7 @@ function Frameworks() {
182182
data-tooltip="Redis"
183183
>
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
/>
@@ -194,7 +194,7 @@ function Frameworks() {
194194
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
/>
@@ -206,7 +206,7 @@ function Frameworks() {
206206
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
/>

src/components/KeployCloud.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/components/Product.js

Lines changed: 61 additions & 47 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/css/custom.css

Lines changed: 18 additions & 1 deletion
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");

versioned_docs/version-2.0.0/concepts/installation.md

Lines changed: 1 addition & 109 deletions
Original file line numberDiff line numberDiff line change
@@ -69,112 +69,4 @@ Flags:
6969
Use "keploy [command] --help" for more information about a command.
7070
```
7171

72-
🎉 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>
72+
🎉 Wohoo! You are all set to use Keploy.

versioned_docs/version-2.0.0/concepts/what-is-keploy.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,3 @@ You can test with Keploy locally or can integrate Keploy with popular testing-fr
6363

6464
> **Note:** You can generate test cases from any environment which has all the infrastructure dependencies setup. Please consider using this to generate tests from low-traffic environments first. The deduplication feature necessary for high-traffic environments is currently experimental.
6565
66-
Hope this helps you out, if you still have any questions, reach out to us .
67-
68-
import GetSupport from '../concepts/support.md'
69-
70-
<GetSupport/>

versioned_docs/version-2.0.0/keploy-explained/debugger-guide.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ tags:
1010

1111
# Debugger Guide 👨‍🔧
1212

13-
In this blog, we will learn how to debug keploy using Visual Studio Code integrated debugger.
14-
1513
## Setting Up Configuration File
1614

1715
To bring up the **Run and Debug** view, select the **Run and Debug** icon in the **Activity Bar** on the side of VS Code. You can also use the keyboard shortcut `Cmd + Shift + D` for MacOS and `Ctrl + shift + D` for Windows.

versioned_docs/version-2.0.0/keploy-explained/mac-linux.md

Lines changed: 6 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,9 @@ brew install lima
2727
limactl show-ssh --format=config debian-12 & add it to its ssh config
2828
```
2929

30-
5. Open a remote window on your code editor
31-
6. Click on connect to host
32-
7. Now select the configured SSH as "lima-debian"
33-
8. Once you are in the terminal run the following commands to go into your directory
30+
5. Open a remote window on your code editor and Click on connect to host
31+
6. Now select the configured SSH as "lima-debian"
32+
7. Once you are in the terminal run the following commands to go into your directory
3433

3534
```bash
3635
cd /Users
@@ -40,82 +39,33 @@ cd /Users
4039
cd /{Username}
4140
```
4241

43-
9. Run the following command to install Keploy
42+
8. Run the following command to install Keploy
4443

4544
```bash
4645
curl --silent --location "https://github.com/keploy/keploy/releases/latest/download/keploy_linux_arm64.tar.gz" | tar xz --overwrite -C /tmp
4746
sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy
4847
```
4948

50-
10. Run the following command to install Zsh
51-
52-
```bash
53-
sudo apt-get -y install zsh
54-
```
55-
56-
**Why?** : zsh (Z Shell) is an advanced shell that offers enhanced features compared to the default bash shell. It provides better autocompletion, advanced globbing, improved history management, and more customization options.
57-
58-
11. Install Git
59-
60-
```bash
61-
sudo apt-get -y install git
62-
```
63-
64-
12. Install 'Oh-my-zsh'
65-
66-
```bash
67-
sh -c "$(wget https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh -O -)"
68-
```
69-
70-
**Why?** : oh-my-zsh is a framework for managing your zsh configuration. It comes with a collection of plugins, themes, and helpful features that enhance the zsh experience.
71-
72-
13. Commands to Install docker
49+
9. Commands to Install docker
7350

7451
```bash
7552
sudo apt-get -y update
76-
```
77-
78-
```bash
7953
sudo apt-get -y install ca-certificates curl
80-
```
81-
82-
```bash
8354
sudo install -m 0755 -d /etc/apt/keyrings
84-
```
85-
86-
```bash
8755
sudo curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc
88-
```
89-
90-
```bash
9156
sudo chmod a+r /etc/apt/keyrings/docker.asc
92-
```
9357

94-
```bash
9558
echo \
9659
"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian \
9760
$(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
9861
sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
99-
```
100-
101-
```bash
102-
sudo apt-get -y update
103-
```
104-
105-
```bash
106-
sudo apt-get -y update
107-
```
10862

109-
```bash
11063
sudo apt-get -y install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
11164
```
11265

113-
14. Add docker to sudoers
66+
10. Add docker to sudoers
11467

11568
```bash
11669
sudo groupadd docker
117-
```
118-
119-
```bash
12070
sudo gpasswd -a $USER docker
12171
```

versioned_docs/version-2.0.0/keploy-explained/why-keploy.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ tags:
1111
- record replay test
1212
---
1313

14+
Keploy is designed to enhance your testing process by giving superpowers to developers. Whether you're looking for automated test scripting, easy CI/CD integration, or enhanced test coverage with zero effort, Keploy provides everything you need to elevate your testing workflow.
15+
1416
| **Feature** | **Automated Test-Scripting Tools** | **Record-Replay Traffic Tools** | **Keploy** |
1517
| ------------------------------------------ | ------------------------------------------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------- |
1618
| **Test Scripting** | Manual test script creation. | Record user traffic as tests scripts. | Automatic user traffic recording as test scripts. |

versioned_docs/version-2.0.0/quickstart/python-fastapi-sql.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,10 @@ We will be using Docker compose to run the application as well as Postgres on Do
6262

6363
### Lights, Camera, Record! 🎥
6464

65+
Since we have setup our sample-app with docker, we need to update the container name to postgres on line 6, in `application/database.py`, from `postgresql://postgres:postgres@localhost:5432/studentdb` to `postgresql://postgres:postgres@postgres:5432/studentdb`.**
66+
67+
> **Also, we need to update the container name to postgres on line 11, of `application/main.py`, from `postgresql://postgres:postgres@localhost:5432/studentdb` to `postgresql://postgres:postgres@postgres:5432/studentdb`.**
68+
6569
Capture the test-cases-
6670

6771
```shell
@@ -238,6 +242,12 @@ We'll be running our sample application right on Linux, but just to make things
238242

239243
### 📼 Roll the Tape - Recording Time!
240244

245+
Start the database on Docker:
246+
247+
```bash
248+
docker compose up -d postgres
249+
```
250+
241251
Ready, set, record! Here's how:
242252

243253
```bash

0 commit comments

Comments
 (0)