diff --git a/docusaurus.config.js b/docusaurus.config.js index a309aa12b..d758468c5 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -13,6 +13,11 @@ module.exports = { url: "https://keploy.io", baseUrl: "/docs/", onBrokenLinks: "throw", + markdown: { + hooks: { + onBrokenMarkdownLinks: "warn", + }, + }, trailingSlash: true, favicon: "img/favicon.png", organizationName: "keploy", // Usually your GitHub org/user name. diff --git a/versioned_docs/version-2.0.0/concepts/platform-requirements.md b/versioned_docs/version-2.0.0/concepts/platform-requirements.md index 36ed4bc99..913724f3f 100644 --- a/versioned_docs/version-2.0.0/concepts/platform-requirements.md +++ b/versioned_docs/version-2.0.0/concepts/platform-requirements.md @@ -27,7 +27,7 @@ Linux: | Operating System | Without Docker | Docker Installation | Prerequisites | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| MacOS **MacOS** | [Guide](/keploy-explained/mac-linux.md) | [Guide](/server/installation/) | - Docker Desktop version must be 4.25.2 or above
| +| MacOS **MacOS** | [Guide](/keploy-explained/mac-linux.md) | [Guide](../server/installation.md#other-installation-methods) | - Docker Desktop version must be 4.25.2 or above
| | Windows **Windows** | Supported | Supported | - Use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install#install-wsl-command) `wsl --install`
- Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11 | | Linux **Linux** | Supported | Supported | Linux kernel 5.15 or higher | diff --git a/versioned_docs/version-2.0.0/keploy-explained/mac-linux.md b/versioned_docs/version-2.0.0/keploy-explained/mac-linux.md index f5a839465..068a270ba 100644 --- a/versioned_docs/version-2.0.0/keploy-explained/mac-linux.md +++ b/versioned_docs/version-2.0.0/keploy-explained/mac-linux.md @@ -56,8 +56,8 @@ Congratulations! You've successfully set up Keploy natively on MacOS. ## What's Next? -### 🎬 [Start Capturing Testcases](/docs/server/installation/) +### 🎬 [Start Capturing Test Cases](../server/installation.md#capturing-test-cases) Begin recording your API calls and generating test cases with Keploy. -#### [Back to Installation Guide](/docs/server/installation/) +#### [Back to Installation Guide](../server/installation.md) diff --git a/versioned_docs/version-2.0.0/server/installation.md b/versioned_docs/version-2.0.0/server/installation.md index 2abc3dfa4..a38d5598d 100644 --- a/versioned_docs/version-2.0.0/server/installation.md +++ b/versioned_docs/version-2.0.0/server/installation.md @@ -27,7 +27,7 @@ import InstallationGuide from '../concepts/installation.md' -## 🎬 Capturing Testcases +## 🎬 Capturing Test Cases {#capturing-test-cases} To initiate the recording of API calls, execute this command in your terminal: @@ -41,7 +41,7 @@ For example, if you're using a simple Golang program, the **CMD_TO_RUN_APP** wou keploy record -c "go run main.go" ``` -## πŸƒ Running Testcases +## πŸƒ Running Test Cases To run the testcases and see if there are any regressions introduced, use this terminal command: diff --git a/versioned_docs/version-3.0.0/concepts/platform-requirements.md b/versioned_docs/version-3.0.0/concepts/platform-requirements.md index 98fb3cfd8..f3c34101a 100644 --- a/versioned_docs/version-3.0.0/concepts/platform-requirements.md +++ b/versioned_docs/version-3.0.0/concepts/platform-requirements.md @@ -27,8 +27,8 @@ Linux: | Operating System | Without Docker | Docker Installation | Prerequisites | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| MacOS **MacOS** | [Guide](/keploy-explained/mac-linux.md) | [Guide](/server/installation/) | - Docker Desktop version must be 4.25.2 or above
- Ensure that Lima is installed on your machine if you prefer to try without Docker. | -| Windows **Windows** | [Guide](/keploy-explained/windows-wsl.md) | [Guide](/server/installation/) | - Use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install#install-wsl-command) `wsl --install`
- Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11
- Ensure that Docker Desktop version 4.25.2 or above is installed if you are following the Docker installation guide | +| MacOS **MacOS** | [Guide](/keploy-explained/mac-linux.md) | [Guide](../server/installation.md#other-installation-methods) | - Docker Desktop version must be 4.25.2 or above
- Ensure that Lima is installed on your machine if you prefer to try without Docker. | +| Windows **Windows** | [Guide](/keploy-explained/windows-wsl.md) | [Guide](../server/installation.md#other-installation-methods) | - Use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install#install-wsl-command) `wsl --install`
- Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11
- Ensure that Docker Desktop version 4.25.2 or above is installed if you are following the Docker installation guide | | Linux **Linux** | Supported | Supported | Linux kernel 5.15 or higher | On MacOS and Windows, additional tools are required for Keploy due to the lack of native eBPF support. diff --git a/versioned_docs/version-3.0.0/installation/linux.md b/versioned_docs/version-3.0.0/installation/linux.md index a3001ddb6..f3dc0b151 100644 --- a/versioned_docs/version-3.0.0/installation/linux.md +++ b/versioned_docs/version-3.0.0/installation/linux.md @@ -38,6 +38,6 @@ You’ve successfully installed **Keploy on Linux**. ## What's Next? -### 🎬 [Start Capturing Test Cases](/docs/server/installation/) +### 🎬 [Start Capturing Test Cases](../server/installation.md#capturing-test-cases) Begin recording your API calls and automatically generate test cases with Keploy. diff --git a/versioned_docs/version-3.0.0/installation/macos.md b/versioned_docs/version-3.0.0/installation/macos.md index d0fe68756..bfa90d70a 100644 --- a/versioned_docs/version-3.0.0/installation/macos.md +++ b/versioned_docs/version-3.0.0/installation/macos.md @@ -68,7 +68,7 @@ Keploy uses eBPF to intercept API calls on network layer and generates test case ## What's Next? -### 🎬 [Start Capturing Test Cases](/docs/server/installation/) +### 🎬 [Start Capturing Test Cases](../server/installation.md#capturing-test-cases) Begin recording your API calls and automatically generate test cases with Keploy. diff --git a/versioned_docs/version-3.0.0/installation/windows.md b/versioned_docs/version-3.0.0/installation/windows.md index dee4c24d3..9984c6ee1 100644 --- a/versioned_docs/version-3.0.0/installation/windows.md +++ b/versioned_docs/version-3.0.0/installation/windows.md @@ -61,7 +61,7 @@ If you already have WSL, Go to Step 2. ## What's Next? -### 🎬 [Start Capturing Test Cases](/docs/server/installation/) +### 🎬 [Start Capturing Test Cases](../server/installation.md#capturing-test-cases) Begin recording your API calls and automatically generate test cases with Keploy. diff --git a/versioned_docs/version-3.0.0/keploy-explained/mac-linux.md b/versioned_docs/version-3.0.0/keploy-explained/mac-linux.md index 95de48e72..4d1924ab9 100644 --- a/versioned_docs/version-3.0.0/keploy-explained/mac-linux.md +++ b/versioned_docs/version-3.0.0/keploy-explained/mac-linux.md @@ -56,8 +56,8 @@ Congratulations! You've successfully set up Keploy natively on MacOS. ## What's Next? -### 🎬 [Start Capturing Testcases](/docs/server/installation/) +### 🎬 [Start Capturing Test Cases](../server/installation.md#capturing-test-cases) Begin recording your API calls and generating test cases with Keploy. -#### [Back to Installation Guide](/docs/server/installation/) +#### [Back to Installation Guide](../server/installation.md) diff --git a/versioned_docs/version-3.0.0/keploy-explained/windows-wsl.md b/versioned_docs/version-3.0.0/keploy-explained/windows-wsl.md index 75705390a..682f842c4 100644 --- a/versioned_docs/version-3.0.0/keploy-explained/windows-wsl.md +++ b/versioned_docs/version-3.0.0/keploy-explained/windows-wsl.md @@ -38,8 +38,8 @@ Congratulations! You've successfully set up Keploy natively on Windows. ## What's Next? -### 🎬 [Start Capturing Testcases](/docs/server/installation/) +### 🎬 [Start Capturing Test Cases](../server/installation.md#capturing-test-cases) Begin recording your API calls and generating test cases with Keploy. -#### [Back to Installation Guide](/docs/server/installation/) +#### [Back to Installation Guide](../server/installation.md) diff --git a/versioned_docs/version-3.0.0/server/installation.md b/versioned_docs/version-3.0.0/server/installation.md index 2dfcd450e..622f5d033 100644 --- a/versioned_docs/version-3.0.0/server/installation.md +++ b/versioned_docs/version-3.0.0/server/installation.md @@ -27,7 +27,7 @@ import InstallationGuide from '../concepts/installation.md' -## 🎬 Capturing Testcases +## 🎬 Capturing Test Cases {#capturing-test-cases} To initiate the recording of API calls, execute this command in your terminal: @@ -41,7 +41,7 @@ For example, if you're using a simple Golang program, the **CMD_TO_RUN_APP** wou keploy record -c "go run main.go" ``` -## πŸƒ Running Testcases +## πŸƒ Running Test Cases To run the testcases and see if there are any regressions introduced, use this terminal command: diff --git a/versioned_docs/version-3.0.0/server/installation_tabs.md b/versioned_docs/version-3.0.0/server/installation_tabs.md index fc99df2b5..411f4c0bd 100644 --- a/versioned_docs/version-3.0.0/server/installation_tabs.md +++ b/versioned_docs/version-3.0.0/server/installation_tabs.md @@ -352,6 +352,7 @@ Add the directory containing the Keploy binary to your system user’s `PATH` en Use "keploy [command] --help" for more information about a command. ``` + ## πŸŽ‰ Congratulations! You’ve successfully installed **Keploy on Windows**.