[docs]: documentation update for keploy v2 (#189)

* fix: metadata description duplication corrected Signed-off-by: Animesh Pathak <[email protected]> * feat: linux docs updated Signed-off-by: Animesh Pathak <[email protected]> * feat: docs revamp Signed-off-by: Animesh <[email protected]> * feat: alignment fixed, macos updated, versioning fixed Signed-off-by: Animesh <[email protected]> * feat: added v1 sample-apps guide to docs Signed-off-by: Animesh <[email protected]> * fix: versioning of docs based on keploy version and UI update Signed-off-by: Animesh <[email protected]> * fix: versioning of docs based on keploy version and UI update Signed-off-by: Animesh <[email protected]> * fix: versioning of docs based on keploy version and UI update Signed-off-by: Animesh <[email protected]> --------- Signed-off-by: Animesh Pathak <[email protected]> Signed-off-by: Animesh <[email protected]> Co-authored-by: Animesh Pathak <[email protected]>
keploy · Sep 12, 2023 · 1ef5e1d · 1ef5e1d
1 parent e80484a
commit 1ef5e1d
Show file tree

Hide file tree

Showing 165 changed files with 8,474 additions and 517 deletions.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -16,27 +16,27 @@ diverse, inclusive, and healthy community.
 
 The following behaviors are expected and requested of all community members:
 
- * Act authentically and participate actively in the community to help maintain a positive and productive environment.
- * Show consideration and respect in all your actions and speech. Avoid any behavior that is demeaning, discriminatory, or harassing.
- * Seek collaboration as an initial step instead of conflict.
- * Refrain from demeaning, discriminatory, or harassing behavior and speech.
- * Report any unsafe situations, distress or violations of the code of conduct to the maintainers through [Slack](https://join.slack.com/t/keploy/shared_invite/zt-12rfbvc01-o54cOG0X1G6eVJTuI_orSA).
-* Practice empathy and kindness towards other community members.
-* Respect diverse opinions, perspectives, and experiences.
-* Give and receive constructive feedback in a gracious manner.
-* Take responsibility for your actions and apologize for mistakes. Use them as learning opportunities.
-* Prioritize the well-being and success of the community as a whole over individual gain.
+- Act authentically and participate actively in the community to help maintain a positive and productive environment.
+- Show consideration and respect in all your actions and speech. Avoid any behavior that is demeaning, discriminatory, or harassing.
+- Seek collaboration as an initial step instead of conflict.
+- Refrain from demeaning, discriminatory, or harassing behavior and speech.
+- Report any unsafe situations, distress or violations of the code of conduct to the maintainers through [Slack](https://join.slack.com/t/keploy/shared_invite/zt-12rfbvc01-o54cOG0X1G6eVJTuI_orSA).
+- Practice empathy and kindness towards other community members.
+- Respect diverse opinions, perspectives, and experiences.
+- Give and receive constructive feedback in a gracious manner.
+- Take responsibility for your actions and apologize for mistakes. Use them as learning opportunities.
+- Prioritize the well-being and success of the community as a whole over individual gain.
 
 Examples of unacceptable behavior include:
 
-* Violence, threats of violence or any language that incites violence towards any individual or group is prohibited.
- * Discriminatory jokes and language, such as those based on gender, race, sexual orientation, religion, ability, or any other characteristic, is strictly forbidden.
- * Displaying or sharing sexually explicit or violent content is prohibited.
- * Any form of harassment, including but not limited to "doxing" (posting or threatening to post other people's personally identifying information) is prohibited.
- * Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
-* Publishing any personal information of others without their explicit consent is strictly forbidden.
-* Using sexualized language or imagery, or making any sexual advances towards another person is prohibited.
-* Harassment, whether it be public or private, will not be tolerated.
+- Violence, threats of violence or any language that incites violence towards any individual or group is prohibited.
+- Discriminatory jokes and language, such as those based on gender, race, sexual orientation, religion, ability, or any other characteristic, is strictly forbidden.
+- Displaying or sharing sexually explicit or violent content is prohibited.
+- Any form of harassment, including but not limited to "doxing" (posting or threatening to post other people's personally identifying information) is prohibited.
+- Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
+- Publishing any personal information of others without their explicit consent is strictly forbidden.
+- Using sexualized language or imagery, or making any sexual advances towards another person is prohibited.
+- Harassment, whether it be public or private, will not be tolerated.
 
 ## Enforcement Responsibilities
 
@@ -108,18 +108,18 @@ Violating these terms may lead to a permanent ban.
 ### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
+standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within
 the community.
 
 ## Contact info
 
-* [Slack](https://join.slack.com/t/keploy/shared_invite/zt-12rfbvc01-o54cOG0X1G6eVJTuI_orSA)
-* [Mail]([email protected])
+- [Slack](https://join.slack.com/t/keploy/shared_invite/zt-12rfbvc01-o54cOG0X1G6eVJTuI_orSA)
+- [Mail]([email protected])
 
-## Support 🙏 
+## Support 🙏
 
 This project needs a ⭐️ from you. Don't forget to leave a star ⭐️
 

diff --git a/docs/keploy-explained/how-keploy-works.md b/docs/keploy-explained/how-keploy-works.md
@@ -41,4 +41,4 @@ You can test with Keploy locally or can integrate Keploy with popular testing-fr
 
 > **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.
 
-![How it works](../../static/gif/record-replay.gif)
+![How it works](../../static/gif/record-replay.gif)
diff --git a/docs/keploy-explained/introduction.md b/docs/keploy-explained/introduction.md
@@ -19,7 +19,3 @@ import WhatAreKeployFeatures from '../concepts/what-are-keploy-features.md'
 import WhatIsAKeploySDK from '../concepts/what-is-a-keploy-sdk.md'
 
 <WhatIsAKeploySDK/>
-
-### Integrate SDK
-
-**Choose programming language to integrate [Keploy SDK](/application-development).**
diff --git a/docs/operation/record.md b/docs/operation/record.md
@@ -10,17 +10,16 @@ tags:
 
 > Note that Testcases are exported as files in the project directory by default
 
-
 To record API calls as test cases set `KEPLOY_MODE` environment variable to `record`.
 
 ```
 export KEPLOY_MODE="record"
 ```
 
-That's it! 🔥 As you make API calls to your application, new test-cases are being generated locally in  `keploy-tests` directory.
+That's it! 🔥 As you make API calls to your application, new test-cases are being generated locally in `keploy-tests` directory.
 
->> KTest directory path (`KEPLOY_TEST_PATH`) is configurable. 
+> > KTest directory path (`KEPLOY_TEST_PATH`) is configurable.
 
 ![Record Tests and Mocks](../../static/gif/record-tc.gif "Record Tests and Mocks")
 
->> KMock directory path (`KEPLOY_MOCK_PATH`) is configurable.
+> > KMock directory path (`KEPLOY_MOCK_PATH`) is configurable.
diff --git a/docs/operation/test.md b/docs/operation/test.md
@@ -9,23 +9,22 @@ tags:
   - replay-tests
 ---
 
-To run KTests and KMocks you can follow any one of these methods: 
-
-### Method 1 
+To run KTests and KMocks you can follow any one of these methods:
 
+### Method 1
 
 <details><summary>
 Set Environment Variable `KEPLOY_MODE`
 
 </summary>
 
 ```
-export KEPLOY_MODE="test" 
+export KEPLOY_MODE="test"
 ```
 
-Run application and find test report summary on the Keploy Server Logs and detailed test report 
-in directory where Keploy Server is running. 
+Run application and find test report summary on the Keploy Server Logs and detailed test report
+in directory where Keploy Server is running.
 
 ![Test report summary](../../static/gif/replay-tc.gif)
 
-</details>
+</details>
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -75,11 +75,15 @@ module.exports = {
         srcDark: "img/keploy-logo-dark.svg",
       },
       items: [
-    {
+        {
           to: "/docs/keploy-explained/introduction",
           activeBasePath: "none",
           label: "Explanation",
         },
+        {
+          to: "/application-development",
+          label: "Installation",
+        },
         // {
         //   to: "/docs/operation/web-ui-operations/",
         //   activeBasePath: "(/docs/operation)",
@@ -92,15 +96,12 @@ module.exports = {
         //   label: "test SDKs",
         // },
         {
-          to: "/application-development",
-          activeBaseRegex:
-            "(/application-development)|(/docs/(go|java|php|node))",
-          label: "Installation",
+          to: "https://community.keploy.io",
+          label: "KB Articles",
         },
         {
-          to: "/docs/devtools/sdk-contrib-guide/",
-          activeBasePath: "(/docs/devtools)",
-          label: "Contributor Guide",
+          to: "https://blog.keploy.io",
+          label: "Blog",
         },
         // {
         //   to: "/docs/hacktoberfest/contribution-guide/",
@@ -170,6 +171,14 @@ module.exports = {
         //     },
         //   ],
         // },
+        {
+          type: 'docsVersionDropdown',
+          position: 'right',
+          dropdownItemsAfter: [{
+            to: '/docs/server/linux/installation',
+          }],
+          dropdownActiveClassDisabled: true,
+        },
         {
           href: "https://github.com/keploy/keploy",
           position: "right",
@@ -205,9 +214,10 @@ module.exports = {
       apiKey: "c4628c331b0f4997178c879978033276",
       indexName: "keploy",
       appId: "WZTL8PLCOD",
-      // contextualSearch: true, // Optional, If you different version of docs etc (v1 and v2) doesn't display dup results
+      contextualSearch: false, // Optional, If you different version of docs etc (v1 and v2) doesn't display dup results
       // algoliaOptions: {}, // Optional, if provided by Algolia
     },
+
   },
   presets: [
     [
@@ -233,6 +243,15 @@ module.exports = {
            * in `/docs/next` directory, only versioned docs.
            */
           // excludeNextVersionDocs: false,
+          lastVersion: '2.0.0',
+          versions: {
+            '1.0.0': {
+              label: '1.0.0',
+              path: '1.0.0',
+              banner: 'unmaintained',
+            },
+          },
+          onlyIncludeVersions: ["1.0.0","2.0.0"],
           includeCurrentVersion: true, // excludeNextVersionDocs is now deprecated
           // // below remark plugin disabled until we can figure out why it is not transpiling to ESNext properly - swyx
           remarkPlugins: [