Skip to content

Commit 203e749

Browse files
committed
feat: add enterprise banner and improve sidebar
Signed-off-by: Achanandhi-M <[email protected]>
1 parent 502029a commit 203e749

Some content is hidden

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

55 files changed

+341
-125
lines changed

src/components/ProductTier.js

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
import React from "react";
2+
3+
const ProductTier = ({tiers, offerings}) => {
4+
return (
5+
<div className="my-4 rounded-lg border border-gray-300 bg-[#fff8f5] p-4 text-gray-900 shadow-sm dark:border-gray-700 dark:bg-[#23272f] dark:text-gray-100">
6+
<div className="flex flex-col gap-2">
7+
{tiers && (
8+
<div className="flex flex-wrap items-center gap-2">
9+
<span className="font-bold">Tier:</span>
10+
<span>{Array.isArray(tiers) ? tiers.join(", ") : tiers}</span>
11+
</div>
12+
)}
13+
{offerings && (
14+
<div className="flex flex-wrap items-center gap-2">
15+
<span className="font-bold">Offering:</span>
16+
<span>
17+
{Array.isArray(offerings) ? offerings.join(", ") : offerings}
18+
</span>
19+
</div>
20+
)}
21+
</div>
22+
</div>
23+
);
24+
};
25+
26+
export default ProductTier;

src/components/QuickStartList.js

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ const quickstarts = [
100100
},
101101
*/
102102

103-
/*{
103+
{
104104
title: "Gin + Redis",
105105
language: "Go",
106106
server: "Docker",
@@ -116,7 +116,6 @@ const quickstarts = [
116116
"A sample User Authentication app to demonstrate how seamlessly Keploy integrates with Gin and Redis.",
117117
link: "/docs/quickstart/samples-redis/#running-app-locally-on-linuxwsl-",
118118
},
119-
*/
120119
{
121120
title: "Mux + Postgres",
122121
language: "Go",
@@ -204,15 +203,14 @@ const quickstarts = [
204203

205204
// python list
206205

207-
/*{
206+
{
208207
title: "E-commerce Microservices",
209208
language: "Python",
210209
server: "Docker",
211210
description:
212211
"This guide walks you through testing an E-commerce microservices application using Keploy.",
213212
link: "/docs/quickstart/samples-microservices/",
214213
},
215-
*/
216214
{
217215
title: "Django + Postgres",
218216
language: "Python",
@@ -281,6 +279,15 @@ const quickstarts = [
281279
link: "/docs/quickstart/samples-fastapi-twilio/#using-docker-compose-",
282280
},
283281

282+
{
283+
title: "Python + K8s",
284+
language: "Python",
285+
server: "Docker",
286+
description:
287+
"A sample guide demonstrating how to perform live traffic recording and replay in a Kubernetes environment.",
288+
link: "/docs/quickstart/k8s-proxy/",
289+
},
290+
284291
/*{
285292
title: "Sanic + Mongo",
286293
language: "Python",
@@ -290,15 +297,14 @@ const quickstarts = [
290297
link: "/docs/quickstart/sanic-mongo/",
291298
},
292299
*/
293-
/*{
294-
title: "Flask + Redis",
295-
language: "Python",
296-
server: "Docker",
297-
description:
298-
"A sample Student CRUD app to demonstrate how seamlessly Keploy integrates with Flask and Redis.",
299-
link: "/docs/quickstart/flask-redis/",
300-
},
301-
*/
300+
{
301+
title: "Flask + Redis",
302+
language: "Python",
303+
server: "Docker",
304+
description:
305+
"A sample Student CRUD app to demonstrate how seamlessly Keploy integrates with Flask and Redis.",
306+
link: "/docs/quickstart/flask-redis/",
307+
},
302308

303309
//Javascript list
304310

src/theme/DocItem/index.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,9 @@ export default function DocItem(props) {
9797
const modifiedTime = toIsoDate(
9898
metadata?.lastUpdatedAt || frontMatter?.lastUpdatedAt
9999
);
100-
const publishedTime = toIsoDate(frontMatter?.date || frontMatter?.publishedAt);
100+
const publishedTime = toIsoDate(
101+
frontMatter?.date || frontMatter?.publishedAt
102+
);
101103
const schemaTypeFromFrontMatter =
102104
frontMatter?.schemaType || frontMatter?.schema_type;
103105
const isApi =

tailwind.config.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ const em = (px, base) => `${round(px / base)}em`;
88

99
module.exports = {
1010
mode: "jit",
11+
darkMode: ["class", '[data-theme="dark"]'],
1112
content: [
1213
"./src/components/**/*.{js,ts,jsx,tsx}",
1314
"./src/pages/**/*.{js,ts,jsx,tsx}",

versioned_docs/version-3.0.0/ci-cd/github.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ tags:
1414
- plugin
1515
---
1616

17+
import ProductTier from '@site/src/components/ProductTier';
18+
19+
<ProductTier tiers="Open Source, Enterprise" offerings="Self-Hosted, Dedicated" />
20+
1721
Keploy can be integrated with GitHub by two methods:-
1822

1923
1. [Using Shell Scripts](#shell-scripts)

versioned_docs/version-3.0.0/ci-cd/gitlab.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ tags:
1414
- plugin
1515
---
1616

17+
import ProductTier from '@site/src/components/ProductTier';
18+
19+
<ProductTier tiers="Open Source, Enterprise" offerings="Self-Hosted, Dedicated" />
20+
1721
Keploy can integrated with GitLab CI to streamline your testing process and ensure continuous testing as part of your CI/CD pipeline.
1822

1923
## Create pipeline

versioned_docs/version-3.0.0/ci-cd/jenkins.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ tags:
1414
- plugin
1515
---
1616

17+
import ProductTier from '@site/src/components/ProductTier';
18+
19+
<ProductTier tiers="Open Source, Enterprise" offerings="Self-Hosted, Dedicated" />
20+
1721
Keploy can integrated with Jenkins to ensure continuous testing as part of your CI/CD pipeline.
1822

1923
## Prerequisites

versioned_docs/version-3.0.0/keploy-cloud/deduplication.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ keywords:
1515
- testcases
1616
---
1717

18+
import ProductTier from '@site/src/components/ProductTier';
19+
20+
<ProductTier tiers="Enterprise" offerings="Self-Hosted, Dedicated" />
21+
1822
## Why Deduplication? ❄️
1923

2024
When developing or maintaining a software, it is common for test suites to grow in size. This often results in redundancy, as many test cases cover the same functions or scenarios. This is where Test Deduplication comes into play.
Lines changed: 37 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,72 @@
11
---
22
id: cloud-installation
3-
title: Keploy Cloud Installation
4-
sidebar_label: Installation
3+
title: Keploy Enterprise Installation
4+
sidebar_label: Enterprise Installation
55
tags:
66
- explanation
77
- feature guide
8-
- keploy cloud
8+
- keploy enterprise
99
- installation
1010
keywords:
11-
- keploy cloud
11+
- keploy enterprise
1212
- installation
1313
- API key
1414
---
1515

16-
## Introduction 📘
16+
import ProductTier from '@site/src/components/ProductTier';
1717

18-
#### Welcome to the Keploy Cloud Guide!
18+
<ProductTier tiers="Enterprise" offerings="Self-Hosted, Dedicated" />
1919

20-
In this guide, you will find information about Keploy Cloud, onboarding, features, and how to use them.
20+
This guide provides a complete overview of **Keploy Enterprise**, including onboarding instructions, key features, and steps to get started. It is designed to help teams quickly adopt Keploy Enterprise and integrate it into their development and testing workflows.
2121

22-
#### Requesting a Keploy Cloud Account
22+
### Requesting a Keploy Enterprise Account
2323

24-
To request a Keploy Cloud account, please complete the request form [here](https://forms.gle/jGBbyRyh9H7AKXZX6). Our team will review your request and get back to you as soon as possible.
24+
To get access to Keploy Enterprise, you’ll first need an enterprise account.
2525

26-
#### Getting Started with Keploy Cloud
26+
#### Note: You can request one by reaching out to us [here](https://calendar.app.google/cXVaj6hbMUjvmrnt9).
2727

28-
Once your account is set up, you can start exploring features of Keploy Cloud. Here are some key features to can get started with:
28+
---
29+
30+
### Getting Started with Keploy Enterprise
2931

30-
- **Time Freezing** ❄️: Keploy Cloud allows you to freeze/rollback the time in every test run, back to when the test case was recorded. This allows developers to ensure time-sensitive objects don’t expire or change, making tests consistent and more reliable.
32+
Once your enterprise account is set up, you can begin exploring and using the core features of Keploy Enterprise. Below are some of the key capabilities that help teams achieve reliable, scalable, and production-grade API testing.
3133

32-
- **AI-Driven Test Generation** 🧠: Keploy will automatically uncover your API's edge cases and generate test cases to expose more code paths, thereby increasing code coverage.
34+
- **Time Freezing** ❄️
35+
Keploy Enterprise allows you to freeze or roll back time during every test run to the exact moment when the test case was recorded. This ensures that time-sensitive data does not expire or change, making test executions consistent and highly reliable.
3336

34-
- **Test Deduplication** 📊 : Keploy detects duplicate/redundant tests automatically, which will be particularly useful if you plan to record numerous scenarios from a live environment and wish to retain only unique scenario tests.
37+
- **AI-Driven Test Generation** 🧠
38+
Keploy Enterprise automatically identifies edge cases in your APIs and generates test cases to uncover additional execution paths. This helps improve overall code coverage and detect issues that are often missed in manual testing.
3539

36-
- **Keploy Console** 📈: We are ensuring a smooth experience of visualising bugs found with Keploy and sharing reports with your team.
40+
- **Test Deduplication** 📊
41+
Keploy Enterprise intelligently detects and removes duplicate or redundant test cases. This is especially useful when recording scenarios from live environments, allowing teams to retain only meaningful and unique test coverage.
3742

38-
- **Asynchronous Processes Support** ⏱ : Keploy V2 captures and replays asynchronous tasks effectively. We're also incorporating support for adding custom user-defined behaviours or assertions.
43+
- **Keploy Console** 📈
44+
The Keploy Console provides a seamless experience for visualizing bugs, analyzing test results, and sharing reports across teams. It enables better collaboration and faster feedback cycles.
3945

40-
- **Mock Registry** 📂: The Mock Registry is a system designed to handle large mock files by uploading them to cloud storage, preventing these sizable files from being committed to Git repositories. This approach optimizes repository size and performance while maintaining an efficient and streamlined development workflow.
46+
- **Asynchronous Processes Support**
47+
Keploy v2 effectively captures and replays asynchronous workflows. In addition, support for custom user-defined behaviors and assertions is being incorporated to provide greater flexibility in testing complex systems.
4148

42-
To get started with Keploy Cloud, you will need to install the Keploy Cloud Agent and authenticate your account.
49+
- **Mock Registry** 📂
50+
The Mock Registry is designed to manage large mock files by storing them in cloud storage instead of committing them to Git repositories. This helps keep repositories lightweight while ensuring efficient mock management at scale.
51+
52+
To begin using Keploy Enterprise, you need to install the **Keploy Enterprise Agent** and authenticate using your API key.
53+
54+
---
4355

4456
## Installation 🛠️
4557

46-
Install and Validate the Keploy Cloud Agent by following the steps below:
58+
Follow the steps below to install and validate the Keploy Enterprise Agent:
4759

4860
```bash
4961
curl --silent -O -L https://keploy.io/ent/install.sh && source install.sh
5062
```
5163

52-
Enter your **API Key** when prompted, ask your org Admin to re-regenerate the API key in case you lose it.
64+
When recording API calls using the Enterprise Agent, you will be prompted to provide your **API key**.
5365

54-
Once validated, you can start using Keploy Cloud to record-test.
66+
An API key typically looks like this:
5567

56-
### Need Help?
68+
```
69+
b1dNl....
70+
```
5771

58-
If you have any questions or need assistance, our support team is here to help. You can reach out to us through our support portal, Slack or by emailing us at hello[at]keploy.io.
72+
Once the API key is successfully validated, the Keploy Enterprise Agent will begin recording API calls.

versioned_docs/version-3.0.0/keploy-cloud/keploy-console.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ keywords:
1313
- API key
1414
---
1515

16+
import ProductTier from '@site/src/components/ProductTier';
17+
18+
<ProductTier tiers="Enterprise" offerings="Self-Hosted, Dedicated" />
19+
1620
### Pre-requisite 📝
1721

1822
Ensure you have [installed keploy enterprise](/docs/keploy-cloud/cloud-installation/#installation-%EF%B8%8F).

0 commit comments

Comments
 (0)