From 848f3dec1943b52490729f60fcf9b7da5100a34a Mon Sep 17 00:00:00 2001 From: Sambhav Gupta <81870866+sambhavgupta0705@users.noreply.github.com> Date: Wed, 4 Oct 2023 21:05:01 +0530 Subject: [PATCH] docs: added contribution guidelines as a seperate page (#226) * fix: fixed dev-guide (#219) * fix: fixed dev-guide Signed-off-by: 404fixer * fix: dev-guide Signed-off-by: 404fixer --------- Signed-off-by: 404fixer Signed-off-by: Sambhav Gupta * feat: initial commit to add contributing guide Signed-off-by: Sambhav Gupta * fix: changed the route Signed-off-by: Sambhav Gupta * fix: signed off commit Signed-off-by: Sambhav Gupta * fix: fixed the link and reverted yarn lock Signed-off-by: Sambhav Gupta * docs: update the test command (#222) Signed-off-by: Akash Kumar Signed-off-by: Sambhav Gupta * docs: add arm section in linux installation (#225) Signed-off-by: Akash Kumar <91385321+AkashKumar7902@users.noreply.github.com> Signed-off-by: Sambhav Gupta * feat: added bun-mongo and express-mongo (#224) * fix: broken images fixed-I Signed-off-by: Animesh * fix: images name updated to fix the broken images Signed-off-by: Animesh * feat: added more ways to run samples-gin Signed-off-by: Animesh * feat: added more ways to run samples-gin Signed-off-by: Animesh * fix: added pull always tag for latest keploy pull in docker Signed-off-by: Animesh * feat: added wsl commands and fixed the url for keploy binary Signed-off-by: Animesh * feat: added wsl commands and fixed the url for keploy binary Signed-off-by: Animesh * feat: added new sample apps Signed-off-by: Animesh * feat: added new sample apps Signed-off-by: Animesh * feat: added new sample apps Signed-off-by: Animesh * fix: alias typo Signed-off-by: Animesh * feat: new sample apps added Signed-off-by: Animesh * fix: broken url Signed-off-by: Animesh --------- Signed-off-by: Animesh Signed-off-by: Sambhav Gupta * feat: added hacktoberfest section (#227) * fix: broken images fixed-I Signed-off-by: Animesh * fix: images name updated to fix the broken images Signed-off-by: Animesh * feat: added more ways to run samples-gin Signed-off-by: Animesh * feat: added more ways to run samples-gin Signed-off-by: Animesh * fix: added pull always tag for latest keploy pull in docker Signed-off-by: Animesh * feat: added wsl commands and fixed the url for keploy binary Signed-off-by: Animesh * feat: added wsl commands and fixed the url for keploy binary Signed-off-by: Animesh * feat: added new sample apps Signed-off-by: Animesh * feat: added new sample apps Signed-off-by: Animesh * feat: added new sample apps Signed-off-by: Animesh * fix: alias typo Signed-off-by: Animesh * feat: new sample apps added Signed-off-by: Animesh * fix: broken url Signed-off-by: Animesh * fix: broken url Signed-off-by: Animesh * feat: added and updated hacktoberfest section Signed-off-by: Animesh --------- Signed-off-by: Animesh Signed-off-by: Sambhav Gupta * fix: new line Signed-off-by: Sambhav Gupta * feat: lint check Signed-off-by: Sambhav Gupta * fix: prettier code Signed-off-by: Sambhav Gupta --------- Signed-off-by: 404fixer Signed-off-by: Sambhav Gupta Signed-off-by: Akash Kumar Signed-off-by: Akash Kumar <91385321+AkashKumar7902@users.noreply.github.com> Signed-off-by: Animesh Co-authored-by: Govind Tomar <54830844+404fixer@users.noreply.github.com> Co-authored-by: Akash Kumar <91385321+AkashKumar7902@users.noreply.github.com> Co-authored-by: Animesh Pathak <53110238+Sonichigo@users.noreply.github.com> Signed-off-by: schauhan2 --- .../keploy-explained/docs-dev-guide.md | 127 ++++++++++++++++++ .../version-2.0.0-sidebars.json | 3 +- 2 files changed, 129 insertions(+), 1 deletion(-) create mode 100644 versioned_docs/version-2.0.0/keploy-explained/docs-dev-guide.md diff --git a/versioned_docs/version-2.0.0/keploy-explained/docs-dev-guide.md b/versioned_docs/version-2.0.0/keploy-explained/docs-dev-guide.md new file mode 100644 index 000000000..45a8051b1 --- /dev/null +++ b/versioned_docs/version-2.0.0/keploy-explained/docs-dev-guide.md @@ -0,0 +1,127 @@ +--- +id: docs-dev-guide +title: docs-dev-guide +sidebar_label: Docs Dev Guide +tags: + - dev guide + - explanation + - contributing +--- + +# How to contribute + +We encourage contributions from the community. + +**Create a [GitHub issue](https://github.com/keploy/docs/issues) for any changes beyond typos and small fixes.** + +If you do create a pull request (PR), please follow our [style guidance](/STYLE.md). + +We review GitHub issues and PRs on a regular schedule. + +To ensure that each change is relevant and properly peer reviewed, please adhere to best practices for open-source contributions. +This means that if you are outside the Keploy organization, you must fork the repository and create PRs from branches on your own fork. +The README in GitHub's [first-contributions repo](https://github.com/firstcontributions/first-contributions) provides an example. + +## How to set up the docs website locally? + +The Keploy documentation site uses [Docusaurus 2](https://v2.docusaurus.io/), which is a static website generator. + +You can make changes locally without previewing them in the browser. +However, if you want to build the site and preview changes in the browser, you need to have [Docusaurus 2 dependencies](https://v2.docusaurus.io/docs/installation/#requirements) installed. + +Initialize Docusaurus 2 in the repo by running [`yarn`](https://classic.yarnpkg.com/en/docs/cli/) once in the root directory of the repo. + +Now you can build and view the site locally: + +```bash +yarn start +``` + +The command starts a local development server and opens a browser window. + +## Prettier + +1. Fork the repository + +2. Clone the repository with the following command. Replace the with your username + +```sh +git clone https://github.com//docs.git +``` + +3. Go into the directory containing the project + +```sh +cd docs +``` + +4. Install all the dependencies + +```sh +yarn +``` + +5. Start the development server. + +```sh +yarn start +``` + +6. To reformat: + +``` +yarn prettier --write '**/*.{js,md}' +``` + +When we merge your PR, a new build automatically occurs and your changes publish to [https://docs.keploy.io](https://docs.keploy.io). + +## How to Contribute Code? + +Bug fixes, performance improvements, code formatting, ... +There are a lot ways in which you can contribute code! +The issues list of a project is a great place to find something that you can help us with. + +To increase the chances of your code getting merged, please ensure that: + +- You satisfy our contribution criteria +- Your pull request: + - Passes all checks and has no conflicts. + - Has a well-written title and message that briefly explains your proposed changes. + +## How to Report Bugs, Provide Feedback or Request Features? + +We welcome all kinds of bug reports, user feedback and feature requests! We've created some issue templates to assist you in this. Please use them to create a new issue in the relevant project's repository. If you are not sure how to create an issue, here are the steps: + +1. Navigate to the main page of the documentation website repository + +2. Click `Issues` + +3. Click `New issue` + +4. Our repository uses issue templates, click `Get started` next to the type of issue you'd like to open + +5. Type a title for your issue. We advise you to stick to the issue template to describe the issue + +6. After you are finished, click `Submit new issue` + +## How to Open a Pull Request to Add New Documentation or Fix Bugs? + +After you have cloned the documentation repo to your computer locally, edit the files that you wish to change and follow the steps to open a pull request. + +1. `add` and `commit` your changes to your repository + +2. Git push your changes to your fork on Github + +3. On Github, click on the `Create a new Pull Request` button. + +4. Use a succinct title and descriptive comments to describe your Pull Request. Also Ensure maintainers can understand your proposed changes from the description + +## How to Suggest UI/UX Improvements? + +One of the most important areas of improvement to our software Keploy UI. We really need your help with this! + +If you have ideas on how we can improve, please share them with us by creating a [new issue](https://github.com/keploy/keploy/issues/new/choose). + +## How to Contribute Translations? + +Right now our interfaces do not support translations and we also don't have a translation strategy in place. But we want to change this. We want our projects to be accessible to non-English speakers. If you have any ideas then please share them with us by creating a [new issue]. diff --git a/versioned_sidebars/version-2.0.0-sidebars.json b/versioned_sidebars/version-2.0.0-sidebars.json index 56e5be3a3..5e9e48208 100644 --- a/versioned_sidebars/version-2.0.0-sidebars.json +++ b/versioned_sidebars/version-2.0.0-sidebars.json @@ -68,7 +68,8 @@ "label": "Dev Guide", "collapsible": false, "items": [ - "keploy-explained/contribution-guide" + "keploy-explained/contribution-guide", + "keploy-explained/docs-dev-guide" ] }, {