search

pinzolo / redmine_persist_wfmt

redmine_persist_wfmt is a plugin for Redmine that persists wiki format.
MIT License
29 stars 13 forks source link
rails redmine redmine-plugin ruby wiki

readme

redmine_persist_wfmt

Build Status

redmine_persist_wfmt is a plugin for Redmine that enables to select and save wiki format of various documents. (issue, document, wiki ...)

Feature senario

  1. Write document as Textile
  2. Change wiki formatting setting to Markdown
  3. Write document as Markdown
  4. Users can view new documents as translated into Markdown
  5. Users also can view old documents as translated into Textile

Installation

Execute follow commands at your Redmine directory.

  1. Clone to your Redmine's plugins directory

    $ git clone https://github.com/pinzolo/redmine_persist_wfmt.git plugins/redmine_persist_wfmt

  2. Install dependency gems

    If you are already using Redmine, you probably only call bundle.

    $ bundle install --without test development

  3. Execute migration

    $ bundle exec rake redmine:plugins:migrate NAME=redmine_persist_wfmt RAILS_ENV=production

  4. Execute persist_all task

    This task saves all wiki formats that already exist.

    # FORMAT is required and must be 'textile' or 'markdown'
$ bundle exec rake pwfmt:persist_all FORMAT=textile RAILS_ENV=production

  5. Restart your Redmine

Try this

This plugin contains docker-compose.yml, so you can try this by docker-compose up.

Supported versions

If you want to use this plugin with Redmine2 or 3, use ver1 branch.

Contributing

To check tests and rubocop, you need to merge Gemfile.local in this plugin to Gemfile.local of your Redmine.

  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. Check pass all tests (RAILS_ENV=test bundle exec rake redmine:plugins:test:ui)
  5. Check pass rubocop (bundle exec rubocop plugins/redmine_persist_wfmt)
  6. Push to the branch (git push origin my-new-feature)
  7. Create new Pull Request

Changelog