PluginEzfaq » History » Version 2
Chaoqun Zou, 2008-08-11 16:21
| 1 | 2 | Chaoqun Zou | h1. ezFAQ Plugin (current version 0.0.1) |
|---|---|---|---|
| 2 | |||
| 3 | A FAQ management plugin to collect the frequently asked questions. |
||
| 4 | Using ezFAQ, you can add a question, assign someone to answer it, or modify the answer, ezFAQ will record each modifications. |
||
| 5 | Further more, ezFAQ can send notify email to the assigned user(version 0.0.2), and generate a pdf document of all the valid FAQs(version 0.0.3). |
||
| 6 | |||
| 7 | It can be downloaded from github: |
||
| 8 | http://github.com/zouchaoqun/ezfaq/tree/master |
||
| 9 | |||
| 10 | Screenshot: |
||
| 11 | |||
| 12 | !ezfaq_tn.png!:/attachments/download/3 |
||
| 13 | |||
| 14 | h2. To install from git: |
||
| 15 | |||
| 16 | (Git Version < 1.5.3) |
||
| 17 | <pre> |
||
| 18 | cd {RAILS_ROOT}/vendor/plugins |
||
| 19 | git clone git://github.com/zouchaoqun/ezfaq.git |
||
| 20 | </pre> |
||
| 21 | |||
| 22 | (Git Version >= 1.5.3 -- Because the "git-rails" gem uses Git Submodules introduced in ver. 1.5.3) |
||
| 23 | <pre> |
||
| 24 | gem install git-rails git-rails |
||
| 25 | git-rails install git://github.com/zouchaoqun/ezfaq.git |
||
| 26 | </pre> |
||
| 27 | |||
| 28 | h2. Plugin setup |
||
| 29 | |||
| 30 | 1. Install will_paginate gem |
||
| 31 | gem install will_paginate |
||
| 32 | |||
| 33 | 2. Add will_paginate to the last of enviroment.rb |
||
| 34 | require 'will_paginate' |
||
| 35 | |||
| 36 | 3. Copy the plugin directory(ezfaq_plugin) into the vendor/plugins directory |
||
| 37 | |||
| 38 | 4. Migrate plugin: |
||
| 39 | rake db:migrate_plugins |
||
| 40 | |||
| 41 | 5. Start Redmine |
||
| 42 | |||
| 43 | 6. In your project in Redmine, go to "Project settings" : |
||
| 44 | |||
| 45 | On the "Modules" tab, enable the module by checking "Ezfaq". |
||
| 46 | |||
| 47 | h2. Using ezFAQ |
||
| 48 | |||
| 49 | 1. Registered users can add new faqs by click the 'New FAQ' link. |
||
| 50 | 2. Privileged users can modify faqs, modify faq categories by click the appropriate link. |
||
| 51 | 3. Privileged users can modify the FAQ list's note which will be export to the pdf document. |
||
| 52 | 4. When a faq is created and assigned to someone, the assigned user will receive a notify email to complete the answer. |