jeromtom/docs

Documentation website for Keploy

Keploy

Docs Website

Repository for the Keploy docs website.

Keploy is a no-code testing platform that generates tests from API calls.

Keploy is constantly working to improve and expand its documentation. Some components may change without notice. Page slugs (URLs), menu labels, and the location of information are a few of the items you can expect to see altered as we endeavour to give you the best experience possible.

The documentation in this repository is published to https://docs.keploy.io.

If information you are looking for seems to be missing, visit the Keploy community forum for help.

Please read the CONTRIBUTING guide and the STYLE guide before you submit any pull requests.

Maintainers and contributors to this project are expected to conduct themselves in a respectful way. See the CNCF Community Code of Conduct as a reference.

Technology Stack

We use a variety of technologies to build the web interface and support the community. They include:

• NodeJS
• Yarn package manager
• Docusaurus
• React
• GitHub Actions

We use NodeJS and Yarn to install, test, and build the website. Docusaurus has been used as a static site generator to build the website. React is being utilized to build our custom component-based user interface to provide a modern look to the website. GitHub Actions manages our CI/CD pipelines and issue triage.

Installation

The Keploy documentation site uses Docusaurus 2, 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 installed.

Initialize Docusaurus 2 in the repo by running yarn once in the root directory of the repo.

Now you can build and view the site locally:

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 <GITHUB_USERNAME> with your username

git clone https://github.com/<GITHUB_USERNAME>/docs.git

3. Go into the directory containing the project

cd docs

4. Install all the dependencies

yarn

5. Start the development server.

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.

How to Get Involved?

Keploy welcomes contributions to the docs website. If you have an idea for a new feature or a bug fix, please submit an issue or pull request. Our planned features can be found on our Issue Tracker.

Community support

We'd love to collaborate with you to make Keploy great. To get started:

• Slack - Discussions with the community and the team.
• GitHub - For bug reports and feature requests.