Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 1.71 KB

README.md

File metadata and controls

35 lines (25 loc) · 1.71 KB
Raw

Kili Help Documentation

INTRO

This repository contains the sources used to build Kili's help documentation.
We use pelican to build the contents of this repository into the site you see at help.kili.io

PREREQUIESITES

To contribute, we recommend you install:-

INSTALLATION

  1. Click here to fork this Repo.
  2. Clone your fork and cd into it.
  3. Create a virtualenv for your repo:- mkvirtualenv -a . help.kili.io.
  4. Install the remaining dependencies:- pip install -r requirements.txt.
  5. Initialize & update the submodule with our pelican theme: git submodule init && git submodule update.

CONTRIBUTE

  1. Start the development server:- ./develop_server.sh start.
  2. Add or edit markdown articles in the content folder.
  3. Add, commit and push your changes.
  4. Send us a pull request.
  5. We'll work with you to make it better. The most important thing is the article, don't worry if you can't get Pelican to work - just submit the pull request with the article in Markdown format and we an go from there.
  6. Profit!!!! .....(We will pay you 50 USD for each UNIQUE, HIGH QUALITY article.)

We look forward to including your content.

Cheers and enjoy contributing!