Skip to content

Commit 8afd583

Browse files
Achanandhi-Mactions-user
authored andcommitted
fix: add new installation page
Signed-off-by: Achanandhi-M <achanandhi.m@gmail.com>
1 parent 7243813 commit 8afd583

File tree

6 files changed

+21
-34
lines changed

6 files changed

+21
-34
lines changed

src/theme/NavbarItem/DropdownNavbarItem.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import DropdownNavbarItem from "@theme-original/NavbarItem/DropdownNavbarItem";
44

55
export default function DropdownNavbarItemWrapper(props) {
66
const {search, hash} = useLocation();
7-
// props.items[0].to = `/server/installation/${search}${hash}`;
7+
// props.items[0].to = `/server/installation/${search}${hash}`;
88
return (
99
<>
1010
<DropdownNavbarItem {...props} />

versioned_docs/version-2.0.0/server/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,4 @@ To run the testcases and see if there are any regressions introduced, use this t
4949
keploy test -c "CMD_TO_RUN_APP" --delay 10
5050
```
5151

52-
Explore the [Test Coverage Generation Guide](https://keploy.io/docs/server/sdk-installation/go/) for seeing test-coverage with your unit testing library and [Keploy Running Guide](https://keploy.io/docs/running-keploy/configuration-file/) for additional options and tips on customizing your Keploy setup to perfection.
52+
Explore the [Test Coverage Generation Guide](https://keploy.io/docs/server/sdk-installation/go/) for seeing test-coverage with your unit testing library and [Keploy Running Guide](https://keploy.io/docs/running-keploy/configuration-file/) for additional options and tips on customizing your Keploy setup to perfection.

versioned_docs/version-3.0.0/installation/linux.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ keywords:
1212

1313
# Installing Keploy on Linux
1414

15-
Keploy uses eBPF to intercept API calls on network layer and generates test cases and mocks/stubs. Installing Keploy on Linux is super easy it works on **any Linux distribution** with a simple one-click installation 🚀
15+
Keploy uses eBPF to intercept API calls on network layer and generates test cases and mocks/stubs. Installing Keploy on Linux is super easy it works on **any Linux distribution** with a simple one-click installation 🚀
1616

1717
## 1. Install Keploy
1818

1919
Run the following command in your terminal:
2020

2121
```bash
2222
curl --silent -O -L https://keploy.io/install.sh && source install.sh
23-
````
23+
```
2424

2525
## 2. Verify Installation
2626

versioned_docs/version-3.0.0/installation/macos.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,20 @@ Keploy uses eBPF to intercept API calls on network layer and generates test case
1919

2020
👉 **Choose your preferred method:**
2121

22-
- [Option 1: Install Keploy with Lima](#option-1-install-keploy-with-lima)
23-
24-
- [Option 2: Install Keploy with Docker](#option-2-install-keploy-with-docker)
22+
- [Option 1: Install Keploy with Lima](#option-1-install-keploy-with-lima)
2523

24+
- [Option 2: Install Keploy with Docker](#option-2-install-keploy-with-docker)
2625

2726
## Option 1: Install Keploy with Lima
2827

2928
1. **Check if Lima is installed**
3029
If you already have Lima, Go to Step 6.
3130

32-
2. **Install Lima**
31+
2. **Install Lima**
3332

3433
```bash
3534
brew install lima
36-
````
35+
```
3736

3837
3. **Create a Debian instance**
3938

@@ -91,6 +90,7 @@ Begin recording your API calls and automatically generate test cases with Keploy
9190
```bash
9291
curl --silent -O -L https://keploy.io/install.sh && source install.sh
9392
```
93+
9494
4. **Verify the installation**
9595

9696
```bash
@@ -99,7 +99,6 @@ Begin recording your API calls and automatically generate test cases with Keploy
9999

100100
✅ If the version shows up, Keploy is installed successfully!
101101

102-
103102
## What's Next?
104103

105104
🎬 Start Capturing Test cases
@@ -120,4 +119,4 @@ keploy test -c "docker run -p 8080:8080 --name <containerName> --network keploy-
120119

121120
## 🎉 Congratulations!
122121

123-
You’ve successfully set up **Keploy on macOS** using either **Lima** or **Docker**.
122+
You’ve successfully set up **Keploy on macOS** using either **Lima** or **Docker**.

versioned_docs/version-3.0.0/installation/windows.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,31 +20,30 @@ Keploy uses eBPF to intercept API calls on network layer and generates test case
2020

2121
👉 **Choose your preferred method:**
2222

23-
- [Option 1: Install Keploy with WSL](#option-1-install-keploy-with-wsl)
24-
25-
- [Option 2: Install Keploy with Docker](#option-2-install-keploy-with-docker)
23+
- [Option 1: Install Keploy with WSL](#option-1-install-keploy-with-wsl)
2624

25+
- [Option 2: Install Keploy with Docker](#option-2-install-keploy-with-docker)
2726

2827
## Option 1: Install Keploy with WSL
2928

3029
If you already have WSL, Go to Step 2.
3130

32-
1. **Enable WSL**
31+
1. **Enable WSL**
32+
33+
Make sure you’re on:
3334

34-
Make sure you’re on:
35-
- **Windows 10** (version 2004 or later, build 19041+)
36-
- **Windows 11**
35+
- **Windows 10** (version 2004 or later, build 19041+)
36+
- **Windows 11**
3737

3838
Run the following command in PowerShell (as Administrator):
3939

4040
```shell
4141
wsl --install -d <Distribution Name>
42-
````
42+
```
4343

4444
👉 We recommend using **Ubuntu-22.04** for the best experience.
4545
(You can choose a different distribution if needed.)
4646

47-
4847
2. **Install Keploy Binary**
4948
Inside your WSL terminal, run:
5049

@@ -68,7 +67,6 @@ Begin recording your API calls and automatically generate test cases with Keploy
6867

6968
---
7069

71-
7270
## Option 2: Install Keploy with Docker
7371

7472
1. **Make sure Docker is installed**
@@ -94,7 +92,6 @@ Begin recording your API calls and automatically generate test cases with Keploy
9492

9593
✅ If the version shows up, Keploy is installed successfully!
9694

97-
9895
## What's Next?
9996

10097
🎬 Start Capturing Test cases
@@ -113,7 +110,6 @@ keploy test -c "docker run -p 8080:8080 --name <containerName> --network keploy-
113110
--delay 10 --buildDelay 60
114111
```
115112

116-
117113
## 🎉 Congratulations!
118114

119-
You’ve successfully set up **Keploy on Windows** using either **WSL** or **Docker**.
115+
You’ve successfully set up **Keploy on Windows** using either **WSL** or **Docker**.

versioned_docs/version-3.0.0/quickstart/python-flask-mongo.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ keyword:
2525

2626
🪄 Dive into the world of Student CRUD Apps and see how seamlessly Keploy integrated with Flask and MongoDB Buckle up, it's gonna be a fun ride! 🎢
2727

28-
2928
## Clone a simple Student Management API 🧪
3029

3130
```bash
@@ -36,8 +35,7 @@ git clone https://github.com/keploy/samples-python.git && cd samples-python/flas
3635

3736
There are 2 ways you can run this sample application.
3837

39-
Depending on your choice, choose your adventure:
40-
38+
Note: The sample app needs to run along with Keploy. So Depending on your choice, choose your adventure:
4139

4240
- [Using Docker compose : running application as well as Mongo on Docker container](#using-docker-compose-)
4341

@@ -47,10 +45,8 @@ Depending on your choice, choose your adventure:
4745

4846
Note: Before getting started, make sure Keploy is installed on your machine.
4947

50-
5148
We will be using Docker compose to run the application as well as Mongo on Docker container.
5249

53-
5450
### Lights, Camera, Record! 🎥
5551

5652
Capture the test-cases-
@@ -93,7 +89,6 @@ curl -X DELETE http://localhost:6000/students/12345
9389

9490
And once you are done, you can stop the recording and give yourself a pat on the back! With that simple spell, you've conjured up a test case with a mock! Explore the **keploy** directory and you'll discover your handiwork in `tests` directory and `mocks.yml`.
9591

96-
9792
Want to see if everything works as expected?
9893

9994
### Run Tests
@@ -106,8 +101,6 @@ keploy test -c "docker compose up" --container-name "flask-app" --buildDelay 50
106101

107102
> The `--delay` flag? Oh, that's just giving your app a little breather (in seconds) before the test cases come knocking.
108103
109-
110-
111104
## Running App Locally on Linux/WSL 🐧
112105

113106
Note: Before getting started, make sure Keploy is installed on your machine.
@@ -164,7 +157,6 @@ curl -X DELETE http://localhost:6000/students/12345
164157

165158
And once you are done, you can stop the recording and give yourself a pat on the back! With that simple spell, you've conjured up a test case with a mock! Explore the **keploy** directory and you'll discover your handiwork in `tests` directory and `mocks.yml`.
166159

167-
168160
## Run the tests
169161

170162
Now, it's time to put things to the test 🧪
@@ -206,4 +198,4 @@ python3 -m coverage html
206198

207199
Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible.😊🚀
208200

209-
Hope this helps you out, if you still have any questions, reach out to us .
201+
Hope this helps you out, if you still have any questions, reach out to us .

0 commit comments

Comments
 (0)