Documentation

About

This documentation is hosted for editing on Github wiki and parsed into HTML for the gh-pages. These pages are parsed in the order of how they appear and will be displayed on the website in the same order. The Home Page is an exception to this rule however, it always appears first in the generated documentation. This is so because of the globbling pattern used in the gruntfile:

var markdown = [
      'jenkins-docker-vagrant-ansible.wiki/Home.md',
      'jenkins-docker-vagrant-ansible.wiki/*.md',
      '!jenkins-docker-vagrant-ansible.wiki/_Footer.md'
    ];

This pattern includes the Home page first, includes all other files and then ignores the Footer page used in the wiki.

Editing the Docs

You can edit the documentation by visiting the Github wiki of this repository. The wiki is parsed and used to generate the documentation for the website.

Generate Documentation Website

To get started with generating the documentation, you must have already cloned the git repository and be inside the root directory with your console.

The tools needed to get you started are all powered by:

• Nodejs
• npm
• Grunt

Therefore, you must have Nodejs and npm installed with grunt installed globally as a npm package

Assuming all the dependencies above are installed and ready to use, the following steps will show you how to generate documentation for the repository.

Step 1

run

$ npm install

This will install all npm modules/dependencies needed within the project to generate the documentation.

Step 2

run

$ grunt docs

This will then generate the documentation locally to the docs folder.

Deploy Docs to GH-Pages

When the documentation is generated and parsed properly then you can deploy to the website

NB. Please review generated docs locally before deploying

You can deploy by running:

$ grunt deploy