Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

V2 docs #187

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 22 additions & 22 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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](hello@keploy.io)
- [Slack](https://join.slack.com/t/keploy/shared_invite/zt-12rfbvc01-o54cOG0X1G6eVJTuI_orSA)
- [Mail](hello@keploy.io)

## Support 🙏
## Support 🙏

This project needs a ⭐️ from you. Don't forget to leave a star ⭐️

Expand Down
2 changes: 1 addition & 1 deletion docs/keploy-explained/how-keploy-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
7 changes: 3 additions & 4 deletions docs/operation/record.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
13 changes: 6 additions & 7 deletions docs/operation/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
15 changes: 8 additions & 7 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ module.exports = {
srcDark: "img/keploy-logo-dark.svg",
},
items: [
{
{
to: "/docs/keploy-explained/introduction",
activeBasePath: "none",
label: "Explanation",
Expand All @@ -97,11 +97,6 @@ module.exports = {
"(/application-development)|(/docs/(go|java|php|node))",
label: "Installation",
},
{
to: "/docs/devtools/sdk-contrib-guide/",
activeBasePath: "(/docs/devtools)",
label: "Contributor Guide",
},
// {
// to: "/docs/hacktoberfest/contribution-guide/",
// activeBasePath: "(/docs/hacktoberfest)",
Expand Down Expand Up @@ -170,6 +165,12 @@ module.exports = {
// },
// ],
// },
{
type: 'docsVersionDropdown',
position: 'left',
dropdownItemsAfter: [{to: '/versions'}],
dropdownActiveClassDisabled: true,
},
{
href: "https://github.com/keploy/keploy",
position: "right",
Expand Down Expand Up @@ -205,7 +206,7 @@ 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
},
},
Expand Down
Loading