CONTRIBUTING.adoc

Contributing Guide

The sources of this tutorial docs is in documentation folder. The site generation is done by Antora

Running site in development mode

To run the site in development mode you need to have yarn or npm installed with NodeJS v12.x or above.

Clone this repository

git clone https://github.com/redhat-scholars/openshift-starter-guides.git

Run yarn install or npm install from the openshift-starter-guides repository to install needed nodejs packages.

npm install

Start the development site using yarn run dev or npm run dev or gulp command, this should open a local development site at http://localhost:3000 in your default browser:

gulp

Making any changes to your local repositories above cloned earlier, will be automatically built and the development site gets reloaded automatically.

Send your contribution

Now you are all set:

• Open an Issue in http://github.com/redhat-scholars/openshift-starter-guides.git

• Prepare your changes in the respective documentation repository

• Send the PR to respective repositories listed above