编写Redmine插件的好文档 | 那些遇到过的问题

我知道这对于原始问题海报来说可能太迟了,但可能会帮助处于类似情况的其他人.下面的链接是针对RubyOnRails的新手(像我一样),但是之前编程过的人.您可以根据自己的技能水平挑选相关的选项.

了解Redmine(功能):
如果您不熟悉Redmine或管理其他问题跟踪软件掌握Redmine一书是一个好的起点.它的密集程度不是很高,所以它只能作为一个结构化的信息组织.如果您想要更密集的信息,请通过文档来代替.

了解Redmine插件:
Alex Bevilacqua的"Redmine插件扩展和开发"刚刚发布(2014年3月).它可以从packtpub以打印和电子书格式提供.

我自己经历这本书,因为我需要为Redmine定制/重写一个插件.我自己是Rails/Ruby/Redmine的新手.虽然我来自Unix/C++背景,但仍然通过以下书籍了解Ruby,Rails,Redmine的知识.

理解Rails:
我发现使用Rails的Agile Web Development这本书可以为其他语言的程序员提供足够好的Rails介绍.
注意:目标受众似乎是Rails开发人员,但应该可以通过浏览github redmine插件存储库来了解该学习曲线.

理解Ruby:
编程Ruby(PickAxe书)

理解Ruby Metaprogramming习惯用法(在Rails中使用):
从表面上看,Ruby看起来像大多数脚本语言,它使用MetaProgramming和Ruby对象模型的动态特性,允许复杂的内部体操对新手不可见.

一行Rails代码包含足够的这些技巧来填充一本小书.
幸运的是,这本书已经写成了 - 实用程序员系列中的Ruby MetaProgramming书.掌握这款基于Mixin的Dynamic MetaProgramming非常棒.Rails和Redmine使用大量这些技巧作为钩子等来完成工作.

更好的文档是codesource.一个Redmine的主要人员在github上拥有几乎所有Redmine的插件.

你可以选择任何插件,看看是什么样的.主要是关于元编程和alias_method_in_chain的使用

有一个有效的钩子列表.但找到它们的最佳方法是只需查看代码,找到您想要扩展的位置并搜索附近钩子的调用.

看起来浏览核心类以及查看其他插件是可行的方法.

我假设您已经在wiki上找到了与插件相关的所有文档:

至于论坛的反应性,你可以尝试在chiliproject论坛上提问,这是最近的redmine分支.虽然有多少已经改变,但不确定.

Redmine和ChiliProject 1.x非常接近,我们尽可能地保持兼容性.ChiliProject 2.x有一些重大变化,尤其是期刊(发行说明).旧代码仍然可以工作,但需要进行测试和移植.我的大约50%的插件没有任何变化,40%使用Gemfile进行捆绑,其余的需要一些更新. (2认同)