Create A Check

Abstract

A guide on how to create a new check.

Dependencies

• Docker

• Marvin

Getting Started

Note

The following guide expects that you are already a member of the testthedocs GitHub organization.

If you are not a member (yet), please reach out to us !

One other possibility is to fork the repository and create a PR (Pull Request) from your fork.

First, clone the Rakpart repository, for example:

git clone https://github.com/testthedocs/rakpart.git

Second, change into the cloned repository:

cd rakpart

In the next step, we will create a new branch:

git checkout -b $MY-NEW-CHECK

In the last step, we run marvin, this will create the base setup of a new check, to help you to get started.

docker run -it -v `pwd`:/srv/data testthedocs/marvin rakpart-check