nanego / redmine_introductions

A redmine plugin to introduce features and create step-by-step users guide.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Redmine Introductions plugin

This redmine plugin add the ability to display introductions for features and to create step-by-step users guide.

It is based on the Intro.js project (http://usablica.github.io/intro.js/).

Example

redmine_introductions screenshot

redmine_introductions configuration_example

Installation

This plugin is compatible with Redmine 2.1.0+.

Please apply general instructions for plugins here.

First download the source or clone the plugin and put it in the "plugins/" directory of your redmine instance. Note that this is crucial that the directory is named 'redmine_introductions'!

Then execute:

$ bundle install
$ rake redmine:plugins

And finally restart your Redmine instance.

Test status

Plugin branch Redmine Version Test Status
master 4.2.11 4.2.11
master 5.1.2 5.1.2
master master master

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

About

A redmine plugin to introduce features and create step-by-step users guide.


Languages

Language:JavaScript 76.9%Language:Ruby 9.2%Language:CSS 7.7%Language:HTML 6.2%